.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 >0, 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_gateway 3pm"
.TH VM::EC2::REST::vpn_gateway 3pm "2022-10-14" "perl v5.34.0" "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_gateway \- Create and manage Virtual Private Network Gateways"
.IX Header "NAME VM::EC2::REST::vpn_gateway - Create and manage Virtual Private Network Gateways"
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use VM::EC2 \*(Aq:vpc\*(Aq;
.Ve
.SH "METHODS"
.IX Header "METHODS"
These methods create and manage Virtual Private Network Gateways (\s-1VGW\s0).
.PP
Implemented:
 AttachVpnGateway
 CreateVpnGateway
 DeleteVpnGateway
 DescribeVpnGateways
 DisableVgwRoutePropagation
 EnableVgwRoutePropagation
.PP
Unimplemented:
 (none)
.ie n .SS "@gtwys = $ec2\->describe_vpn_gateways(\-vpn_gateway_id=>\e@ids, \-filter        =>\e%filters)"
.el .SS "\f(CW@gtwys\fP = \f(CW$ec2\fP\->describe_vpn_gateways(\-vpn_gateway_id=>\e@ids, \-filter        =>\e%filters)"
.IX Subsection "@gtwys = $ec2->describe_vpn_gateways(-vpn_gateway_id=>@ids, -filter =>%filters)"
.ie n .SS "@gtwys = $ec2\->describe_vpn_gateways(@vpn_gateway_ids)"
.el .SS "\f(CW@gtwys\fP = \f(CW$ec2\fP\->describe_vpn_gateways(@vpn_gateway_ids)"
.IX Subsection "@gtwys = $ec2->describe_vpn_gateways(@vpn_gateway_ids)"
.ie n .SS "@gtwys = $ec2\->describe_vpn_gateways(%filters)"
.el .SS "\f(CW@gtwys\fP = \f(CW$ec2\fP\->describe_vpn_gateways(%filters)"
.IX Subsection "@gtwys = $ec2->describe_vpn_gateways(%filters)"
Provides information on \s-1VPN\s0 gateways.
.PP
Return a series of VM::EC2::VPC::VpnGateway objects.  When called with no
arguments, returns all \s-1VPN\s0 gateways.  Pass a list of \s-1VPN\s0 gateway IDs or
use the assorted filters to restrict the search.
.PP
Optional parameters are:
.PP
.Vb 2
\& \-vpn_gateway_id         ID of the gateway(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\-DescribeVpnGateways.html
.PP
Here is a alpha-sorted list of filter names: attachment.state,
attachment.vpc\-id, availability-zone, state, tag-key, tag-value, tag:key, type,
vpn-gateway-id
.ie n .SS "$vpn_gateway = $ec2\->create_vpn_gateway(\-type=>$type)"
.el .SS "\f(CW$vpn_gateway\fP = \f(CW$ec2\fP\->create_vpn_gateway(\-type=>$type)"
.IX Subsection "$vpn_gateway = $ec2->create_vpn_gateway(-type=>$type)"
.ie n .SS "$vpn_gateway = $ec2\->create_vpn_gateway($type)"
.el .SS "\f(CW$vpn_gateway\fP = \f(CW$ec2\fP\->create_vpn_gateway($type)"
.IX Subsection "$vpn_gateway = $ec2->create_vpn_gateway($type)"
.ie n .SS "$vpn_gateway = $ec2\->create_vpn_gateway"
.el .SS "\f(CW$vpn_gateway\fP = \f(CW$ec2\fP\->create_vpn_gateway"
.IX Subsection "$vpn_gateway = $ec2->create_vpn_gateway"
Creates a new virtual private gateway. A virtual private gateway is the
VPC-side endpoint for a \s-1VPN\s0 connection. You can create a virtual private 
gateway before creating the \s-1VPC\s0 itself.
.PP
.Vb 1
\& \-type switch is optional as there is only one type as of API 2012\-06\-15
.Ve
.PP
Returns a VM::EC2::VPC::VpnGateway object on success
.ie n .SS "$success = $ec2\->delete_vpn_gateway(\-vpn_gateway_id=>$id);"
.el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->delete_vpn_gateway(\-vpn_gateway_id=>$id);"
.IX Subsection "$success = $ec2->delete_vpn_gateway(-vpn_gateway_id=>$id);"
.ie n .SS "$success = $ec2\->delete_vpn_gateway($id);"
.el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->delete_vpn_gateway($id);"
.IX Subsection "$success = $ec2->delete_vpn_gateway($id);"
Deletes a virtual private gateway.  Use this when a \s-1VPC\s0 and all its associated 
components are no longer needed.  It is recommended that before deleting a 
virtual private gateway, detach it from the \s-1VPC\s0 and delete the \s-1VPN\s0 connection.
Note that it is not necessary to delete the virtual private gateway if the \s-1VPN\s0 
connection between the \s-1VPC\s0 and data center needs to be recreated.
.PP
Arguments:
.PP
.Vb 1
\& \-vpn_gateway_id    \-\- The ID of the VPN gateway to delete.
.Ve
.PP
Returns true on successful deletion
.ie n .SS "$state = $ec2\->attach_vpn_gateway(\-vpn_gateway_id=>$vpn_gtwy_id, \-vpc_id        =>$vpc_id)"
.el .SS "\f(CW$state\fP = \f(CW$ec2\fP\->attach_vpn_gateway(\-vpn_gateway_id=>$vpn_gtwy_id, \-vpc_id        =>$vpc_id)"
.IX Subsection "$state = $ec2->attach_vpn_gateway(-vpn_gateway_id=>$vpn_gtwy_id, -vpc_id =>$vpc_id)"
Attaches a virtual private gateway to a \s-1VPC.\s0
.PP
Arguments:
.PP
.Vb 1
\& \-vpc_id          \-\- The ID of the VPC to attach the VPN gateway to
\&
\& \-vpn_gateway_id  \-\- The ID of the VPN gateway to attach
.Ve
.PP
Returns the state of the attachment, one of:
   attaching | attached | detaching | detached
.ie n .SS "$success = $ec2\->detach_vpn_gateway(\-vpn_gateway_id=>$vpn_gtwy_id, \-vpc_id        =>$vpc_id)"
.el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->detach_vpn_gateway(\-vpn_gateway_id=>$vpn_gtwy_id, \-vpc_id        =>$vpc_id)"
.IX Subsection "$success = $ec2->detach_vpn_gateway(-vpn_gateway_id=>$vpn_gtwy_id, -vpc_id =>$vpc_id)"
Detaches a virtual private gateway from a \s-1VPC.\s0 You do this if you're
planning to turn off the \s-1VPC\s0 and not use it anymore. You can confirm
a virtual private gateway has been completely detached from a \s-1VPC\s0 by
describing the virtual private gateway (any attachments to the 
virtual private gateway are also described).
.PP
You must wait for the attachment's state to switch to detached 
before you can delete the \s-1VPC\s0 or attach a different \s-1VPC\s0 to the 
virtual private gateway.
.PP
Arguments:
.PP
.Vb 1
\& \-vpc_id          \-\- The ID of the VPC to detach the VPN gateway from
\&
\& \-vpn_gateway_id  \-\- The ID of the VPN gateway to detach
.Ve
.PP
Returns true on successful detachment.
.ie n .SS "$success = $ec2\->enable_vgw_route_propagation(\-route_table_id=>$rt_id, \-gateway_id    =>$gtwy_id)"
.el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->enable_vgw_route_propagation(\-route_table_id=>$rt_id, \-gateway_id    =>$gtwy_id)"
.IX Subsection "$success = $ec2->enable_vgw_route_propagation(-route_table_id=>$rt_id, -gateway_id =>$gtwy_id)"
Enables a virtual private gateway (\s-1VGW\s0) to propagate routes to the routing
tables of an Amazon \s-1VPC.\s0
.PP
Arguments:
.PP
.Vb 1
\& \-route_table_id        \-\- The ID of the routing table.
\&
\& \-gateway_id            \-\- The ID of the virtual private gateway.
.Ve
.PP
Returns true on successful enablement.
.ie n .SS "$success = $ec2\->disable_vgw_route_propagation(\-route_table_id=>$rt_id, \-gateway_id    =>$gtwy_id)"
.el .SS "\f(CW$success\fP = \f(CW$ec2\fP\->disable_vgw_route_propagation(\-route_table_id=>$rt_id, \-gateway_id    =>$gtwy_id)"
.IX Subsection "$success = $ec2->disable_vgw_route_propagation(-route_table_id=>$rt_id, -gateway_id =>$gtwy_id)"
Disables a virtual private gateway (\s-1VGW\s0) from propagating routes to the routing
tables of an Amazon \s-1VPC.\s0
.PP
Arguments:
.PP
.Vb 1
\& \-route_table_id        \-\- The ID of the routing table.
\&
\& \-gateway_id            \-\- The ID of the virtual private gateway.
.Ve
.PP
Returns true on successful disablement.
.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.