ClientVpnEndpoint

Describes a Client VPN endpoint.

associatedTargetNetwork

This member has been deprecated.

Information about the associated target networks. A target network is a subnet in a VPC.

Type: Array of AssociatedTargetNetwork objects

Required: No

authenticationOptions

Information about the authentication method used by the Client VPN endpoint.

Type: Array of ClientVpnAuthentication objects

Required: No

clientCidrBlock

The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.

Type: String

Required: No

clientConnectOptions

The options for managing connection authorization for new client connections.

Type: ClientConnectResponseOptions object

Required: No

clientLoginBannerOptions

Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.

Type: ClientLoginBannerResponseOptions object

Required: No

clientVpnEndpointId

The ID of the Client VPN endpoint.

Type: String

Required: No

connectionLogOptions

Information about the client connection logging options for the Client VPN endpoint.

Type: ConnectionLogResponseOptions object

Required: No

creationTime

The date and time the Client VPN endpoint was created.

Type: String

Required: No

deletionTime

The date and time the Client VPN endpoint was deleted, if applicable.

Type: String

Required: No

description

A brief description of the endpoint.

Type: String

Required: No

dnsName

The DNS name to be used by clients when connecting to the Client VPN endpoint.

Type: String

Required: No

dnsServer

Information about the DNS servers to be used for DNS resolution.

Type: Array of strings

Required: No

securityGroupIdSet

The IDs of the security groups for the target network.

Type: Array of strings

Required: No

selfServicePortalUrl

The URL of the self-service portal.

Type: String

Required: No

serverCertificateArn

The ARN of the server certificate.

Type: String

Required: No

sessionTimeoutHours

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

Type: Integer

Required: No

splitTunnel

Indicates whether split-tunnel is enabled in the AWS Client VPN endpoint.

For information about split-tunnel VPN endpoints, see Split-Tunnel AWS Client VPN endpoint in the AWS Client VPN Administrator Guide.

Type: Boolean

Required: No

status

The current state of the Client VPN endpoint.

Type: ClientVpnEndpointStatus object

Required: No

tagSet

Any tags assigned to the Client VPN endpoint.

Type: Array of Tag objects

Required: No

transportProtocol

The transport protocol used by the Client VPN endpoint.

Type: String

Valid Values: tcp | udp

Required: No

vpcId

The ID of the VPC.

Type: String

Required: No

vpnPort

The port number for the Client VPN endpoint.

Type: Integer

Required: No

vpnProtocol

The protocol used by the VPN session.

Type: String

Valid Values: openvpn

Required: No

ClientVpnEndpoint

Contents

See Also