Skip to content

ClientVpnRoute

Source code in docs_src/capo_ec2/types/client_vpn_route.py
class ClientVpnRoute(TypedDict, closed=True):
    client_vpn_endpoint_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the Client VPN endpoint with which the route is associated.</p>"""
    destination_cidr: NotRequired["capo_ec2.types.string.String"]
    """<p>The IPv4 address range, in CIDR notation, of the route destination.</p>"""
    target_subnet: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the subnet through which traffic is routed.</p>"""
    type: NotRequired["capo_ec2.types.string.String"]
    """<p>The route type.</p>"""
    origin: NotRequired["capo_ec2.types.string.String"]
    """<p>Indicates how the route was associated with the Client VPN endpoint. <code>associate</code> indicates that the route was automatically added when the target network was associated with the Client VPN endpoint. <code>add-route</code> indicates that the route was manually added using the <b>CreateClientVpnRoute</b> action.</p>"""
    status: NotRequired["capo_ec2.types.client_vpn_route_status.ClientVpnRouteStatus"]
    """<p>The current state of the route.</p>"""
    description: NotRequired["capo_ec2.types.string.String"]
    """<p>A brief description of the route.</p>"""
    transit_gateway_attachment_id: NotRequired[
        "capo_ec2.types.transit_gateway_attachment_id.TransitGatewayAttachmentId"
    ]
    """<p>The ID of the Transit Gateway attachment, if the route targets a Transit Gateway.</p>"""

client_vpn_endpoint_id instance-attribute

client_vpn_endpoint_id: NotRequired[String]

The ID of the Client VPN endpoint with which the route is associated.

description instance-attribute

description: NotRequired[String]

A brief description of the route.

destination_cidr instance-attribute

destination_cidr: NotRequired[String]

The IPv4 address range, in CIDR notation, of the route destination.

origin instance-attribute

origin: NotRequired[String]

Indicates how the route was associated with the Client VPN endpoint. associate indicates that the route was automatically added when the target network was associated with the Client VPN endpoint. add-route indicates that the route was manually added using the CreateClientVpnRoute action.

status instance-attribute

status: NotRequired[ClientVpnRouteStatus]

The current state of the route.

target_subnet instance-attribute

target_subnet: NotRequired[String]

The ID of the subnet through which traffic is routed.

transit_gateway_attachment_id instance-attribute

transit_gateway_attachment_id: NotRequired[TransitGatewayAttachmentId]

The ID of the Transit Gateway attachment, if the route targets a Transit Gateway.

type instance-attribute

type: NotRequired[String]

The route type.