aws-cdk-lib.aws_ec2.CfnClientVpnEndpointProps

CfnClientVpnEndpointProps Struct

Properties for defining a CfnClientVpnEndpoint.

Source

Generated code

Type last changed

v2.253.0 · 6 May 2026

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnClientVpnEndpointProps: ec2.CfnClientVpnEndpointProps = {
  authenticationOptions: [{
    type: 'type',

    // the properties below are optional
    activeDirectory: {
      directoryId: 'directoryId',
    },
    federatedAuthentication: {
      samlProviderArn: 'samlProviderArn',

      // the properties below are optional
      selfServiceSamlProviderArn: 'selfServiceSamlProviderArn',
    },
    mutualAuthentication: {
      clientRootCertificateChainArn: 'clientRootCertificateChainArn',
    },
  }],
  connectionLogOptions: {
    enabled: false,

    // the properties below are optional
    cloudwatchLogGroup: 'cloudwatchLogGroup',
    cloudwatchLogStream: 'cloudwatchLogStream',
  },
  serverCertificateArn: 'serverCertificateArn',

  // the properties below are optional
  clientCidrBlock: 'clientCidrBlock',
  clientConnectOptions: {
    enabled: false,

    // the properties below are optional
    lambdaFunctionArn: 'lambdaFunctionArn',
  },
  clientLoginBannerOptions: {
    enabled: false,

    // the properties below are optional
    bannerText: 'bannerText',
  },
  clientRouteEnforcementOptions: {
    enforced: false,
  },
  description: 'description',
  disconnectOnSessionTimeout: false,
  dnsServers: ['dnsServers'],
  endpointIpAddressType: 'endpointIpAddressType',
  securityGroupIds: ['securityGroupIds'],
  selfServicePortal: 'selfServicePortal',
  sessionTimeoutHours: 123,
  splitTunnel: false,
  tagSpecifications: [{
    resourceType: 'resourceType',
    tags: [{
      key: 'key',
      value: 'value',
    }],
  }],
  trafficIpAddressType: 'trafficIpAddressType',
  transitGatewayConfiguration: {
    transitGatewayId: 'transitGatewayId',

    // the properties below are optional
    availabilityZoneIds: ['availabilityZoneIds'],
    availabilityZones: ['availabilityZones'],
  },
  transportProtocol: 'transportProtocol',
  vpcId: 'vpcId',
  vpnPort: 123,
};

Properties

authenticationOptionsIResolvable | IResolvable | CfnClientVpnEndpoint.ClientAuthenticationRequestProperty[]authentication_optionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ClientAuthenticationRequestProperty]]]authenticationOptionsIResolvableAuthenticationOptionsIResolvableAuthenticationOptionsinterface{}required#

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

clientCidrBlockstringclient_cidr_blockstrclientCidrBlockStringClientCidrBlockstringClientCidrBlock*string#

The IPv4 address range, in CIDR notation, from which to assign client IP addresses.

notes

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.

clientConnectOptionsIResolvable | CfnClientVpnEndpoint.ClientConnectOptionsPropertyclient_connect_optionstyping.Union[IResolvable, ClientConnectOptionsProperty]clientConnectOptionsIResolvableClientConnectOptionsIResolvableClientConnectOptionsinterface{}#

The options for managing connection authorization for new client connections.

clientLoginBannerOptionsIResolvable | CfnClientVpnEndpoint.ClientLoginBannerOptionsPropertyclient_login_banner_optionstyping.Union[IResolvable, ClientLoginBannerOptionsProperty]clientLoginBannerOptionsIResolvableClientLoginBannerOptionsIResolvableClientLoginBannerOptionsinterface{}#

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

clientRouteEnforcementOptionsIResolvable | CfnClientVpnEndpoint.ClientRouteEnforcementOptionsPropertyclient_route_enforcement_optionstyping.Union[IResolvable, ClientRouteEnforcementOptionsProperty]clientRouteEnforcementOptionsIResolvableClientRouteEnforcementOptionsIResolvableClientRouteEnforcementOptionsinterface{}#

Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN.

notes

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.

connectionLogOptionsIResolvable | CfnClientVpnEndpoint.ConnectionLogOptionsPropertyconnection_log_optionstyping.Union[IResolvable, ConnectionLogOptionsProperty]connectionLogOptionsIResolvableConnectionLogOptionsIResolvableConnectionLogOptionsinterface{}required#

Information about the client connection logging options.

notes

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

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#

A brief description of the Client VPN endpoint.

disconnectOnSessionTimeoutboolean | IResolvabledisconnect_on_session_timeouttyping.Union[bool, IResolvable]disconnectOnSessionTimeoutBooleanDisconnectOnSessionTimeoutboolDisconnectOnSessionTimeoutinterface{}#

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 .

dnsServersstring[]dns_serverstyping.List[str]dnsServersList<String>DnsServersstring[]DnsServers*[]*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.

endpointIpAddressTypestringendpoint_ip_address_typestrendpointIpAddressTypeStringEndpointIpAddressTypestringEndpointIpAddressType*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.

securityGroupIdsstring[]security_group_idstyping.List[str]securityGroupIdsList<String>SecurityGroupIdsstring[]SecurityGroupIds*[]*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.

selfServicePortalstringself_service_portalstrselfServicePortalStringSelfServicePortalstringSelfServicePortal*string#

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

Default Value: enabled

serverCertificateArnstringserver_certificate_arnstrserverCertificateArnStringServerCertificateArnstringServerCertificateArn*stringrequired#

The ARN of the server certificate.

For more information, see the Certificate Manager User Guide .

sessionTimeoutHoursnumbersession_timeout_hoursint | floatsessionTimeoutHoursNumberSessionTimeoutHoursdoubleSessionTimeoutHours*float64#

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

splitTunnelboolean | IResolvablesplit_tunneltyping.Union[bool, IResolvable]splitTunnelBooleanSplitTunnelboolSplitTunnelinterface{}#

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

notes

By default, split-tunnel on a VPN endpoint is disabled.

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

tagSpecificationsIResolvable | IResolvable | CfnClientVpnEndpoint.TagSpecificationProperty[]tag_specificationstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, TagSpecificationProperty]]]tagSpecificationsIResolvableTagSpecificationsIResolvableTagSpecificationsinterface{}#

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

trafficIpAddressTypestringtraffic_ip_address_typestrtrafficIpAddressTypeStringTrafficIpAddressTypestringTrafficIpAddressType*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.

transitGatewayConfigurationIResolvable | CfnClientVpnEndpoint.TransitGatewayConfigurationPropertytransit_gateway_configurationtyping.Union[IResolvable, TransitGatewayConfigurationProperty]transitGatewayConfigurationIResolvableTransitGatewayConfigurationIResolvableTransitGatewayConfigurationinterface{}#

transportProtocolstringtransport_protocolstrtransportProtocolStringTransportProtocolstringTransportProtocol*string#

The transport protocol to be used by the VPN session.

Default value: udp

vpcIdstringvpc_idstrvpcIdStringVpcIdstringVpcId*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.

vpnPortnumbervpn_portint | floatvpnPortNumberVpnPortdoubleVpnPort*float64#

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

Valid Values: 443 | 1194

Default Value: 443

Used as props by

• CfnClientVpnEndpoint