Skip to content

VpnConnection

Source code in docs_src/capo_ec2/types/vpn_connection.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
class VpnConnection(TypedDict, closed=True):
    category: NotRequired["capo_ec2.types.string.String"]
    """<p>The category of the VPN connection. A value of <code>VPN</code> indicates an Amazon Web Services VPN connection. A value of <code>VPN-Classic</code> indicates an Amazon Web Services Classic VPN connection.</p>"""
    transit_gateway_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the transit gateway associated with the VPN connection.</p>"""
    vpn_concentrator_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the VPN concentrator associated with the VPN connection.</p>"""
    core_network_arn: NotRequired["capo_ec2.types.string.String"]
    """<p>The ARN of the core network.</p>"""
    core_network_attachment_arn: NotRequired["capo_ec2.types.string.String"]
    """<p>The ARN of the core network attachment.</p>"""
    gateway_association_state: NotRequired[
        "capo_ec2.types.gateway_association_state.GatewayAssociationState"
    ]
    """<p>The current state of the gateway association.</p>"""
    options: NotRequired["capo_ec2.types.vpn_connection_options.VpnConnectionOptions"]
    """<p>The VPN connection options.</p>"""
    routes: NotRequired["capo_ec2.types.vpn_static_route_list.VpnStaticRouteList"]
    """<p>The static routes associated with the VPN connection.</p>"""
    tags: NotRequired["capo_ec2.types.tag_list.TagList"]
    """<p>Any tags assigned to the VPN connection.</p>"""
    vgw_telemetry: NotRequired["capo_ec2.types.vgw_telemetry_list.VgwTelemetryList"]
    """<p>Information about the VPN tunnel.</p>"""
    pre_shared_key_arn: NotRequired["capo_ec2.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the Secrets Manager secret storing the pre-shared key(s) for the VPN connection.</p>"""
    vpn_connection_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the VPN connection.</p>"""
    state: NotRequired["capo_ec2.types.vpn_state.VpnState"]
    """<p>The current state of the VPN connection.</p>"""
    customer_gateway_configuration: NotRequired[
        "capo_ec2.types.customer_gateway_configuration.customerGatewayConfiguration"
    ]
    """<p>The configuration information for the VPN connection's customer gateway (in the native XML format). This element is always present in the <a>CreateVpnConnection</a> response; however, it's present in the <a>DescribeVpnConnections</a> response only if the VPN connection is in the <code>pending</code> or <code>available</code> state.</p>"""
    type: NotRequired["capo_ec2.types.gateway_type.GatewayType"]
    """<p>The type of VPN connection.</p>"""
    customer_gateway_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the customer gateway at your end of the VPN connection.</p>"""
    vpn_gateway_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the virtual private gateway at the Amazon Web Services side of the VPN connection.</p>"""

category instance-attribute 

category: NotRequired[String]

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 instance-attribute 

core_network_arn: NotRequired[String]

The ARN of the core network.

core_network_attachment_arn instance-attribute 

core_network_attachment_arn: NotRequired[String]

The ARN of the core network attachment.

customer_gateway_configuration instance-attribute 

customer_gateway_configuration: NotRequired[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.

customer_gateway_id instance-attribute 

customer_gateway_id: NotRequired[String]

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

gateway_association_state instance-attribute 

gateway_association_state: NotRequired[GatewayAssociationState]

The current state of the gateway association.

options instance-attribute 

options: NotRequired[VpnConnectionOptions]

The VPN connection options.

pre_shared_key_arn instance-attribute 

pre_shared_key_arn: NotRequired[String]

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

routes instance-attribute 

routes: NotRequired[VpnStaticRouteList]

The static routes associated with the VPN connection.

state instance-attribute 

state: NotRequired[VpnState]

The current state of the VPN connection.

tags instance-attribute 

tags: NotRequired[TagList]

Any tags assigned to the VPN connection.

transit_gateway_id instance-attribute 

transit_gateway_id: NotRequired[String]

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

type instance-attribute 

type: NotRequired[GatewayType]

The type of VPN connection.

vgw_telemetry instance-attribute 

vgw_telemetry: NotRequired[VgwTelemetryList]

Information about the VPN tunnel.

vpn_concentrator_id instance-attribute 

vpn_concentrator_id: NotRequired[String]

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

vpn_connection_id instance-attribute 

vpn_connection_id: NotRequired[String]

The ID of the VPN connection.

vpn_gateway_id instance-attribute 

vpn_gateway_id: NotRequired[String]

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