DescribeVpnConnections

Description

Describes one or more of your VPN connections.

Request Parameters

  • VpnConnectionId.n - One or more VPN connection IDs

    • Type: String

    • Default: The list of all VPN connections

  • Filter.n.Name - The name of the filter. Filter names are case-sensitive

    • Type: String

    • Default: None

  • Filter.n.Value.n - One or more filter values. Filter values are case-sensitive

    • Type: String

    • Default: None

Supported Filters

  • customer-gateway-id

  • state

  • type - The type of VPN connection

  • vpn-gateway-id

  • vpn-connection-id

  • tag:<tag-key> - Key/value pair of the Tag. Tag key is set in the name of a filter, Tag value – in the value of the filter

  • tag-key - Tag key. This filter is used to get resources with Tag with the specified key and any value

Response Elements

  • requestId - The ID of the request

    • Type: String

  • vpnConnectionSet - Information about one or more VPN connections

Examples

c2-ec2 DescribeVpnConnections

c2-ec2 DescribeVpnConnections VpnConnectionId.1 <vpn_id>

c2-ec2 DescribeVpnConnections Filter.1.Name state Filter.1.Value.1 available

c2-ec2 DescribeVpnConnections Filter.1.Name vpn-gateway-id Filter.1.Value.1 <vgw_id>

c2-ec2 DescribeVpnConnections Filter.1.Name tag:<tag-key> Filter.1.Value <tag-value>

c2-ec2 DescribeVpnConnections Filter.1.Name tag-key Filter.1.Value <tag-key>