ClientVpnEndpoint¶
Structure Class¶
dataclass
¶
Bases: _SerdeShape
Describes a Client VPN endpoint.
Attributes¶
class-attribute
instance-attribute
¶
associated_target_networks: list[AssociatedTargetNetwork] | None = ...
Information about the associated target networks. A target network is a subnet in a VPC.
class-attribute
instance-attribute
¶
authentication_options: list[ClientVpnAuthentication] | None = ...
Information about the authentication method used by the Client VPN endpoint.
class-attribute
instance-attribute
¶
client_cidr_block: str | None = ...
The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
class-attribute
instance-attribute
¶
client_connect_options: ClientConnectResponseOptions | None = ...
The options for managing connection authorization for new client connections.
class-attribute
instance-attribute
¶
client_login_banner_options: ClientLoginBannerResponseOptions | None = ...
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
class-attribute
instance-attribute
¶
client_route_enforcement_options: ClientRouteEnforcementResponseOptions | None = ...
Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. T his feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.
Client route enforcement works by monitoring the route table of a connected device for routing policy changes to the VPN connection. If the feature detects any VPN routing policy modifications, it will automatically force an update to the route table, reverting it back to the expected route configurations.
class-attribute
instance-attribute
¶
client_vpn_endpoint_id: str | None = ...
The ID of the Client VPN endpoint.
class-attribute
instance-attribute
¶
connection_log_options: ConnectionLogResponseOptions | None = ...
Information about the client connection logging options for the Client VPN endpoint.
class-attribute
instance-attribute
¶
creation_time: str | None = ...
The date and time the Client VPN endpoint was created.
class-attribute
instance-attribute
¶
deletion_time: str | None = ...
The date and time the Client VPN endpoint was deleted, if applicable.
class-attribute
instance-attribute
¶
description: str | None = ...
A brief description of the endpoint.
class-attribute
instance-attribute
¶
device_posture_options: DevicePostureResponseOptions | None = ...
The device trust providers configured for the Client VPN endpoint, if applicable.
class-attribute
instance-attribute
¶
disconnect_on_session_timeout: bool | None = ...
Indicates whether the client VPN session is disconnected after the
maximum sessionTimeoutHours is reached. If true, users are prompted
to reconnect client VPN. If false, client VPN attempts to reconnect
automatically. The default value is true.
class-attribute
instance-attribute
¶
dns_name: str | None = ...
The DNS name to be used by clients when connecting to the Client VPN endpoint.
class-attribute
instance-attribute
¶
Information about the DNS servers to be used for DNS resolution.
class-attribute
instance-attribute
¶
endpoint_ip_address_type: str | None = ...
The IP address type of the Client VPN endpoint. Possible values are
ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only, or
dual-stackfor both IPv4 and IPv6 addressing.
class-attribute
instance-attribute
¶
The IDs of the security groups for the target network.
class-attribute
instance-attribute
¶
self_service_portal_url: str | None = ...
The URL of the self-service portal.
class-attribute
instance-attribute
¶
server_certificate_arn: str | None = ...
The ARN of the server certificate.
class-attribute
instance-attribute
¶
session_timeout_hours: int | None = ...
The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
class-attribute
instance-attribute
¶
split_tunnel: bool | None = ...
Indicates whether split-tunnel is enabled in the Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
class-attribute
instance-attribute
¶
status: ClientVpnEndpointStatus | None = ...
The current state of the Client VPN endpoint.
class-attribute
instance-attribute
¶
Any tags assigned to the Client VPN endpoint.
class-attribute
instance-attribute
¶
traffic_ip_address_type: str | None = ...
The IP address type of the Client VPN endpoint. Possible values are
either ipv4 for IPv4 addressing only, ipv6 for IPv6 addressing only,
or dual-stack for both IPv4 and IPv6 addressing.
class-attribute
instance-attribute
¶
transit_gateway_configuration: TransitGatewayConfigurationDescribeEndpointStructure | None = ...
The Transit Gateway configuration for the Client VPN endpoint.
class-attribute
instance-attribute
¶
transport_protocol: str | None = ...
The transport protocol used by the Client VPN endpoint.