amazonka-ec2-1.3.5: Amazon Elastic Compute Cloud SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.EC2.DescribeCustomerGateways

Contents

Description

Describes one or more of your VPN customer gateways.

For more information about VPN customer gateways, see Adding a Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.

See: AWS API Reference for DescribeCustomerGateways.

Synopsis

Creating a Request

describeCustomerGateways :: DescribeCustomerGateways Source

Creates a value of DescribeCustomerGateways with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Request Lenses

dcgCustomerGatewayIds :: Lens' DescribeCustomerGateways [Text] Source

One or more customer gateway IDs.

Default: Describes all your customer gateways.

dcgFilters :: Lens' DescribeCustomerGateways [Filter] Source

One or more filters.

  • 'bgp-asn' - The customer gateway's Border Gateway Protocol (BGP) Autonomous System Number (ASN).
  • 'customer-gateway-id' - The ID of the customer gateway.
  • 'ip-address' - The IP address of the customer gateway's Internet-routable external interface.
  • state - The state of the customer gateway (pending | available | deleting | deleted).
  • 'type' - The type of customer gateway. Currently, the only supported type is 'ipsec.1'.
  • tag:key=value - The key/value combination of a tag assigned to the resource.
  • 'tag-key' - The key of a tag assigned to the resource. This filter is independent of the 'tag-value' filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.
  • 'tag-value' - The value of a tag assigned to the resource. This filter is independent of the 'tag-key' filter.

dcgDryRun :: Lens' DescribeCustomerGateways (Maybe Bool) Source

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Destructuring the Response

describeCustomerGatewaysResponse Source

Creates a value of DescribeCustomerGatewaysResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Response Lenses

dcgrsCustomerGateways :: Lens' DescribeCustomerGatewaysResponse [CustomerGateway] Source

Information about one or more customer gateways.