AwsEc2ClientVpnEndpointDetails
Describes an AWS Client VPN endpoint. A Client VPN endpoint is the resource that you create and configure to enable and manage client VPN sessions. It's the termination point for all client VPN sessions.
Contents
- AuthenticationOptions
-
Information about the authentication method used by the Client VPN endpoint.
Type: Array of AwsEc2ClientVpnEndpointAuthenticationOptionsDetails objects
Required: No
- ClientCidrBlock
-
The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
Type: String
Pattern:
.*\S.*Required: No
- ClientConnectOptions
-
The options for managing connection authorization for new client connections.
Type: AwsEc2ClientVpnEndpointClientConnectOptionsDetails 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: AwsEc2ClientVpnEndpointClientLoginBannerOptionsDetails object
Required: No
- ClientVpnEndpointId
-
The ID of the Client VPN endpoint.
Type: String
Pattern:
.*\S.*Required: No
- ConnectionLogOptions
-
Information about the client connection logging options for the Client VPN endpoint.
Type: AwsEc2ClientVpnEndpointConnectionLogOptionsDetails object
Required: No
- Description
-
A brief description of the endpoint.
Type: String
Pattern:
.*\S.*Required: No
- DnsServer
-
Information about the DNS servers to be used for DNS resolution.
Type: Array of strings
Pattern:
.*\S.*Required: No
- SecurityGroupIdSet
-
The IDs of the security groups for the target network.
Type: Array of strings
Pattern:
.*\S.*Required: No
- SelfServicePortalUrl
-
The URL of the self-service portal.
Type: String
Pattern:
.*\S.*Required: No
- ServerCertificateArn
-
The Amazon Resource Name (ARN) of the server certificate.
Type: String
Pattern:
.*\S.*Required: No
- SessionTimeoutHours
-
The maximum VPN session duration time in hours.
Type: Integer
Required: No
- SplitTunnel
-
Indicates whether split-tunnel is enabled in the AWS Client VPN endpoint.
Type: Boolean
Required: No
- TransportProtocol
-
The transport protocol used by the Client VPN endpoint.
Type: String
Pattern:
.*\S.*Required: No
- VpcId
-
The ID of the VPC.
Type: String
Pattern:
.*\S.*Required: No
- VpnPort
-
The port number for the Client VPN endpoint.
Type: Integer
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
