.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "VM::EC2::REST::subnet 3pm" .TH VM::EC2::REST::subnet 3pm "2016-06-04" "perl v5.22.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME VM::EC2::REST::subnet \- anage subnet objects and the routing among them" .IX Header "NAME VM::EC2::REST::subnet - anage subnet objects and the routing among them" .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use VM::EC2 \*(Aq:vpc\*(Aq; .Ve .SH "METHODS" .IX Header "METHODS" These methods manage subnet objects and the routing among them. A \s-1VPC\s0 may have a single subnet or many, and routing rules determine whether the subnet has access to the internet (\*(L"public\*(R"), is entirely private, or is connected to a customer gateway device to form a Virtual Private Network (\s-1VPN\s0) in which your home network's address space is extended into the Amazon \s-1VPC. \s0 .PP All instances in a \s-1VPC\s0 are located in one subnet or another. Subnets may be public or private, and are organized in a star topology with a logical router in the middle. .PP Although all these methods can be called from \s-1VM::EC2\s0 objects, many are more conveniently called from the \s-1VM::EC2::VPC\s0 object family. This allows for steps that typically follow each other, such as creating a route table and associating it with a subnet, happen automatically. For example, this series of calls creates a \s-1VPC\s0 with a single subnet, creates an Internet gateway attached to the \s-1VPC,\s0 associates a new route table with the subnet and then creates a default route from the subnet to the Internet gateway. .PP .Vb 5 \& $vpc = $ec2\->create_vpc(\*(Aq10.0.0.0/16\*(Aq) or die $ec2\->error_str; \& $subnet1 = $vpc\->create_subnet(\*(Aq10.0.0.0/24\*(Aq) or die $vpc\->error_str; \& $gateway = $vpc\->create_internet_gateway or die $vpc\->error_str; \& $routeTbl = $subnet\->create_route_table or die $vpc\->error_str; \& $routeTbl\->create_route(\*(Aq0.0.0.0/0\*(Aq => $gateway) or die $vpc\->error_str; .Ve .PP Implemented: CreateSubnet DeleteSubnet DescribeSubnets .PP Unimplemented: (none) .ie n .SS "$subnet = $ec2\->create_subnet(\-vpc_id=>$id,\-cidr_block=>$block)" .el .SS "\f(CW$subnet\fP = \f(CW$ec2\fP\->create_subnet(\-vpc_id=>$id,\-cidr_block=>$block)" .IX Subsection "$subnet = $ec2->create_subnet(-vpc_id=>$id,-cidr_block=>$block)" This method creates a new subnet within the given \s-1VPC.\s0 Pass a \s-1VPC\s0 object or \s-1VPC ID,\s0 and a \s-1CIDR\s0 block string. If successful, the method will return a VM::EC2::VPC::Subnet object. .PP Required arguments: .PP .Vb 1 \& \-vpc_id A VPC ID or previously\-created VM::EC2::VPC object. \& \& \-cidr_block A CIDR block string in the form "xx.xx.xx.xx/xx". The \& CIDR address must be within the CIDR block previously \& assigned to the VPC, and must not overlap other subnets \& in the VPC. .Ve .PP Optional arguments: .PP .Vb 5 \& \-availability_zone The availability zone for the instances launched \& within this instance, either an availability zone \& name, or a VM::EC2::AvailabilityZone object. If \& this is not specified, then AWS chooses a zone for \& you automatically. .Ve .ie n .SS "$success = $ec2\->delete_subnet($subnet_id)" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->delete_subnet($subnet_id)" .IX Subsection "$success = $ec2->delete_subnet($subnet_id)" .ie n .SS "$success = $ec2\->delete_subnet(\-subnet_id=>$id)" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->delete_subnet(\-subnet_id=>$id)" .IX Subsection "$success = $ec2->delete_subnet(-subnet_id=>$id)" This method deletes the indicated subnet. It may be called with a single argument consisting of the subnet \s-1ID,\s0 or a named argument form with the argument \-subnet_id. .ie n .SS "@subnets = $ec2\->describe_subnets(@subnet_ids)" .el .SS "\f(CW@subnets\fP = \f(CW$ec2\fP\->describe_subnets(@subnet_ids)" .IX Subsection "@subnets = $ec2->describe_subnets(@subnet_ids)" .ie n .SS "@subnets = $ec2\->describe_subnets(\e%filters)" .el .SS "\f(CW@subnets\fP = \f(CW$ec2\fP\->describe_subnets(\e%filters)" .IX Subsection "@subnets = $ec2->describe_subnets(%filters)" .ie n .SS "@subnets = $ec2\->describe_subnets(\-subnet_id=>$id, \-filter => \e%filters)" .el .SS "\f(CW@subnets\fP = \f(CW$ec2\fP\->describe_subnets(\-subnet_id=>$id, \-filter => \e%filters)" .IX Subsection "@subnets = $ec2->describe_subnets(-subnet_id=>$id, -filter => %filters)" This method returns a list of VM::EC2::VPC::Subnet objects. Called with no arguments, it returns all Subnets (not filtered by \s-1VPC\s0 Id). Pass a list of subnet IDs or a filter hashref in order to restrict the search. .PP Optional arguments: .PP .Vb 2 \& \-subnet_id Scalar or arrayref of subnet IDs. \& \-filter Hashref of filters. .Ve .PP Available filters are described at http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference\-query\-DescribeSubnets.html .ie n .SS "$success = $ec2\->modify_subnet_attribute(\-subnet_id => $sub_id, \-map_public_ip_on_launch => $boolean)" .el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->modify_subnet_attribute(\-subnet_id => \f(CW$sub_id\fP, \-map_public_ip_on_launch => \f(CW$boolean\fP)" .IX Subsection "$success = $ec2->modify_subnet_attribute(-subnet_id => $sub_id, -map_public_ip_on_launch => $boolean)" Modifies a subnet attribute. .PP Required arguments: .PP .Vb 1 \& \-subnet_id The ID of the subnet to modify. \& \& \-map_public_ip_on_launch Modifies the public IP addressing behavior for the \& subnet. Specify true to indicate that instances \& launched into the specified subnet should be \& assigned a public IP address. If set to true, the \& instance receives a public IP address only if the \& instance is launched with a single, new network \& interface with the device index of 0. .Ve .PP Returns true on success. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\s-1VM::EC2\s0 .SH "AUTHOR" .IX Header "AUTHOR" Lincoln Stein . .PP Copyright (c) 2011 Ontario Institute for Cancer Research .PP This package and its accompanying libraries is free software; you can redistribute it and/or modify it under the terms of the \s-1GPL \s0(either version 1, or at your option, any later version) or the Artistic License 2.0. Refer to \s-1LICENSE\s0 for the full license text. In addition, please see \s-1DISCLAIMER\s0.txt for disclaimers of warranty.