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

1VM::EC2::REST::vpn(3) User Contributed Perl DocumentationVM::EC2::REST::vpn(3)
2
3
4

NAME VM::EC2::REST::vpn

SYNOPSIS

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

METHODS

10       These methods create and manage the connections of Virtual Private
11       Network (VPN) to Amazon Virtual Private Clouds (VPC).
12
13       Implemented:
14        CreateVpnConnection
15        CreateVpnConnectionRoute
16        DeleteVpnConnection
17        DeleteVpnConnectionRoute
18        DescribeVpnConnections
19
20       Unimplemented:
21        (none)
22
23   @vpn_connections =
24       $ec2->describe_vpn_connections(-vpn_connection_id=>\@ids,
25       -filter=>\%filters);
26   @vpn_connections = $ec2->describe_vpn_connections(@vpn_connection_ids)
27   @vpn_connections = $ec2->describe_vpn_connections(%filters);
28       Gives information about VPN connections
29
30       Returns a series of VM::EC2::VPC::VpnConnection objects.
31
32       Optional parameters are:
33
34        -vpn_connection_id      ID of the connection(s) to return information on.
35                                This can be a string scalar, or an arrayref.
36
37        -filter                 Tags and other filters to apply.
38
39       The filter argument is a hashreference in which the keys are the filter
40       names, and the values are the match strings. Some filters accept
41       wildcards.
42
43       There are a number of filters, which are listed in full at
44       http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeVpnConnections.html
45
46       Here is a alpha-sorted list of filter names: customer-gateway-
47       configuration, customer-gateway-id, state, tag-key, tag-value, tag:key,
48       type, vpn-connection-id, vpn-gateway-id
49
50   $vpn_connection = $ec2->create_vpn_connection(-type               =>$type,
51       -customer_gateway_id=>$gtwy_id, -vpn_gateway_id     =>$vpn_id)
52       Creates a new VPN connection between an existing virtual private
53       gateway and a VPN customer gateway. The only supported connection type
54       is ipsec.1.
55
56       Required Arguments:
57
58        -customer_gateway_id        -- The ID of the customer gateway
59
60        -vpn_gateway_id             -- The ID of the VPN gateway
61
62       Optional arguments:
63        -type                       -- Default is the only currently available
64       option:
65                                       ipsec.1 (API 2012-06-15)
66
67        -options_static_routes_only -- Indicates whether or not the VPN connection
68                                       requires static routes. If you are creating a VPN
69                                       connection for a device that does not support
70                                       BGP, you must specify this value as true.
71
72        -static_routes_only         -- Alias for -options_static_routes_only
73
74       Returns a VM::EC2::VPC::VpnConnection object.
75
76   $success = $ec2->delete_vpn_connection(-vpn_connection_id=>$vpn_id)
77   $success = $ec2->delete_vpn_connection($vpn_id)
78       Deletes a VPN connection. Use this if you want to delete a VPC and all
79       its associated components. Another reason to use this operation is if
80       you believe the tunnel credentials for your VPN connection have been
81       compromised. In that situation, you can delete the VPN connection and
82       create a new one that has new keys, without needing to delete the VPC
83       or virtual private gateway. If you create a new VPN connection, you
84       must reconfigure the customer gateway using the new configuration
85       information returned with the new VPN connection ID.
86
87       Arguments:
88
89        -vpn_connection_id       -- The ID of the VPN connection to delete
90
91       Returns true on successful deletion.
92
93   $success =
94       $ec2->create_vpn_connection_route(-destination_cidr_block=>$cidr,
95       -vpn_connection_id     =>$id)
96       Creates a new static route associated with a VPN connection between an
97       existing virtual private gateway and a VPN customer gateway. The static
98       route allows traffic to be routed from the virtual private gateway to
99       the VPN customer gateway.
100
101       Arguments:
102
103        -destination_cidr_block     -- The CIDR block associated with the local subnet
104                                        of the customer data center.
105
106        -vpn_connection_id           -- The ID of the VPN connection.
107
108       Returns true on successsful creation.
109
110   $success =
111       $ec2->delete_vpn_connection_route(-destination_cidr_block=>$cidr,
112       -vpn_connection_id     =>$id)
113       Deletes a static route associated with a VPN connection between an
114       existing virtual private gateway and a VPN customer gateway. The static
115       route allows traffic to be routed from the virtual private gateway to
116       the VPN customer gateway.
117
118       Arguments:
119
120        -destination_cidr_block     -- The CIDR block associated with the local subnet
121                                        of the customer data center.
122
123        -vpn_connection_id           -- The ID of the VPN connection.
124
125       Returns true on successsful deletion.
126

AUTHOR

131       Lance Kinley <lkinley@loyaltymethods.com>.  Lincoln Stein
132       <lincoln.stein@gmail.com>.
133
134       Copyright (c) 2012 Loyalty Methods, Inc.  Copyright (c) 2012 Ontario
135       Institute for Cancer Research
136
137       This package and its accompanying libraries is free software; you can
138       redistribute it and/or modify it under the terms of the GPL (either
139       version 1, or at your option, any later version) or the Artistic
140       License 2.0.  Refer to LICENSE for the full license text. In addition,
141       please see DISCLAIMER.txt for disclaimers of warranty.
142
143
144
145perl v5.36.0                      2023-01-20             VM::EC2::REST::vpn(3)

NAME VM::EC2::REST::vpn

SYNOPSIS

METHODS

SEE ALSO

AUTHOR