VM::EC...ateway(3pm)

💖 VM::EC2::REST::vpn_gateway — the manual page 💖

okay bestie, welcome to the VPN Gateway corner of VM::EC2::REST, part of the User Contributed Perl Documentation collection. this is VM::EC...ateway(3pm) and she's here to help you create and manage Virtual Private Network Gateways. grab a strawberry 🍓 and let's go.

---

✨ NAME ✨

VM::EC2::REST::vpn_gateway — Create and manage Virtual Private Network Gateways 💅

---

🌸 SYNOPSIS 🌸

use VM::EC2 ':vpc';

like that's it, that's the whole vibe. :vpc and you're in. 🦋

---

👑 METHODS 👑

These methods create and manage Virtual Private Network Gateways (VGW). they're the little glue between your VPC and, like, the rest of the world. no cap.

Implemented:

• AttachVpnGateway
• CreateVpnGateway
• DeleteVpnGateway
• DescribeVpnGateways
• DisableVgwRoutePropagation
• EnableVgwRoutePropagation

Unimplemented:

• (none)

literally zero gaps, we ate and left no crumbs. 🔥

---

🫶 @gtwys = $ec2->describe_vpn_gateways(-vpn_gateway_id=>\@ids, -filter =>\%filters)

🫶 @gtwys = $ec2->describe_vpn_gateways(@vpn_gateway_ids)

🫶 @gtwys = $ec2->describe_vpn_gateways(%filters)

Provides information on VPN gateways. spilling the tea on your gateways, basically.

Returns a series of VM::EC2::VPC::VpnGateway objects. When you call it with no arguments, it returns all VPN gateways — the whole friend group. Pass a list of VPN gateway IDs, or use the assorted filters, to restrict the search. narrow it down, bestie.

Optional parameters are:

• -vpn_gateway_id — ID of the gateway(s) to return information on. This can be a string scalar, or an arrayref.
• -filter — Tags and other filters to apply.

The -filter argument is a hashreference where the keys are the filter names and the values are the match strings. Some filters accept wildcards. ✨ (wildcards are so iconic of them.)

There are a number of filters, listed in full at: http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeVpnGateways.html

Here is an alpha-sorted list of filter names: attachment.state, attachment.vpc-id, availability-zone, state, tag-key, tag-value, tag:key, type, vpn-gateway-id

---

🦋 $vpn_gateway = $ec2->create_vpn_gateway(-type=>$type)

🦋 $vpn_gateway = $ec2->create_vpn_gateway($type)

🦋 $vpn_gateway = $ec2->create_vpn_gateway

Creates a new virtual private gateway. A virtual private gateway is the VPC-side endpoint for a VPN connection. You can create a virtual private gateway before creating the VPC itself — manifesting ahead of time, main character energy fr.

The -type switch is optional, because there's only one type as of API 2012-06-15. (only one flavor, and she's serving.) 🎀

Returns a VM::EC2::VPC::VpnGateway object on success. 💖

---

💀 $success = $ec2->delete_vpn_gateway(-vpn_gateway_id=>$id);

💀 $success = $ec2->delete_vpn_gateway($id);

Deletes a virtual private gateway. Use this when a VPC and all its associated components are no longer needed. it's the "we're done here" moment.

It is recommended that before deleting a virtual private gateway, you detach it from the VPC and delete the VPN connection. Also note: it is not necessary to delete the virtual private gateway if the VPN connection between the VPC and data center needs to be recreated. so like, don't be dramatic and delete her for no reason. 🙈

Arguments:

• -vpn_gateway_id — The ID of the VPN gateway to delete.

Returns true on successful deletion. slay.

---

🌈 $state = $ec2->attach_vpn_gateway(-vpn_gateway_id=>$vpn_gtwy_id, -vpc_id =>$vpc_id)

Attaches a virtual private gateway to a VPC. it's giving "you two belong together." 🫶

Arguments:

• -vpc_id — The ID of the VPC to attach the VPN gateway to
• -vpn_gateway_id — The ID of the VPN gateway to attach

Returns the state of the attachment, one of:

attaching | attached | detaching | detached

---

🧚 $success = $ec2->detach_vpn_gateway(-vpn_gateway_id=>$vpn_gtwy_id, -vpc_id =>$vpc_id)

Detaches a virtual private gateway from a VPC. You do this if you're planning to turn off the VPC and not use it anymore. You can confirm a virtual private gateway has been completely detached from a VPC by describing the virtual private gateway — and any attachments to the virtual private gateway are also described. receipts included. 📋

You must wait for the attachment's state to switch to detached before you can delete the VPC or attach a different VPC to the virtual private gateway. do not skip this step, bestie, I'm begging. 😭

Arguments:

• -vpc_id — The ID of the VPC to detach the VPN gateway from
• -vpn_gateway_id — The ID of the VPN gateway to detach

Returns true on successful detachment.

---

⭐ $success = $ec2->enable_vgw_route_propagation(-route_table_id=>$rt_id, -gateway_id =>$gtwy_id)

Enables a virtual private gateway (VGW) to propagate routes to the routing tables of an Amazon VPC. turning the route gossip ON. 🗣️

Arguments:

• -route_table_id — The ID of the routing table.
• -gateway_id — The ID of the virtual private gateway.

Returns true on successful enablement.

---

🎀 $success = $ec2->disable_vgw_route_propagation(-route_table_id=>$rt_id, -gateway_id =>$gtwy_id)

Disables a virtual private gateway (VGW) from propagating routes to the routing tables of an Amazon VPC. and now the route gossip is OFF. 🤫

Arguments:

• -route_table_id — The ID of the routing table.
• -gateway_id — The ID of the virtual private gateway.

Returns true on successful disablement.

---

🌟 SEE ALSO 🌟

• VM::EC2

---

💜 AUTHOR 💜

Lance Kinley <lkinley@loyaltymethods.com>. Lincoln Stein <lincoln.stein@gmail.com>.

Copyright (c) 2012 Loyalty Methods, Inc. Copyright (c) 2012 Ontario Institute for Cancer Research

This package and its accompanying libraries is free software; you can redistribute it and/or modify it under the terms of the GPL (either version 1, or at your option, any later version) or the Artistic License 2.0. Refer to LICENSE for the full license text. In addition, please see DISCLAIMER.txt for disclaimers of warranty.

---

and that's the whole page, bestie. 💅 this doc ships with perl v5.38.2 and it's dated 2024-08-10 — so like, she's been iconic since day one. go forth and gateway responsibly. 🦋✨💖