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

💖 VM::EC2::VPC::VpnGateway — the perl manual page, but make it cute 💖

okay so bestie, this is a page from the User Contributed Perl Documentation, and it's all about VM::EC2::VPC::VpnGateway — Virtual Private Cloud VPN gateway. yes it's a mouthful, no we're not renaming it, sit with me. 💅

---

✨ NAME ✨

VM::EC2::VPC::VpnGateway — Virtual Private Cloud VPN gateway. that's the whole vibe. 🦋

---

🌸 SYNOPSIS 🌸

here's the little summoning ritual, copy it exactly:

use VM::EC2;

my $ec2   = VM::EC2->new(...);
my $gtwy  = $ec2->describe_vpn_gateways(-vpn_gatway_id=>'vgw-12345678');
my $state = $gtwy->state;

not me noticing -vpn_gatway_id is spelled that way in here 👀 — keep it exactly like that, do NOT "fix" it, that's the whole point. 🙈

---

💫 DESCRIPTION 💫

this object represents an Amazon EC2 VPC route (yes, route, that's literally what it says, I don't make the rules 🫶), and it gets handed back to you by VM::EC2->describe_internet_gateways() and ->create_internet_gateway().

it's giving "I'm a little data blob holding your VPN gateway info and I'm thriving." 👑

---

🎀 METHODS 🎀

these object methods are supported, and every single one of them is here, no cap:

• vpnGatewayId — The ID of the VPN gateway.
• state — The current state of the virtual private gateway. Valid values: pending | available | deleting | deleted
• type — The type of VPN connection the virtual private gateway supports (ipsec.1)
• availabilityZone — The Availability Zone where the virtual private gateway was created, as a VM::EC2::AvailabilityZone object.
• attachments — A list of VPCs attached to the VPN gateway.
• tagSet — Tags assigned to the resource.
• zone — Alias for availabilityZone.

🌈 the convenience methods 🌈

because bestie deserves a shortcut:

• attachments — Returns a series of VM::EC2::VPC::VpnGateway::Attachment objects.

💡 heads up: attachments shows up in both lists. that's not me being chaotic, that's literally the page. iconic behavior honestly.

the object also supports the tags() method described in VM::EC2::Generic. slay. ✨

---

🦋 STRING OVERLOADING 🦋

when you use this object in a string context, it will interpolate the vpnGatewayId. so it just becomes its ID when you stringify it. main character energy fr fr. 💜

---

⭐ SEE ALSO ⭐

go read these next, iykyk:

• VM::EC2
• VM::EC2::Generic
• VM::EC2::Tag
• VM::EC2::VPC
• VM::EC2::VPC::VpnGateway::Attachment

---

👑 AUTHOR 👑

Lance Kinley <lkinley@loyaltymethods.com>.

Copyright (c) 2012 Loyalty Methods, Inc.

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.

🫶 so basically: free to use, share, remix — just read LICENSE and DISCLAIMER.txt like a good citizen. no cap.

---

and that's the whole page, bestie!! this was documented with perl v5.38.2 and dated 2024-08-10, so if you're reading this, say thank you to the 2024-08-10 version of the docs. 💖✨🎀 bye now, go describe some gateways. 🌸🦋