EC2 Describe Customer Gateways

Describes one or more of your VPN customer gateways.

For more information, see AWS Site-to-Site VPN in the AWS Site-to-Site VPN User Guide.

External Documentation

To learn more, visit the AWS documentation.

Basic Parameters

Parameter	Description
AWS Region(s)	Enter the desired AWS Region(s). To execute the action in multiple regions, provide a comma-separated list. For example: us-east-1,eu-west-2. If you wish to run the action in all available regions, use the asterisk symbol (*) instead.
Customer Gateway IDs	One or more customer gateway IDs. Default: Describes all your customer gateways.

Advanced Parameters

Parameter	Description
Disable XML To JSON Auto Convert	When checked, XML responses are not automatically converted into JSON format.
Dry Run	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.
Filters	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> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value. - tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

Example Output

{
    "CustomerGateways": [
        {
            "BgpAsn": "65534",
            "CustomerGatewayId": "cgw-0e11f167",
            "IpAddress": "12.1.2.3",
            "State": "available",
            "Type": "ipsec.1"
        }
    ]
}

Automation Library Example

Ec2 Describe Customer Gateways with Aws and Send Results Via Email

Preview this Automation on desktop