.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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::vpn 3pm"
.TH VM::EC2::REST::vpn 3pm "2014-10-24" "perl v5.20.1" "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::vpn \- create and manage the connections of VPN to Amazon VPC"
.IX Header "NAME VM::EC2::REST::vpn - create and manage the connections of VPN to Amazon VPC"
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use VM::EC2 \*(Aq:vpc\*(Aq;
.Ve
.SH "METHODS"
.IX Header "METHODS"
These methods create and manage the connections of Virtual Private
Network (\s-1VPN\s0) to Amazon Virtual Private Clouds (\s-1VPC\s0).
.PP
Implemented:
 CreateVpnConnection
 CreateVpnConnectionRoute
 DeleteVpnConnection
 DeleteVpnConnectionRoute
 DescribeVpnConnections
.PP
Unimplemented:
 (none)
.ie n .SS "@vpn_connections = $ec2\->describe_vpn_connections(\-vpn_connection_id=>\e@ids, \-filter=>\e%filters);"
.el .SS "\f(CW@vpn_connections\fP = \f(CW$ec2\fP\->describe_vpn_connections(\-vpn_connection_id=>\e@ids, \-filter=>\e%filters);"
.IX Subsection "@vpn_connections = $ec2->describe_vpn_connections(-vpn_connection_id=>@ids, -filter=>%filters);"
.ie n .SS "@vpn_connections = $ec2\->describe_vpn_connections(@vpn_connection_ids)"
.el .SS "\f(CW@vpn_connections\fP = \f(CW$ec2\fP\->describe_vpn_connections(@vpn_connection_ids)"
.IX Subsection "@vpn_connections = $ec2->describe_vpn_connections(@vpn_connection_ids)"
.ie n .SS "@vpn_connections = $ec2\->describe_vpn_connections(%filters);"
.el .SS "\f(CW@vpn_connections\fP = \f(CW$ec2\fP\->describe_vpn_connections(%filters);"
.IX Subsection "@vpn_connections = $ec2->describe_vpn_connections(%filters);"
Gives information about \s-1VPN\s0 connections
.PP
Returns a series of VM::EC2::VPC::VpnConnection objects.
.PP
Optional parameters are:
.PP
.Vb 2
\& \-vpn_connection_id      ID of the connection(s) to return information on. 
\&                         This can be a string scalar, or an arrayref.
\&
\& \-filter                 Tags and other filters to apply.
.Ve
.PP
The filter argument is a hashreference in which the keys are the
filter names, and the values are the match strings. Some filters
accept wildcards.
.PP
There are a number of filters, which are listed in full at
http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference\-query\-DescribeVpnConnections.html
.PP
Here is a alpha-sorted list of filter names:
customer-gateway-configuration, customer-gateway-id, state,
tag-key, tag-value, tag:key, type, vpn-connection-id,
vpn-gateway-id
.ie n .SS "$vpn_connection = $ec2\->create_vpn_connection(\-type               =>$type, \-customer_gateway_id=>$gtwy_id, \-vpn_gateway_id     =>$vpn_id)"
.el .SS "\f(CW$vpn_connection\fP = \f(CW$ec2\fP\->create_vpn_connection(\-type               =>$type, \-customer_gateway_id=>$gtwy_id, \-vpn_gateway_id     =>$vpn_id)"
.IX Subsection "$vpn_connection = $ec2->create_vpn_connection(-type =>$type, -customer_gateway_id=>$gtwy_id, -vpn_gateway_id =>$vpn_id)"
Creates a new \s-1VPN\s0 connection between an existing virtual private 
gateway and a \s-1VPN\s0 customer gateway. The only supported connection 
type is ipsec.1.
.PP
Required Arguments:
.PP
.Vb 1
\& \-customer_gateway_id        \-\- The ID of the customer gateway
\&
\& \-vpn_gateway_id             \-\- The ID of the VPN gateway
.Ve
.PP
Optional arguments:
 \-type                       \*(-- Default is the only currently available option:
                                ipsec.1 (\s-1API 2012\-06\-15\s0)
.PP
.Vb 4
\& \-options_static_routes_only \-\- Indicates whether or not the VPN connection
\&                                requires static routes. If you are creating a VPN
\&                                connection for a device that does not support
\&                                BGP, you must specify this value as true.
\&
\& \-static_routes_only         \-\- Alias for \-options_static_routes_only
.Ve
.PP
Returns a VM::EC2::VPC::VpnConnection object.
.ie n .SS "$success = $ec2\->delete_vpn_connection(\-vpn_connection_id=>$vpn_id)"
.el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->delete_vpn_connection(\-vpn_connection_id=>$vpn_id)"
.IX Subsection "$success = $ec2->delete_vpn_connection(-vpn_connection_id=>$vpn_id)"
.ie n .SS "$success = $ec2\->delete_vpn_connection($vpn_id)"
.el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->delete_vpn_connection($vpn_id)"
.IX Subsection "$success = $ec2->delete_vpn_connection($vpn_id)"
Deletes a \s-1VPN\s0 connection. Use this if you want to delete a \s-1VPC\s0 and 
all its associated components. Another reason to use this operation
is if you believe the tunnel credentials for your \s-1VPN\s0 connection 
have been compromised. In that situation, you can delete the \s-1VPN \s0
connection and create a new one that has new keys, without needing
to delete the \s-1VPC\s0 or virtual private gateway. If you create a new 
\&\s-1VPN\s0 connection, you must reconfigure the customer gateway using the
new configuration information returned with the new \s-1VPN\s0 connection \s-1ID.\s0
.PP
Arguments:
.PP
.Vb 1
\& \-vpn_connection_id       \-\- The ID of the VPN connection to delete
.Ve
.PP
Returns true on successful deletion.
.ie n .SS "$success = $ec2\->create_vpn_connection_route(\-destination_cidr_block=>$cidr, \-vpn_connection_id     =>$id)"
.el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->create_vpn_connection_route(\-destination_cidr_block=>$cidr, \-vpn_connection_id     =>$id)"
.IX Subsection "$success = $ec2->create_vpn_connection_route(-destination_cidr_block=>$cidr, -vpn_connection_id =>$id)"
Creates a new static route associated with a \s-1VPN\s0 connection between an existing
virtual private gateway and a \s-1VPN\s0 customer gateway. The static route allows
traffic to be routed from the virtual private gateway to the \s-1VPN\s0 customer
gateway.
.PP
Arguments:
.PP
.Vb 2
\& \-destination_cidr_block     \-\- The CIDR block associated with the local subnet
\&                                 of the customer data center.
\&
\& \-vpn_connection_id           \-\- The ID of the VPN connection.
.Ve
.PP
Returns true on successsful creation.
.ie n .SS "$success = $ec2\->delete_vpn_connection_route(\-destination_cidr_block=>$cidr, \-vpn_connection_id     =>$id)"
.el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->delete_vpn_connection_route(\-destination_cidr_block=>$cidr, \-vpn_connection_id     =>$id)"
.IX Subsection "$success = $ec2->delete_vpn_connection_route(-destination_cidr_block=>$cidr, -vpn_connection_id =>$id)"
Deletes a static route associated with a \s-1VPN\s0 connection between an existing
virtual private gateway and a \s-1VPN\s0 customer gateway. The static route allows
traffic to be routed from the virtual private gateway to the \s-1VPN\s0 customer
gateway.
.PP
Arguments:
.PP
.Vb 2
\& \-destination_cidr_block     \-\- The CIDR block associated with the local subnet
\&                                 of the customer data center.
\&
\& \-vpn_connection_id           \-\- The ID of the VPN connection.
.Ve
.PP
Returns true on successsful deletion.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1VM::EC2\s0
.SH "AUTHOR"
.IX Header "AUTHOR"
Lance Kinley <lkinley@loyaltymethods.com>.
Lincoln Stein <lincoln.stein@gmail.com>.
.PP
Copyright (c) 2012 Loyalty Methods, Inc.
Copyright (c) 2012 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.