Use DescribeCustomerGateways
with an AWS SDK or CLI
The following code examples show how to use DescribeCustomerGateways
.
- CLI
-
- AWS CLI
-
To describe your customer gateways
This example describes your customer gateways.
Command:
<userinput>aws ec2 describe-customer-gateways</userinput>
Output:
{ "CustomerGateways": [ { "CustomerGatewayId": "cgw-b4dc3961", "IpAddress": "203.0.113.12", "State": "available", "Type": "ipsec.1", "BgpAsn": "65000" }, { "CustomerGatewayId": "cgw-0e11f167", "IpAddress": "12.1.2.3", "State": "available", "Type": "ipsec.1", "BgpAsn": "65534" } ] }
To describe a specific customer gateway
This example describes the specified customer gateway.
Command:
<userinput>aws ec2 describe-customer-gateways --customer-gateway-ids <replaceable>cgw-0e11f167</replaceable></userinput>
Output:
{ "CustomerGateways": [ { "CustomerGatewayId": "cgw-0e11f167", "IpAddress": "12.1.2.3", "State": "available", "Type": "ipsec.1", "BgpAsn": "65534" } ] }
-
For API details, see DescribeCustomerGateways
in AWS CLI Command Reference.
-
- PowerShell
-
- Tools for PowerShell
-
Example 1: This example describes the specified customer gateway.
Get-EC2CustomerGateway -CustomerGatewayId cgw-1a2b3c4d
Output:
BgpAsn : 65534 CustomerGatewayId : cgw-1a2b3c4d IpAddress : 203.0.113.12 State : available Tags : {} Type : ipsec.1
Example 2: This example describes any customer gateway whose state is either pending or available.
$filter = New-Object Amazon.EC2.Model.Filter $filter.Name = "state" $filter.Values = @( "pending", "available" ) Get-EC2CustomerGateway -Filter $filter
Example 3: This example describes all your customer gateways.
Get-EC2CustomerGateway
-
For API details, see DescribeCustomerGateways in AWS Tools for PowerShell Cmdlet Reference.
-
For a complete list of AWS SDK developer guides and code examples, see Create Amazon EC2 resources using an AWS SDK. This topic also includes information about getting started and details about previous SDK versions.