VM::EC2::REST::vpn_gateway(3pm)

1VM::EC2::REST::vpn_gateUwsaeyr(3C)ontributed Perl DocumeVnMt:a:tEiCo2n::REST::vpn_gateway(3)
2
3
4

NAME VM::EC2::REST::vpn_gateway

SYNOPSIS

7        use VM::EC2 ':vpc';
8

METHODS

10       These methods create and manage Virtual Private Network Gateways (VGW).
11
12       Implemented:
13        AttachVpnGateway
14        CreateVpnGateway
15        DeleteVpnGateway
16        DescribeVpnGateways
17        DisableVgwRoutePropagation
18        EnableVgwRoutePropagation
19
20       Unimplemented:
21        (none)
22
23   @gtwys = $ec2->describe_vpn_gateways(-vpn_gateway_id=>\@ids, -filter
24       =>\%filters)
25   @gtwys = $ec2->describe_vpn_gateways(@vpn_gateway_ids)
26   @gtwys = $ec2->describe_vpn_gateways(%filters)
27       Provides information on VPN gateways.
28
29       Return a series of VM::EC2::VPC::VpnGateway objects.  When called with
30       no arguments, returns all VPN gateways.  Pass a list of VPN gateway IDs
31       or use the assorted filters to restrict the search.
32
33       Optional parameters are:
34
35        -vpn_gateway_id         ID of the gateway(s) to return information on.
36                                This can be a string scalar, or an arrayref.
37
38        -filter                 Tags and other filters to apply.
39
40       The filter argument is a hashreference in which the keys are the filter
41       names, and the values are the match strings. Some filters accept
42       wildcards.
43
44       There are a number of filters, which are listed in full at
45       http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeVpnGateways.html
46
47       Here is a alpha-sorted list of filter names: attachment.state,
48       attachment.vpc-id, availability-zone, state, tag-key, tag-value,
49       tag:key, type, vpn-gateway-id
50
51   $vpn_gateway = $ec2->create_vpn_gateway(-type=>$type)
52   $vpn_gateway = $ec2->create_vpn_gateway($type)
53   $vpn_gateway = $ec2->create_vpn_gateway
54       Creates a new virtual private gateway. A virtual private gateway is the
55       VPC-side endpoint for a VPN connection. You can create a virtual
56       private gateway before creating the VPC itself.
57
58        -type switch is optional as there is only one type as of API 2012-06-15
59
60       Returns a VM::EC2::VPC::VpnGateway object on success
61
62   $success = $ec2->delete_vpn_gateway(-vpn_gateway_id=>$id);
63   $success = $ec2->delete_vpn_gateway($id);
64       Deletes a virtual private gateway.  Use this when a VPC and all its
65       associated components are no longer needed.  It is recommended that
66       before deleting a virtual private gateway, detach it from the VPC and
67       delete the VPN connection.  Note that it is not necessary to delete the
68       virtual private gateway if the VPN connection between the VPC and data
69       center needs to be recreated.
70
71       Arguments:
72
73        -vpn_gateway_id    -- The ID of the VPN gateway to delete.
74
75       Returns true on successful deletion
76
77   $state = $ec2->attach_vpn_gateway(-vpn_gateway_id=>$vpn_gtwy_id, -vpc_id
78       =>$vpc_id)
79       Attaches a virtual private gateway to a VPC.
80
81       Arguments:
82
83        -vpc_id          -- The ID of the VPC to attach the VPN gateway to
84
85        -vpn_gateway_id  -- The ID of the VPN gateway to attach
86
87       Returns the state of the attachment, one of:
88          attaching | attached | detaching | detached
89
90   $success = $ec2->detach_vpn_gateway(-vpn_gateway_id=>$vpn_gtwy_id, -vpc_id
91       =>$vpc_id)
92       Detaches a virtual private gateway from a VPC. You do this if you're
93       planning to turn off the VPC and not use it anymore. You can confirm a
94       virtual private gateway has been completely detached from a VPC by
95       describing the virtual private gateway (any attachments to the virtual
96       private gateway are also described).
97
98       You must wait for the attachment's state to switch to detached before
99       you can delete the VPC or attach a different VPC to the virtual private
100       gateway.
101
102       Arguments:
103
104        -vpc_id          -- The ID of the VPC to detach the VPN gateway from
105
106        -vpn_gateway_id  -- The ID of the VPN gateway to detach
107
108       Returns true on successful detachment.
109
110   $success = $ec2->enable_vgw_route_propagation(-route_table_id=>$rt_id,
111       -gateway_id    =>$gtwy_id)
112       Enables a virtual private gateway (VGW) to propagate routes to the
113       routing tables of an Amazon VPC.
114
115       Arguments:
116
117        -route_table_id        -- The ID of the routing table.
118
119        -gateway_id            -- The ID of the virtual private gateway.
120
121       Returns true on successful enablement.
122
123   $success = $ec2->disable_vgw_route_propagation(-route_table_id=>$rt_id,
124       -gateway_id    =>$gtwy_id)
125       Disables a virtual private gateway (VGW) from propagating routes to the
126       routing tables of an Amazon VPC.
127
128       Arguments:
129
130        -route_table_id        -- The ID of the routing table.
131
132        -gateway_id            -- The ID of the virtual private gateway.
133
134       Returns true on successful disablement.
135

AUTHOR

140       Lance Kinley <lkinley@loyaltymethods.com>.  Lincoln Stein
141       <lincoln.stein@gmail.com>.
142
143       Copyright (c) 2012 Loyalty Methods, Inc.  Copyright (c) 2012 Ontario
144       Institute for Cancer Research
145
146       This package and its accompanying libraries is free software; you can
147       redistribute it and/or modify it under the terms of the GPL (either
148       version 1, or at your option, any later version) or the Artistic
149       License 2.0.  Refer to LICENSE for the full license text. In addition,
150       please see DISCLAIMER.txt for disclaimers of warranty.
151
152
153
154perl v5.32.0                      2020-07-28     VM::EC2::REST::vpn_gateway(3)

NAME VM::EC2::REST::vpn_gateway

SYNOPSIS

METHODS

SEE ALSO

AUTHOR