AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::EC2::ClientVpnEndpoint

CfnClientVpnEndpoint

Specifies a Client VPN endpoint. A Client VPN endpoint is the resource you create and configure to enable and manage client VPN sessions. It is the destination endpoint at which all client VPN sessions are terminated.

Import

import { CfnClientVpnEndpoint } from 'aws-cdk-lib/aws-ec2';

Or use the module namespace:

import * as ec2 from 'aws-cdk-lib/aws-ec2';
// ec2.CfnClientVpnEndpoint

Properties

Configuration passed to the constructor as CfnClientVpnEndpointProps.

authenticationOptionsRequired
IResolvable | IResolvable | ClientAuthenticationRequestProperty[]

Information about the authentication method to be used to authenticate clients.

connectionLogOptionsRequired
IResolvable | ConnectionLogOptionsProperty

Information about the client connection logging options. If you enable client connection logging, data about client connections is sent to a Cloudwatch Logs log stream. The following information is logged: - Client connection requests - Client connection results (successful and unsuccessful) - Reasons for unsuccessful client connection requests - Client connection termination time

serverCertificateArnRequired
string

The ARN of the server certificate. For more information, see the [Certificate Manager User Guide](https://docs.aws.amazon.com/acm/latest/userguide/) .

clientCidrBlockOptional
string

The IPv4 address range, in CIDR notation, from which to assign client IP addresses. The address range cannot overlap with the local CIDR of the VPC in which the associated subnet is located, or the routes that you add manually. The address range cannot be changed after the Client VPN endpoint has been created. Client CIDR range must have a size of at least /22 and must not be greater than /12.

clientConnectOptionsOptional
IResolvable | ClientConnectOptionsProperty

The options for managing connection authorization for new client connections.

clientLoginBannerOptionsOptional
IResolvable | ClientLoginBannerOptionsProperty

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

clientRouteEnforcementOptionsOptional
IResolvable | ClientRouteEnforcementOptionsProperty

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.

descriptionOptional
string

A brief description of the Client VPN endpoint.

disconnectOnSessionTimeoutOptional
boolean | IResolvable

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` .

dnsServersOptional
string[]

Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers. If no DNS server is specified, the DNS address configured on the device is used for the DNS server.

endpointIpAddressTypeOptional
string

The IP address type of the Client VPN endpoint. Possible values are `ipv4` for IPv4 addressing only, `ipv6` for IPv6 addressing only, or `dual-stack` for both IPv4 and IPv6 addressing.

securityGroupIdsOptional
string[]

The IDs of one or more security groups to apply to the target network. You must also specify the ID of the VPC that contains the security groups.

selfServicePortalOptional
string

Specify whether to enable the self-service portal for the Client VPN endpoint. Default Value: `enabled`

sessionTimeoutHoursOptional
number

The maximum VPN session duration time in hours. Valid values: `8 | 10 | 12 | 24` Default value: `24`

splitTunnelOptional
boolean | IResolvable

Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint. By default, split-tunnel on a VPN endpoint is disabled. For information about split-tunnel VPN endpoints, see [Split-tunnel AWS Client VPN endpoint](https://docs.aws.amazon.com/vpn/latest/clientvpn-admin/split-tunnel-vpn.html) in the *AWS Client VPN Administrator Guide* .

tagSpecificationsOptional
IResolvable | IResolvable | TagSpecificationProperty[]

The tags to apply to the Client VPN endpoint during creation.

trafficIpAddressTypeOptional
string

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.

transportProtocolOptional
string

The transport protocol to be used by the VPN session. Default value: `udp`

vpcIdOptional
string

The ID of the VPC to associate with the Client VPN endpoint. If no security group IDs are specified in the request, the default security group for the VPC is applied.

vpnPortOptional
number

The port number to assign to the Client VPN endpoint for TCP and UDP traffic. Valid Values: `443` | `1194` Default Value: `443`

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

Get the Amazon EC2 Cheat Sheet

Everything you need to know about Amazon EC2 on one page. HD quality, print-friendly.

Download Free Infographic