AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

ClientVpnEndpoint

A client VPN connection.

Import

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

Or use the module namespace:

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

Properties

Configuration passed to the constructor as ClientVpnEndpointProps.

vpcRequired
IVpc

The VPC to connect to.

21 properties inherited from ClientVpnEndpointOptions
cidrRequiredinherited from ClientVpnEndpointOptions
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. Changing the address range will replace the Client VPN endpoint. The CIDR block should be /22 or greater.

serverCertificateArnRequiredinherited from ClientVpnEndpointOptions
string

The ARN of the server certificate.

authorizeAllUsersToVpcCidrOptionalinherited from ClientVpnEndpointOptions
boolean

Whether to authorize all users to the VPC CIDR. This automatically creates an authorization rule. Set this to `false` and use `addAuthorizationRule()` to create your own rules instead.

Default: true

clientCertificateArnOptionalinherited from ClientVpnEndpointOptions
string

The ARN of the client certificate for mutual authentication. The certificate must be signed by a certificate authority (CA) and it must be provisioned in AWS Certificate Manager (ACM).

Default: - use user-based authentication

clientConnectionHandlerOptionalinherited from ClientVpnEndpointOptions
IClientVpnConnectionHandler

The AWS Lambda function used for connection authorization. The name of the Lambda function must begin with the `AWSClientVPN-` prefix

Default: - no connection handler

clientLoginBannerOptionalinherited from ClientVpnEndpointOptions
string

Customizable text that will be displayed in a banner on AWS provided clients when a VPN session is established. UTF-8 encoded characters only. Maximum of 1400 characters.

Default: - no banner is presented to the client

clientRouteEnforcementOptionsOptionalinherited from ClientVpnEndpointOptions
ClientRouteEnforcementOptions

Options for Client Route Enforcement. Client Route Enforcement is a feature of Client VPN that helps enforce administrator defined routes on devices connected through the VPN. This feature helps improve your security posture by ensuring that network traffic originating from a connected client is not inadvertently sent outside the VPN tunnel.

Default: undefined - AWS Client VPN default setting is disable client route enforcement

descriptionOptionalinherited from ClientVpnEndpointOptions
string

A brief description of the Client VPN endpoint.

Default: - no description

disconnectOnSessionTimeoutOptionalinherited from ClientVpnEndpointOptions
boolean

Indicates whether the client VPN session is disconnected after the maximum `sessionTimeout` is reached. If `true`, users are prompted to reconnect client VPN. If `false`, client VPN attempts to reconnect automatically.

Default: undefined - AWS Client VPN default is true

dnsServersOptionalinherited from ClientVpnEndpointOptions
string[]

Information about the DNS servers to be used for DNS resolution. A Client VPN endpoint can have up to two DNS servers.

Default: - use the DNS address configured on the device

loggingOptionalinherited from ClientVpnEndpointOptions
boolean

Whether to enable connections logging.

Default: true

logGroupOptionalinherited from ClientVpnEndpointOptions
ILogGroupRef

A CloudWatch Logs log group for connection logging.

Default: - a new group is created

logStreamOptionalinherited from ClientVpnEndpointOptions
ILogStreamRef

A CloudWatch Logs log stream for connection logging.

Default: - a new stream is created

portOptionalinherited from ClientVpnEndpointOptions
VpnPort

The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Default: VpnPort.HTTPS

securityGroupsOptionalinherited from ClientVpnEndpointOptions
ISecurityGroup[]

The security groups to apply to the target network.

Default: - a new security group is created

selfServicePortalOptionalinherited from ClientVpnEndpointOptions
boolean

Specify whether to enable the self-service portal for the Client VPN endpoint.

Default: true

sessionTimeoutOptionalinherited from ClientVpnEndpointOptions
ClientVpnSessionTimeout

The maximum VPN session duration time.

Default: ClientVpnSessionTimeout.TWENTY_FOUR_HOURS

splitTunnelOptionalinherited from ClientVpnEndpointOptions
boolean

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

Default: false

transportProtocolOptionalinherited from ClientVpnEndpointOptions
TransportProtocol

The transport protocol to be used by the VPN session.

Default: TransportProtocol.UDP

userBasedAuthenticationOptionalinherited from ClientVpnEndpointOptions
ClientVpnUserBasedAuthentication

The type of user-based authentication to use.

Default: - use mutual authentication

vpcSubnetsOptionalinherited from ClientVpnEndpointOptions
SubnetSelection

Subnets to associate to the client VPN endpoint.

Default: - the VPC default strategy

Get the Amazon EC2 Cheat Sheet

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

Download Free Infographic