| « PreviousNext » | |
  | Did this page help you? Yes | No | Tell us about it... |
DescribeVpnConnections
Description
Describes one of more of your VPN connections.
Important
We strongly recommend that you use HTTPS when calling this operation because the response contains sensitive cryptographic information for configuring your customer gateway.
For more information about VPN connections, see Adding an IPsec Hardware Virtual Private Gateway to Your VPC in the Amazon Virtual Private Cloud User Guide.
Note
You can get the customer gateway configuration information in a friendly format by using the ec2-describe-vpn-connections command instead. For more information, see ec2-describe-vpn-connections.
Request Parameters
VpnConnectionId.nA VPN connection ID. You can specify more than one in the request.
Type: String
Default: Describes your VPN connections
Required: No
Filter.n.NameThe name of a filter. See the Supported Filters section for a list of supported filter names.
Type: String
Default: None
Required: No
Filter.n.Value.mA value for the filter. See the Supported Filters section for a list of supported values for each filter.
Type: String
Default: None
Required: No
Supported Filters
You can specify filters so that the response includes information for only certain VPN connections.
For example, you can use a filter to specify that you're interested in the VPN connections
in the pending or available state. You can specify multiple values for a filter.
The response includes information for a VPN connection only if it matches at least one of the filter values
that you specified.
You can specify multiple filters; for example, specify VPN connections that are associated with a
specific virtual private gateway, and the gateway is in the pending or available state.
The response includes information for a VPN connection only if it matches all the filters that you specified.
If there's no match, no special message is returned, the response is simply empty.
You can use wildcards in a filter value. An asterisk (*) matches zero or more characters, and a question mark (?) matches exactly one character. You can escape special characters using a backslash (\) before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\.
The following are the available filters.
customer-gateway-configurationThe configuration information for the customer gateway.
Type: String
customer-gateway-idThe ID of a customer gateway associated with the VPN connection.
Type: String
stateThe state of the VPN connection.
Type: String
Valid values:
pending|available|deleting|deletedoption.static-routes-onlyIndicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
Type: Boolean
route.destination-cidr-blockThe destination CIDR block. This corresponds to the subnet used in a customer data center.
Type: String
bgp-asnThe BGP Autonomous System Number (ASN) associated with a BGP device.
Type: Integer
tag-keyThe key of a tag assigned to the resource. This filter is independent of the
tag-valuefilter. 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 keyPurpose(regardless of what the tag's value is), and the tag valueX(regardless of what the tag's key is). If you want to list only resources where Purpose is X, see thetag:filter.keyFor more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
Type: String
tag-valueThe value of a tag assigned to the resource. This filter is independent of the
tag-keyfilter.Type: String
tag:keyFilters the response based on a specific tag/value combination.
Example: To list just the resources that have been assigned tag Purpose=X, specify:
Filter.1.Name=tag:PurposeFilter.1.Value.1=XExample: To list just resources that have been assigned tag Purpose=X OR Purpose=Y, specify:
Filter.1.Name=tag:PurposeFilter.1.Value.1=XFilter.1.Value.2=YtypeThe type of VPN connection. Currently the only supported type is
ipsec.1.Type: String
Valid values:
ipsec.1vpn-connection-idThe ID of the VPN connection.
Type: String
vpn-gateway-idThe ID of a virtual private gateway associated with the VPN connection.
Type: String
Response Elements
The following elements are returned in an
DescribeVpnConnectionsResponse element.
requestIdThe ID of the request.
Type: xsd:string
vpnConnectionSetA list of VPN connections. Each VPN connection is wrapped in an
itemelement.Type: VpnConnectionType
Examples
Example Request
This example describes the VPN connection with ID vpn-44a8938f. The response
includes the customer gateway configuration information. Because it's a long set
of information, we haven't displayed it here. You can see an example in the
topic for CreateVpnConnection.
https://ec2.amazonaws.com/?Action=DescribeVpnConnections &VpnConnectionId.1=vpn-44a8938f &AUTHPARAMS
Example Response
<DescribeVpnConnectionsResponse xmlns="http://ec2.amazonaws.com/doc/2013-02-01/">
<requestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</requestId>
<vpnConnectionSet>
<item>
<vpnConnectionId>vpn-44a8938f</vpnConnectionId>
<state>available</state>
<CustomerGatewayConfiguration>
Customer gateway configuration data in escaped XML format...
...
</CustomerGatewayConfiguration>
<type>ipsec.1</type>
<customerGatewayId>cgw-b4dc3961</customerGatewayId>
<vpnGatewayId>vgw-8db04f81</vpnGatewayId>
<tagSet/>
</item>
</vpnConnectionSet>
</DescribeVpnConnectionsResponse>Example Request
This example describes any VPN connection you own that is associated with the
customer gateway with ID cgw-b4dc3961, and whose state is either
pending or available.
https://ec2.amazonaws.com/?Action=DescribeVpnConnections &Filter.1.Name=customer-gateway-id &Filter.1.Value.1=cgw-b4dc3961 &Filter.2.Name=state &Filter.2.Value.1=pending &Filter.2.Value.2=available &AUTHPARAMS
