Getting Information About Your Customer Gateways
You can get information about one or more customer gateways.
By default, this action describes all your customer gateways.
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded
error message is returned.
This procedure uses AWS CLI only. Information about these resources is also available from Cockpit. For more information, see VPN Connections User Interface.
To get information about one or more customer gateways, use the describe-customer-gateways command following this syntax:
$ aws ec2 describe-customer-gateways \
--profile YOUR_PROFILE \
[--filters NOT_SPECIFIED] \
--endpoint https://fcu.eu-west-2.outscale.com
This command contains the following attributes that you need to specify:
-
(optional)
profile
: The named profile you want to use, created when configuring AWS CLI. For more information, see Installing and Configuring AWS CLI. -
(optional)
customer-gateway-ids
: The ID of one or more customer gateways you want to get information about. -
(optional)
filters
: One or more filters, in the "Name=X,Values=Y" format.You can specify several values for a same filter using the "Name=X,Values=Y, Z" format.
The following filters are available:
-
state
: The state of the customer gateways (pending
|available
|deleting
|deleted
). For more information, see About Customer Gateways. -
customer-gateway-id
: The ID of the customer gateway. -
ip-address
: The public IP of the customer gateway. -
bgp-asn
: An Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your customer gateway through the Internet. For more information, see About Customer Gateways. -
type
: The type of VPN connection the customer gateway supports (alwaysipsec.1
). -
tag-key
: The key of a tag associated with the resource. -
tag-value
: The value of a tag associated with the resource. -
tag:XXXX
: The value of a tag associated with the resource, whereXXXX
is the key of the tag.
To filter a tag whose key is
|
-
endpoint
: The endpoint corresponding to the Region you want to send the request to.
The describe-customer-gateways command returns the following elements:
-
CustomerGateway
: Information about one or more customer gateways. This element contains the following information: -
Tags
: One or more tags associated with the customer gateway. This element contains the following information:-
Key
: The key of the tag. -
Value
: The value of the tag.
-
-
Type
: The type of VPN connection the customer gateway supports (alwaysipsec.1
). -
State
: The state of the customer gateway (pending
|available
|deleting
|deleted
). For more information, see About Customer Gateways. -
CustomerGatewayId
: The ID of the customer gateway. -
BgpAsn
: An Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find the path to your customer gateway through the Internet. For more information, see About Customer Gateways. -
IpAddress
: The public IP of the customer gateway.
{
"CustomerGateways": [
{
"Tags": [],
"Type": "ipsec.1",
"State": "available",
"CustomerGatewayId": "cgw-73a7fba3",
"BgpAsn": "65000",
"IpAddress": "198.18.7.207"
}
]
}
Related Pages
Corresponding API Method
AWS™ and Amazon Web Services™ are trademarks of Amazon Technologies, Inc or its affiliates in the United States and/or other countries.