/ 
VM-EC2-1.28
River stage one • 1 direct dependent • 5 total dependents
/ VM::EC2::REST::customer_gateway

NAME VM::EC2::REST::customer_gateway

SYNOPSIS

use VM::EC2 ':vpc';

METHODS

These methods control customer gateways for AWS VPNs.

Implemented: CreateCustomerGateway DeleteCustomerGateway DescribeCustomerGateways

Unimplemented: (none)

@gtwys = $ec2->describe_customer_gateways(-customer_gateway_id=>\@ids, -filter =>\%filters)

@gtwys = $ec2->describe_customer_gateways(\@customer_gateway_ids)

@gtwys = $ec2->describe_customer_gateways(%filters)

Provides information on VPN customer gateways.

Returns a series of VM::EC2::VPC::CustomerGateway objects.

Optional parameters are:

-customer_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.

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.

There are a number of filters, which are listed in full at http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeCustomerGateways.html

Here is a alpha-sorted list of filter names: bgp-asn, customer-gateway-id, ip-address, state, type, tag-key, tag-value, tag:key

$cust_gtwy = $ec2->create_customer_gateway(-type =>$type, -ip_address=>$ip, -bgp_asn =>$asn)

Provides information to AWS about a VPN customer gateway device. The customer gateway is the appliance at the customer end of the VPN connection (compared to the virtual private gateway, which is the device at the AWS side of the VPN connection).

Arguments:

-ip_address     -- The IP address of the customer gateway appliance

-bgp_asn        -- The Border Gateway Protocol (BGP) Autonomous System Number
                   (ASN) of the customer gateway

-type           -- Optional as there is only currently (2012-06-15 API) only
                   one type (ipsec.1)

-ip             -- Alias for -ip_address

Returns a VM::EC2::VPC::CustomerGateway object on success.

$success = $ec2->delete_customer_gateway(-customer_gateway_id=>$id)

$success = $ec2->delete_customer_gateway($id)

Deletes a VPN customer gateway. You must delete the VPN connection before deleting the customer gateway.

Arguments:

-customer_gateway_id     -- The ID of the customer gateway to delete

Returns true on successful deletion.

SEE ALSO

VM::EC2

AUTHOR

Lincoln Stein <lincoln.stein@gmail.com>.

Copyright (c) 2011 Ontario Institute for Cancer Research

This package and its accompanying libraries is free software; you can redistribute it and/or modify it under the terms of the GPL (either version 1, or at your option, any later version) or the Artistic License 2.0. Refer to LICENSE for the full license text. In addition, please see DISCLAIMER.txt for disclaimers of warranty.