.\" 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::vpc 3pm"
.TH VM::EC2::REST::vpc 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::vpc \- EC2 virtual private clouds"
.IX Header "NAME VM::EC2::REST::vpc - EC2 virtual private clouds"
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use VM::EC2 \*(Aq:vpc\*(Aq;
.Ve
.SH "METHODS"
.IX Header "METHODS"
\&\s-1EC2\s0 virtual private clouds (VPCs) provide facilities for creating
tiered applications combining public and private subnetworks, and for
extending your home/corporate network into the cloud.
.PP
Implemented:
 AcceptVpcPeeringConnection
 CreateVpc
 CreateVpcPeeringConnection
 DeleteVpc
 DeleteVpcPeeringConnection
 DescribeVpcPeeringConnections
 DescribeVpcs
 DescribeVpcAttribute
 ModifyVpcAttribute
 RejectVpcPeeringConnection
.PP
Unimplemented:
 (none)
.ie n .SS "$vpx = $ec2\->accept_vpc_peering_connection(\-vpc_peering_connection_id => $id)"
.el .SS "\f(CW$vpx\fP = \f(CW$ec2\fP\->accept_vpc_peering_connection(\-vpc_peering_connection_id => \f(CW$id\fP)"
.IX Subsection "$vpx = $ec2->accept_vpc_peering_connection(-vpc_peering_connection_id => $id)"
.ie n .SS "$vpx = $ec2\->accept_vpc_peering_connection($id)"
.el .SS "\f(CW$vpx\fP = \f(CW$ec2\fP\->accept_vpc_peering_connection($id)"
.IX Subsection "$vpx = $ec2->accept_vpc_peering_connection($id)"
Accepts a \s-1VPC\s0 peering connection request. To accept a request, the \s-1VPC\s0 peering
connection must be in the pending-acceptance state, and the request must come from
the owner of the peer \s-1VPC. \s0
Use describe_vpc_peering_connections(\-filter => { 'status\-code' => 'pending\-acceptance' })
to view outstanding \s-1VPC\s0 peering connection requests.
.PP
Required arguments:
.PP
.Vb 1
\& \-vpc_peering_connection_id    \-\- The ID of the VPC peering connection
.Ve
.PP
Returns a VM::EC2::VPC::PeeringConnection object.
.ie n .SS "$vpc = $ec2\->create_vpc(\-cidr_block=>$cidr,\-instance_tenancy=>$tenancy)"
.el .SS "\f(CW$vpc\fP = \f(CW$ec2\fP\->create_vpc(\-cidr_block=>$cidr,\-instance_tenancy=>$tenancy)"
.IX Subsection "$vpc = $ec2->create_vpc(-cidr_block=>$cidr,-instance_tenancy=>$tenancy)"
Create a new \s-1VPC.\s0 This can be called with a single argument, in which
case it is interpreted as the desired \s-1CIDR\s0 block, or
.PP
.Vb 1
\& $vpc = $ec2\->$ec2\->create_vpc(\*(Aq10.0.0.0/16\*(Aq) or die $ec2\->error_str;
.Ve
.PP
Or it can be called with named arguments.
.PP
Required arguments:
.PP
.Vb 3
\& \-cidr_block         The Classless Internet Domain Routing address, in the
\&                     form xx.xx.xx.xx/xx. One or more subnets will be allocated
\&                     from within this block.
.Ve
.PP
Optional arguments:
.PP
.Vb 3
\& \-instance_tenancy   "default" or "dedicated". The latter requests AWS to
\&                     launch all your instances in the VPC on single\-tenant
\&                     hardware (at additional cost).
.Ve
.PP
See
http://docs.amazonwebservices.com/AmazonVPC/latest/UserGuide/VPC_Subnets.html
for a description of the valid CIDRs that can be used with \s-1EC2.\s0
.PP
On success, this method will return a new \s-1VM::EC2::VPC\s0 object. You can
then use this object to create new subnets within the \s-1VPC:\s0
.PP
.Vb 4
\& $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;
\& $subnet2 = $vpc\->create_subnet(\*(Aq10.0.1.0/24\*(Aq) or die $vpc\->error_str;
\& $subnet3 = $vpc\->create_subnet(\*(Aq10.0.2.0/24\*(Aq) or die $vpc\->error_str;
.Ve
.ie n .SS "$pcx = $ec2\->create_vpc_peering_connection(\-vpc_id        => $vpc_id, \-peer_vpc_id   => $peer_id, \-peer_owner_id => $owner_id)"
.el .SS "\f(CW$pcx\fP = \f(CW$ec2\fP\->create_vpc_peering_connection(\-vpc_id        => \f(CW$vpc_id\fP, \-peer_vpc_id   => \f(CW$peer_id\fP, \-peer_owner_id => \f(CW$owner_id\fP)"
.IX Subsection "$pcx = $ec2->create_vpc_peering_connection(-vpc_id => $vpc_id, -peer_vpc_id => $peer_id, -peer_owner_id => $owner_id)"
Requests a \s-1VPC\s0 peering connection between two VPCs: a requester \s-1VPC\s0 and a peer
\&\s-1VPC\s0 with which to create the connection. The peer \s-1VPC\s0 can belong to another \s-1AWS\s0
account. The requester \s-1VPC\s0 and peer \s-1VPC\s0 must not have overlapping \s-1CIDR\s0 blocks.
.PP
The owner of the peer \s-1VPC\s0 must accept the peering request to activate the
peering connection. The \s-1VPC\s0 peering connection request expires after seven days,
after which it cannot be accepted or rejected.
.PP
Required arguments:
.PP
.Vb 1
\& \-vpc_id           The ID of the requester VPC
\&
\& \-peer_vpc_id      The ID of the VPC with which the peering connection is to be
\&                   made
.Ve
.PP
Conditional arguments:
.PP
.Vb 3
\& \-peer_owner_id    The AWS account ID of the owner of the peer VPC
\&                   Required if the peer VPC is not in the same account as the
\&                   requester VPC
.Ve
.PP
Returns a VM::EC2::VPC::PeeringConnection object.
.ie n .SS "@vpc = $ec2\->describe_vpcs(@vpc_ids)"
.el .SS "\f(CW@vpc\fP = \f(CW$ec2\fP\->describe_vpcs(@vpc_ids)"
.IX Subsection "@vpc = $ec2->describe_vpcs(@vpc_ids)"
.ie n .SS "@vpc = $ec2\->describe_vpcs(\e%filter)"
.el .SS "\f(CW@vpc\fP = \f(CW$ec2\fP\->describe_vpcs(\e%filter)"
.IX Subsection "@vpc = $ec2->describe_vpcs(%filter)"
.ie n .SS "@vpc = $ec2\->describe_vpcs(\-vpc_id=>\e@list,\-filter=>\e%filter)"
.el .SS "\f(CW@vpc\fP = \f(CW$ec2\fP\->describe_vpcs(\-vpc_id=>\e@list,\-filter=>\e%filter)"
.IX Subsection "@vpc = $ec2->describe_vpcs(-vpc_id=>@list,-filter=>%filter)"
Describe VPCs that you own and return a list of \s-1VM::EC2::VPC\s0
objects. Call with no arguments to return all VPCs, or provide a list
of \s-1VPC\s0 IDs to return information on those only. You may also provide a
filter list, or named argument forms.
.PP
Optional arguments:
.PP
.Vb 2
\& \-vpc_id      A scalar or array ref containing the VPC IDs you want
\&              information on.
\&
\& \-filter      A hashref of filters to apply to the query.
.Ve
.PP
The filters you can use are described at
http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference\-query\-DescribeVpcs.html
.ie n .SS "@vpx = $ec2\->describe_vpc_peering_connections(@vpx_ids)"
.el .SS "\f(CW@vpx\fP = \f(CW$ec2\fP\->describe_vpc_peering_connections(@vpx_ids)"
.IX Subsection "@vpx = $ec2->describe_vpc_peering_connections(@vpx_ids)"
.ie n .SS "@vpx = $ec2\->describe_vpc_peering_connections(\e%filter)"
.el .SS "\f(CW@vpx\fP = \f(CW$ec2\fP\->describe_vpc_peering_connections(\e%filter)"
.IX Subsection "@vpx = $ec2->describe_vpc_peering_connections(%filter)"
.ie n .SS "@vpx = $ec2\->describe_vpc_peering_connections(vpc_peering_connection_id=>\e@list,\-filter=>\e%filter)"
.el .SS "\f(CW@vpx\fP = \f(CW$ec2\fP\->describe_vpc_peering_connections(vpc_peering_connection_id=>\e@list,\-filter=>\e%filter)"
.IX Subsection "@vpx = $ec2->describe_vpc_peering_connections(vpc_peering_connection_id=>@list,-filter=>%filter)"
Describes one or more of your \s-1VPC\s0 peering connections.
.PP
Optional arguments:
.PP
.Vb 2
\& \-vpc_peering_connection_id    A scalar or array ref containing the VPC IDs you want
\&                               information on.
\&
\& \-filter                       A hashref of filters to apply to the query.
.Ve
.PP
The filters you can use are described at
http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference\-query\-DescribeVpcPeeringConnections.html
.PP
Returns a scalar or array of VM::EC2::VPC::PeeringConnection objects.
.ie n .SS "$success = $ec2\->delete_vpc($vpc_id)"
.el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->delete_vpc($vpc_id)"
.IX Subsection "$success = $ec2->delete_vpc($vpc_id)"
.ie n .SS "$success = $ec2\->delete_vpc(\-vpc_id=>$vpc_id)"
.el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->delete_vpc(\-vpc_id=>$vpc_id)"
.IX Subsection "$success = $ec2->delete_vpc(-vpc_id=>$vpc_id)"
Delete the indicated \s-1VPC,\s0 returning true if successful.
.ie n .SS "$success = $ec2\->delete_vpc_peering_connection(\-vpc_peering_connection_id => $id)"
.el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->delete_vpc_peering_connection(\-vpc_peering_connection_id => \f(CW$id\fP)"
.IX Subsection "$success = $ec2->delete_vpc_peering_connection(-vpc_peering_connection_id => $id)"
.ie n .SS "$success = $ec2\->delete_vpc_peering_connection($id)"
.el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->delete_vpc_peering_connection($id)"
.IX Subsection "$success = $ec2->delete_vpc_peering_connection($id)"
Deletes a \s-1VPC\s0 peering connection. Either the owner of the requester \s-1VPC\s0 or the
owner of the peer \s-1VPC\s0 can delete the \s-1VPC\s0 peering connection if it's in the
\&'active' state. The owner of the requester \s-1VPC\s0 can delete a \s-1VPC\s0 peering
connection in the 'pending\-acceptance' state.
.PP
Required arguments:
.PP
.Vb 1
\& \-vpc_peering_connection_id    The ID of the VPC peering connection to delete
.Ve
.PP
Returns true if the deletion was successful.
.ie n .SS "$attr = $ec2\->describe_vpc_attribute(\-vpc_id => $id, \-attribute => $attr)"
.el .SS "\f(CW$attr\fP = \f(CW$ec2\fP\->describe_vpc_attribute(\-vpc_id => \f(CW$id\fP, \-attribute => \f(CW$attr\fP)"
.IX Subsection "$attr = $ec2->describe_vpc_attribute(-vpc_id => $id, -attribute => $attr)"
Describes an attribute of the specified \s-1VPC.\s0
.PP
Required arguments:
.PP
.Vb 1
\& \-vpc_id                  The ID of the VPC.
\&
\& \-attribute               The VPC attribute.
\&                          Valid values:
\&                          enableDnsSupport | enableDnsHostnames
.Ve
.PP
Returns true if attribute is set.
.ie n .SS "$success = $ec2\->modify_vpc_attribute(\-vpc_id               => $id, \-enable_dns_support   => $boolen, \-enable_dns_hostnames => $boolean)"
.el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->modify_vpc_attribute(\-vpc_id               => \f(CW$id\fP, \-enable_dns_support   => \f(CW$boolen\fP, \-enable_dns_hostnames => \f(CW$boolean\fP)"
.IX Subsection "$success = $ec2->modify_vpc_attribute(-vpc_id => $id, -enable_dns_support => $boolen, -enable_dns_hostnames => $boolean)"
Modify attributes of a \s-1VPC.\s0
.PP
Required Arguments:
.PP
.Vb 1
\& \-vpc_id                  The ID of the VPC.
.Ve
.PP
One or more of the following arguments is required:
.PP
.Vb 2
\& \-enable_dns_support      Specifies whether the DNS server provided
\&                          by Amazon is enabled for the VPC.
\&
\& \-enable_dns_hostnames    Specifies whether DNS hostnames are provided
\&                          for the instances launched in this VPC. You
\&                          can only set this attribute to true if
\&                          \-enable_dns_support is also true.
.Ve
.PP
Returns true on success.
.ie n .SS "$success = $ec2\->reject_vpc_peering_connection(\-vpc_peering_connection_id => $id)"
.el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->reject_vpc_peering_connection(\-vpc_peering_connection_id => \f(CW$id\fP)"
.IX Subsection "$success = $ec2->reject_vpc_peering_connection(-vpc_peering_connection_id => $id)"
Rejects a \s-1VPC\s0 peering connection request. The \s-1VPC\s0 peering connection must be in
the 'pending\-acceptance' state.
Use describe_vpc_peering_connections(\-filter => { 'status\-code' => 'pending\-acceptance' })
to view outstanding \s-1VPC\s0 peering connection requests.
.PP
Required arguments:
.PP
.Vb 1
\& \-vpc_peering_connection_id    The ID of the VPC peering connection to delete
.Ve
.PP
Returns true if the deletion was successful.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1VM::EC2\s0
.SH "AUTHOR"
.IX Header "AUTHOR"
Lincoln Stein <lincoln.stein@gmail.com>.
.PP
Copyright (c) 2011 Ontario Institute for Cancer Research
.PP
Lance Kinley <lkinley@loyaltymethods.com>
.PP
Copyright (c) 2014 Loyalty Methods, Inc.
.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.