Skip to content

EC2  >  Structures  >  VpnConnection

VpnConnection

Structure Class

VpnConnection dataclass

Bases: _SerdeShape

Describes a VPN connection.

Attributes

category class-attribute instance-attribute
category: str | None = ...

The category of the VPN connection. A value of VPN indicates an Amazon Web Services VPN connection. A value of VPN-Classic indicates an Amazon Web Services Classic VPN connection.

core_network_arn class-attribute instance-attribute
core_network_arn: str | None = ...

The ARN of the core network.

core_network_attachment_arn class-attribute instance-attribute
core_network_attachment_arn: str | None = ...

The ARN of the core network attachment.

customer_gateway_configuration class-attribute instance-attribute
customer_gateway_configuration: str | None = ...

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.

customer_gateway_id class-attribute instance-attribute
customer_gateway_id: str | None = ...

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

gateway_association_state class-attribute instance-attribute
gateway_association_state: str | None = ...

The current state of the gateway association.

options class-attribute instance-attribute
options: VpnConnectionOptions | None = ...

The VPN connection options.

pre_shared_key_arn class-attribute instance-attribute
pre_shared_key_arn: str | None = ...

The Amazon Resource Name (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection.

routes class-attribute instance-attribute
routes: list[VpnStaticRoute] | None = ...

The static routes associated with the VPN connection.

state class-attribute instance-attribute
state: str | None = ...

The current state of the VPN connection.

tags class-attribute instance-attribute
tags: list[Tag] | None = ...

Any tags assigned to the VPN connection.

transit_gateway_id class-attribute instance-attribute
transit_gateway_id: str | None = ...

The ID of the transit gateway associated with the VPN connection.

type class-attribute instance-attribute
type: str | None = ...

The type of VPN connection.

vgw_telemetry class-attribute instance-attribute
vgw_telemetry: list[VgwTelemetry] | None = ...

Information about the VPN tunnel.

vpn_concentrator_id class-attribute instance-attribute
vpn_concentrator_id: str | None = ...

The ID of the VPN concentrator associated with the VPN connection.

vpn_connection_id class-attribute instance-attribute
vpn_connection_id: str | None = ...

The ID of the VPN connection.

vpn_gateway_id class-attribute instance-attribute
vpn_gateway_id: str | None = ...

The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.