interface CfnClientVpnEndpointProps

Language	Type name
.NET	`Amazon.CDK.AWS.EC2.CfnClientVpnEndpointProps`
Java	`software.amazon.awscdk.services.ec2.CfnClientVpnEndpointProps`
Python	`aws_cdk.aws_ec2.CfnClientVpnEndpointProps`
TypeScript	`@aws-cdk/aws-ec2` » `CfnClientVpnEndpointProps`

Properties for defining a CfnClientVpnEndpoint.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ec2 from '@aws-cdk/aws-ec2';
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',
    },
  }],
  clientCidrBlock: 'clientCidrBlock',
  connectionLogOptions: {
    enabled: false,

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

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

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

    // the properties below are optional
    bannerText: 'bannerText',
  },
  description: 'description',
  dnsServers: ['dnsServers'],
  securityGroupIds: ['securityGroupIds'],
  selfServicePortal: 'selfServicePortal',
  sessionTimeoutHours: 123,
  splitTunnel: false,
  tagSpecifications: [{
    resourceType: 'resourceType',
    tags: [{
      key: 'key',
      value: 'value',
    }],
  }],
  transportProtocol: 'transportProtocol',
  vpcId: 'vpcId',
  vpnPort: 123,
};

Properties

Name	Type	Description
authenticationOptions	`IResolvable` `\|` `IResolvable` `\|` `ClientAuthenticationRequestProperty[]`	Information about the authentication method to be used to authenticate clients.
clientCidrBlock	`string`	The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
connectionLogOptions	`IResolvable` `\|` `ConnectionLogOptionsProperty`	Information about the client connection logging options.
serverCertificateArn	`string`	The ARN of the server certificate.
clientConnectOptions?	`IResolvable` `\|` `ClientConnectOptionsProperty`	The options for managing connection authorization for new client connections.
clientLoginBannerOptions?	`IResolvable` `\|` `ClientLoginBannerOptionsProperty`	Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
description?	`string`	A brief description of the Client VPN endpoint.
dnsServers?	`string[]`	Information about the DNS servers to be used for DNS resolution.
securityGroupIds?	`string[]`	The IDs of one or more security groups to apply to the target network.
selfServicePortal?	`string`	Specify whether to enable the self-service portal for the Client VPN endpoint.
sessionTimeoutHours?	`number`	The maximum VPN session duration time in hours.
splitTunnel?	`boolean \|` `IResolvable`	Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
tagSpecifications?	`IResolvable` `\|` `IResolvable` `\|` `TagSpecificationProperty[]`	The tags to apply to the Client VPN endpoint during creation.
transportProtocol?	`string`	The transport protocol to be used by the VPN session.
vpcId?	`string`	The ID of the VPC to associate with the Client VPN endpoint.
vpnPort?	`number`	The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

authenticationOptions

Type: IResolvable | IResolvable | ClientAuthenticationRequestProperty[]

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

clientCidrBlock

Type: 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.

connectionLogOptions

Type: 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

serverCertificateArn

Type: string

The ARN of the server certificate.

For more information, see the AWS Certificate Manager User Guide .

clientConnectOptions?

Type: IResolvable | ClientConnectOptionsProperty (optional)

The options for managing connection authorization for new client connections.

clientLoginBannerOptions?

Type: IResolvable | ClientLoginBannerOptionsProperty (optional)

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

description?

Type: string (optional)

A brief description of the Client VPN endpoint.

dnsServers?

Type: string[] (optional)

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.

securityGroupIds?

Type: string[] (optional)

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.

selfServicePortal?

Type: string (optional)

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

Default Value: enabled

sessionTimeoutHours?

Type: number (optional)

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

splitTunnel?

Type: boolean | IResolvable (optional)

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 in the AWS Client VPN Administrator Guide .

tagSpecifications?

Type: IResolvable | IResolvable | TagSpecificationProperty[] (optional)

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

transportProtocol?

Type: string (optional)

The transport protocol to be used by the VPN session.

Default value: udp

vpcId?

Type: string (optional)

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.

vpnPort?

Type: number (optional)

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

Valid Values: 443 | 1194

Default Value: 443