Skip to content

ClientVpnConnection

Source code in docs_src/capo_ec2/types/client_vpn_connection.py
class ClientVpnConnection(TypedDict, closed=True):
    client_vpn_endpoint_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the Client VPN endpoint to which the client is connected.</p>"""
    timestamp: NotRequired["capo_ec2.types.string.String"]
    """<p>The current date and time.</p>"""
    connection_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the client connection.</p>"""
    username: NotRequired["capo_ec2.types.string.String"]
    """<p>The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used.</p>"""
    connection_established_time: NotRequired["capo_ec2.types.string.String"]
    """<p>The date and time the client connection was established.</p>"""
    ingress_bytes: NotRequired["capo_ec2.types.string.String"]
    """<p>The number of bytes sent by the client.</p>"""
    egress_bytes: NotRequired["capo_ec2.types.string.String"]
    """<p>The number of bytes received by the client.</p>"""
    ingress_packets: NotRequired["capo_ec2.types.string.String"]
    """<p>The number of packets sent by the client.</p>"""
    egress_packets: NotRequired["capo_ec2.types.string.String"]
    """<p>The number of packets received by the client.</p>"""
    client_ip: NotRequired["capo_ec2.types.string.String"]
    """<p>The IP address of the client.</p>"""
    client_ipv6_address: NotRequired["capo_ec2.types.string.String"]
    """<p>The IPv6 address assigned to the client connection when using a dual-stack Client VPN endpoint. This field is only populated when the endpoint is configured for dual-stack addressing, and the client is using IPv6 for connectivity.</p>"""
    common_name: NotRequired["capo_ec2.types.string.String"]
    """<p>The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name.</p>"""
    status: NotRequired[
        "capo_ec2.types.client_vpn_connection_status.ClientVpnConnectionStatus"
    ]
    """<p>The current state of the client connection.</p>"""
    connection_end_time: NotRequired["capo_ec2.types.string.String"]
    """<p>The date and time the client connection was terminated.</p>"""
    posture_compliance_statuses: NotRequired[
        "capo_ec2.types.value_string_list.ValueStringList"
    ]
    """<p>The statuses returned by the client connect handler for posture compliance, if applicable.</p>"""
    authorization_policy_last_evaluated_time: NotRequired[
        "capo_ec2.types.string.String"
    ]
    """<p>The date and time the authorization policy was last evaluated for the client connection, if applicable.</p>"""

authorization_policy_last_evaluated_time instance-attribute

authorization_policy_last_evaluated_time: NotRequired[String]

The date and time the authorization policy was last evaluated for the client connection, if applicable.

client_ip instance-attribute

client_ip: NotRequired[String]

The IP address of the client.

client_ipv6_address instance-attribute

client_ipv6_address: NotRequired[String]

The IPv6 address assigned to the client connection when using a dual-stack Client VPN endpoint. This field is only populated when the endpoint is configured for dual-stack addressing, and the client is using IPv6 for connectivity.

client_vpn_endpoint_id instance-attribute

client_vpn_endpoint_id: NotRequired[String]

The ID of the Client VPN endpoint to which the client is connected.

common_name instance-attribute

common_name: NotRequired[String]

The common name associated with the client. This is either the name of the client certificate, or the Active Directory user name.

connection_end_time instance-attribute

connection_end_time: NotRequired[String]

The date and time the client connection was terminated.

connection_established_time instance-attribute

connection_established_time: NotRequired[String]

The date and time the client connection was established.

connection_id instance-attribute

connection_id: NotRequired[String]

The ID of the client connection.

egress_bytes instance-attribute

egress_bytes: NotRequired[String]

The number of bytes received by the client.

egress_packets instance-attribute

egress_packets: NotRequired[String]

The number of packets received by the client.

ingress_bytes instance-attribute

ingress_bytes: NotRequired[String]

The number of bytes sent by the client.

ingress_packets instance-attribute

ingress_packets: NotRequired[String]

The number of packets sent by the client.

posture_compliance_statuses instance-attribute

posture_compliance_statuses: NotRequired[ValueStringList]

The statuses returned by the client connect handler for posture compliance, if applicable.

status instance-attribute

status: NotRequired[ClientVpnConnectionStatus]

The current state of the client connection.

timestamp instance-attribute

timestamp: NotRequired[String]

The current date and time.

username instance-attribute

username: NotRequired[String]

The username of the client who established the client connection. This information is only provided if Active Directory client authentication is used.