|« PreviousNext »|
|Did this page help you? Yes | No | Tell us about it...|
Describes one of more of your VPN connections.
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.
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.
A VPN connection ID. You can specify more than one in the request.
Default: Describes your VPN connections
The name of a filter. See the Supported Filters section for a list of supported filter names.
A value for the filter. See the Supported Filters section for a list of supported values for each filter.
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
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
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
The following are the available filters.
The configuration information for the customer gateway.
The ID of a customer gateway associated with the VPN connection.
The state of the VPN connection.
Indicates whether the connection has static routes only. Used for devices that do not support Border Gateway Protocol (BGP).
The destination CIDR block. This corresponds to the subnet used in a customer data center.
The BGP Autonomous System Number (ASN) associated with a BGP device.
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
For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide.
The value of a tag assigned to the resource. This filter is independent of the
Filters the response based on a specific tag/value combination.
Example: To list just the resources that have been assigned tag Purpose=X, specify:
Example: To list just resources that have been assigned tag Purpose=X OR Purpose=Y, specify:
The type of VPN connection. Currently the only supported type is
The ID of the VPN connection.
The ID of a virtual private gateway associated with the VPN connection.
The following elements are returned in an
The ID of the request.
A list of VPN connections. Each VPN connection is wrapped in an
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
https://ec2.amazonaws.com/?Action=DescribeVpnConnections &VpnConnectionId.1=vpn-44a8938f &AUTHPARAMS
<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>
This example describes any VPN connection you own that is associated with the
customer gateway with ID cgw-b4dc3961, and whose state is either
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