1VM::EC2::REST::customerU_sgearteCwoanyt(r3i)buted Perl DVoMc:u:mEeCn2t:a:tRiEoSnT::customer_gateway(3)
2
3
4

NAME VM::EC2::REST::customer_gateway

SYNOPSIS

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

METHODS

10       These methods control customer gateways for AWS VPNs.
11
12       Implemented:
13        CreateCustomerGateway
14        DeleteCustomerGateway
15        DescribeCustomerGateways
16
17       Unimplemented:
18        (none)
19
20   @gtwys = $ec2->describe_customer_gateways(-customer_gateway_id=>\@ids,
21       -filter             =>\%filters)
22   @gtwys = $ec2->describe_customer_gateways(\@customer_gateway_ids)
23   @gtwys = $ec2->describe_customer_gateways(%filters)
24       Provides information on VPN customer gateways.
25
26       Returns a series of VM::EC2::VPC::CustomerGateway objects.
27
28       Optional parameters are:
29
30        -customer_gateway_id    ID of the gateway(s) to return information on.
31                                This can be a string scalar, or an arrayref.
32
33        -filter                 Tags and other filters to apply.
34
35       The filter argument is a hashreference in which the keys are the filter
36       names, and the values are the match strings. Some filters accept
37       wildcards.
38
39       There are a number of filters, which are listed in full at
40       http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeCustomerGateways.html
41
42       Here is a alpha-sorted list of filter names: bgp-asn, customer-gateway-
43       id, ip-address, state, type, tag-key, tag-value, tag:key
44
45   $cust_gtwy = $ec2->create_customer_gateway(-type      =>$type,
46       -ip_address=>$ip, -bgp_asn   =>$asn)
47       Provides information to AWS about a VPN customer gateway device. The
48       customer gateway is the appliance at the customer end of the VPN
49       connection (compared to the virtual private gateway, which is the
50       device at the AWS side of the VPN connection).
51
52       Arguments:
53
54        -ip_address     -- The IP address of the customer gateway appliance
55
56        -bgp_asn        -- The Border Gateway Protocol (BGP) Autonomous System Number
57                           (ASN) of the customer gateway
58
59        -type           -- Optional as there is only currently (2012-06-15 API) only
60                           one type (ipsec.1)
61
62        -ip             -- Alias for -ip_address
63
64       Returns a VM::EC2::VPC::CustomerGateway object on success.
65
66   $success = $ec2->delete_customer_gateway(-customer_gateway_id=>$id)
67   $success = $ec2->delete_customer_gateway($id)
68       Deletes a VPN customer gateway. You must delete the VPN connection
69       before deleting the customer gateway.
70
71       Arguments:
72
73        -customer_gateway_id     -- The ID of the customer gateway to delete
74
75       Returns true on successful deletion.
76

SEE ALSO

78       VM::EC2
79

AUTHOR

81       Lincoln Stein <lincoln.stein@gmail.com>.
82
83       Copyright (c) 2011 Ontario Institute for Cancer Research
84
85       This package and its accompanying libraries is free software; you can
86       redistribute it and/or modify it under the terms of the GPL (either
87       version 1, or at your option, any later version) or the Artistic
88       License 2.0.  Refer to LICENSE for the full license text. In addition,
89       please see DISCLAIMER.txt for disclaimers of warranty.
90
91
92
93perl v5.36.0                      2023-01-20VM::EC2::REST::customer_gateway(3)