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

πŸ“¦
version 1.28 Β· 7 versions
, in debian trixie, ubuntu resolute, ubuntu stonking

πŸ’– VM::EC2::VPC::CustomerGateway β€” the vibe

okay bestie, welcome to the manual page for VM::EC2::VPC::CustomerGateway(3pm) πŸŽ€ this is the lil Perl module that holds all the tea about an Amazon EC2 Virtual Private Cloud customer gateway. yes it's a lot of words. no it's not scary. let's go πŸ’…


✨ NAME ✨

VM::EC2::VPC::CustomerGateway β€” an object that describes an Amazon EC2 Virtual Private Cloud customer gateway. that's it, that's the whole job, and it does it beautifully πŸ¦‹


🌸 SYNOPSIS 🌸

the way you literally just do this:

use VM::EC2;

my $ec2      = VM::EC2->new(...);
my $gtwy     = $ec2->describe_customer_gateways(-customer_gatway_id=>'cgw-12345678');
print $gtwy->ipAddress,"\n",
      $gtwy->state,"\n";

no cap, that's the whole entrance. (and yes, -customer_gatway_id is spelled exactly like that in the source β€” do not "fix" it, i'm begging πŸ™ˆ copy it character for character, iykyk.)


πŸ’œ DESCRIPTION πŸ’œ

so this object represents an Amazon EC2 VPC route, and you get one handed to you by VM::EC2->describe_customer_gateways() and ->create_customer_gateway(). it's giving "here's your gateway, bestie, go be a main character with it" πŸ‘‘


πŸŽ€ METHODS πŸŽ€

these object methods are supported β€” every single one, no skipping, periodt:

  • customerGatewayId β€” the ID of the customer gateway. it's the name tag of the whole situation πŸ’–
  • state β€” the current state of the customer gateway. valid values are: pending | available | deleting | deleted. it's a whole journey, honestly 🌈
  • type β€” the type of VPN connection the customer gateway supports (ipsec.1).
  • ipAddress β€” the Internet-routable IP address of the customer gateway's outside interface. the outside-interface one, specifically, don't get it twisted ✨
  • bgpAsn β€” the customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN). say that five times fast, fr fr πŸ’€
  • tagSet β€” tags assigned to the resource. cute little labels for your stuff 🏷️

also, the object supports the tags() method described in VM::EC2::Generic β€” so you get that one on the house 🫢


πŸ¦‹ STRING OVERLOADING πŸ¦‹

when you use this object in a string context, it will interpolate the customerGatewayId. so it just knows how to introduce itself. iconic behaviour honestly πŸ’…


πŸ‘‘ SEE ALSO πŸ‘‘

go read these too, bestie, they're all in the same friend group:

  • VM::EC2
  • VM::EC2::Generic
  • VM::EC2::Tag
  • VM::EC2::VPC

🌟 AUTHOR 🌟

Lance Kinley <lkinley@loyaltymethods.com> β€” thank you for your service 🫑

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.

okay so real talk: that license bit matters, don't skim it. LICENSE and DISCLAIMER.txt are both there for a reason πŸ’œ

and that's the whole page, bestie πŸŽ€ this was perl v5.38.2, dated 2024-08-10, and you absolutely ate by reading to the end. slay, go describe some customer gateways πŸ’–βœ¨πŸ¦‹

πŸ“¦ where this page comes from