Client VPN Endpoint

Client VPN Endpoint in AWS is a managed client-based VPN service that enables secure access to AWS resources and on-premises networks. It allows users to connect from any location using OpenVPN-based clients, providing encrypted communication over the internet. This resource supports authentication, authorization, and fine-grained access control, making it easier to extend private network access to remote users.

aws.ec2_client_vpn_endpoint

Fields

TitleIDTypeData TypeDescription
_keycorestring
account_idcorestring
associated_target_networkscorejsonInformation about the associated target networks. A target network is a subnet in a VPC.
authentication_optionscorejsonInformation about the authentication method used by the Client VPN endpoint.
client_cidr_blockcorestringThe IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
client_connect_optionscorejsonThe options for managing connection authorization for new client connections.
client_login_banner_optionscorejsonOptions for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
client_vpn_endpoint_arncorestring
client_vpn_endpoint_idcorestringThe ID of the Client VPN endpoint.
connection_log_optionscorejsonInformation about the client connection logging options for the Client VPN endpoint.
creation_timecorestringThe date and time the Client VPN endpoint was created.
deletion_timecorestringThe date and time the Client VPN endpoint was deleted, if applicable.
descriptioncorestringA brief description of the endpoint.
dns_namecorestringThe DNS name to be used by clients when connecting to the Client VPN endpoint.
dns_serverscorearray<string>Information about the DNS servers to be used for DNS resolution.
security_group_idscorearray<string>The IDs of the security groups for the target network.
self_service_portal_urlcorestringThe URL of the self-service portal.
server_certificate_arncorestringThe ARN of the server certificate.
session_timeout_hourscoreint64The maximum VPN session duration time in hours. Valid values: 8 | 10 | 12 | 24 Default value: 24
split_tunnelcoreboolIndicates 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.
statuscorejsonThe current state of the Client VPN endpoint.
tagscorehstore
transport_protocolcorestringThe transport protocol used by the Client VPN endpoint.
vpc_idcorestringThe ID of the VPC.
vpn_portcoreint64The port number for the Client VPN endpoint.
vpn_protocolcorestringThe protocol used by the VPN session.