Menu
Amazon Elastic Compute Cloud
API Reference (API Version 2016-11-15)

VpnConnection

Describes a VPN connection.

Contents

category

The category of the VPN connection. A value of VPN indicates an AWS VPN connection. A value of VPN-Classic indicates an AWS Classic VPN connection. For more information, see AWS Managed VPN Categories in the Amazon Virtual Private Cloud User Guide.

Type: String

Required: No

customerGatewayConfiguration

The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the CreateVpnConnection response; however, it's present in the DescribeVpnConnections response only if the VPN connection is in the pending or available state.

Type: String

Required: No

customerGatewayId

The ID of the customer gateway at your end of the VPN connection.

Type: String

Required: No

options

The VPN connection options.

Type: VpnConnectionOptions object

Required: No

routes

The static routes associated with the VPN connection.

Type: Array of VpnStaticRoute objects

Required: No

state

The current state of the VPN connection.

Type: String

Valid Values: pending | available | deleting | deleted

Required: No

tagSet

Any tags assigned to the VPN connection.

Type: Array of Tag objects

Required: No

type

The type of VPN connection.

Type: String

Valid Values: ipsec.1

Required: No

vgwTelemetry

Information about the VPN tunnel.

Type: Array of VgwTelemetry objects

Required: No

vpnConnectionId

The ID of the VPN connection.

Type: String

Required: No

vpnGatewayId

The ID of the virtual private gateway at the AWS side of the VPN connection.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: