Package software.amazon.awscdk.services.ec2

Class CfnClientVpnEndpoint.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.CfnClientVpnEndpoint.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnClientVpnEndpoint>

Enclosing class:

CfnClientVpnEndpoint

@Stability(Stable)
public static final class CfnClientVpnEndpoint.Builder
extends Object
implements software.amazon.jsii.Builder<CfnClientVpnEndpoint>

A fluent builder for CfnClientVpnEndpoint.

Method Summary

Modifier and Type	Method	Description
CfnClientVpnEndpoint.Builder	authenticationOptions(List<? extends Object> authenticationOptions)	Information about the authentication method to be used to authenticate clients.
CfnClientVpnEndpoint.Builder	authenticationOptions(IResolvable authenticationOptions)	Information about the authentication method to be used to authenticate clients.
CfnClientVpnEndpoint	build()
CfnClientVpnEndpoint.Builder	clientCidrBlock(String clientCidrBlock)	The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
CfnClientVpnEndpoint.Builder	clientConnectOptions(IResolvable clientConnectOptions)	The options for managing connection authorization for new client connections.
CfnClientVpnEndpoint.Builder	clientConnectOptions(CfnClientVpnEndpoint.ClientConnectOptionsProperty clientConnectOptions)	The options for managing connection authorization for new client connections.
CfnClientVpnEndpoint.Builder	clientLoginBannerOptions(IResolvable clientLoginBannerOptions)	Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
CfnClientVpnEndpoint.Builder	clientLoginBannerOptions(CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty clientLoginBannerOptions)	Options for enabling a customizable text banner that will be displayed on AWS provided clients when a VPN session is established.
CfnClientVpnEndpoint.Builder	connectionLogOptions(IResolvable connectionLogOptions)	Information about the client connection logging options.
CfnClientVpnEndpoint.Builder	connectionLogOptions(CfnClientVpnEndpoint.ConnectionLogOptionsProperty connectionLogOptions)	Information about the client connection logging options.
static CfnClientVpnEndpoint.Builder	create(software.constructs.Construct scope, String id)
CfnClientVpnEndpoint.Builder	description(String description)	A brief description of the Client VPN endpoint.
CfnClientVpnEndpoint.Builder	dnsServers(List<String> dnsServers)	Information about the DNS servers to be used for DNS resolution.
CfnClientVpnEndpoint.Builder	securityGroupIds(List<String> securityGroupIds)	The IDs of one or more security groups to apply to the target network.
CfnClientVpnEndpoint.Builder	selfServicePortal(String selfServicePortal)	Specify whether to enable the self-service portal for the Client VPN endpoint.
CfnClientVpnEndpoint.Builder	serverCertificateArn(String serverCertificateArn)	The ARN of the server certificate.
CfnClientVpnEndpoint.Builder	sessionTimeoutHours(Number sessionTimeoutHours)	The maximum VPN session duration time in hours.
CfnClientVpnEndpoint.Builder	splitTunnel(Boolean splitTunnel)	Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
CfnClientVpnEndpoint.Builder	splitTunnel(IResolvable splitTunnel)	Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
CfnClientVpnEndpoint.Builder	tagSpecifications(List<? extends Object> tagSpecifications)	The tags to apply to the Client VPN endpoint during creation.
CfnClientVpnEndpoint.Builder	tagSpecifications(IResolvable tagSpecifications)	The tags to apply to the Client VPN endpoint during creation.
CfnClientVpnEndpoint.Builder	transportProtocol(String transportProtocol)	The transport protocol to be used by the VPN session.
CfnClientVpnEndpoint.Builder	vpcId(String vpcId)	The ID of the VPC to associate with the Client VPN endpoint.
CfnClientVpnEndpoint.Builder	vpnPort(Number vpnPort)	The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static CfnClientVpnEndpoint.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnClientVpnEndpoint.Builder.

authenticationOptions

@Stability(Stable)
public CfnClientVpnEndpoint.Builder authenticationOptions(IResolvable authenticationOptions)

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

Parameters:

authenticationOptions - Information about the authentication method to be used to authenticate clients. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-authenticationoptions

authenticationOptions

@Stability(Stable)
public CfnClientVpnEndpoint.Builder authenticationOptions(List<? extends Object> authenticationOptions)

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

Parameters:

authenticationOptions - Information about the authentication method to be used to authenticate clients. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-authenticationoptions

clientCidrBlock

@Stability(Stable)
public CfnClientVpnEndpoint.Builder clientCidrBlock(String clientCidrBlock)

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.

Parameters:

clientCidrBlock - The IPv4 address range, in CIDR notation, from which to assign client IP addresses. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientcidrblock

connectionLogOptions

@Stability(Stable)
public CfnClientVpnEndpoint.Builder connectionLogOptions(IResolvable connectionLogOptions)

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

Parameters:

connectionLogOptions - Information about the client connection logging options. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-connectionlogoptions

connectionLogOptions

@Stability(Stable)
public CfnClientVpnEndpoint.Builder connectionLogOptions(CfnClientVpnEndpoint.ConnectionLogOptionsProperty connectionLogOptions)

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

Parameters:

connectionLogOptions - Information about the client connection logging options. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-connectionlogoptions

serverCertificateArn

@Stability(Stable)
public CfnClientVpnEndpoint.Builder serverCertificateArn(String serverCertificateArn)

The ARN of the server certificate.

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

Parameters:

serverCertificateArn - The ARN of the server certificate. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-servercertificatearn

clientConnectOptions

@Stability(Stable)
public CfnClientVpnEndpoint.Builder clientConnectOptions(IResolvable clientConnectOptions)

The options for managing connection authorization for new client connections.

Parameters:

clientConnectOptions - The options for managing connection authorization for new client connections. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientconnectoptions

clientConnectOptions

@Stability(Stable)
public CfnClientVpnEndpoint.Builder clientConnectOptions(CfnClientVpnEndpoint.ClientConnectOptionsProperty clientConnectOptions)

The options for managing connection authorization for new client connections.

Parameters:

clientConnectOptions - The options for managing connection authorization for new client connections. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientconnectoptions

clientLoginBannerOptions

@Stability(Stable)
public CfnClientVpnEndpoint.Builder clientLoginBannerOptions(IResolvable clientLoginBannerOptions)

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientloginbanneroptions

clientLoginBannerOptions

@Stability(Stable)
public CfnClientVpnEndpoint.Builder clientLoginBannerOptions(CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty clientLoginBannerOptions)

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

Parameters:

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

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-clientloginbanneroptions

description

@Stability(Stable)
public CfnClientVpnEndpoint.Builder description(String description)

A brief description of the Client VPN endpoint.

Parameters:

description - A brief description of the Client VPN endpoint. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-description

dnsServers

@Stability(Stable)
public CfnClientVpnEndpoint.Builder dnsServers(List<String> dnsServers)

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.

Parameters:

dnsServers - Information about the DNS servers to be used for DNS resolution. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-dnsservers

securityGroupIds

@Stability(Stable)
public CfnClientVpnEndpoint.Builder securityGroupIds(List<String> securityGroupIds)

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.

Parameters:

securityGroupIds - The IDs of one or more security groups to apply to the target network. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-securitygroupids

selfServicePortal

@Stability(Stable)
public CfnClientVpnEndpoint.Builder selfServicePortal(String selfServicePortal)

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

Default Value: enabled

Parameters:

selfServicePortal - Specify whether to enable the self-service portal for the Client VPN endpoint. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-selfserviceportal

sessionTimeoutHours

@Stability(Stable)
public CfnClientVpnEndpoint.Builder sessionTimeoutHours(Number sessionTimeoutHours)

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

Parameters:

sessionTimeoutHours - The maximum VPN session duration time in hours. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-sessiontimeouthours

splitTunnel

@Stability(Stable)
public CfnClientVpnEndpoint.Builder splitTunnel(Boolean splitTunnel)

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 .

Parameters:

splitTunnel - Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-splittunnel

splitTunnel

@Stability(Stable)
public CfnClientVpnEndpoint.Builder splitTunnel(IResolvable splitTunnel)

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 .

Parameters:

splitTunnel - Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-splittunnel

tagSpecifications

@Stability(Stable)
public CfnClientVpnEndpoint.Builder tagSpecifications(IResolvable tagSpecifications)

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

Parameters:

tagSpecifications - The tags to apply to the Client VPN endpoint during creation. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-tagspecifications

tagSpecifications

@Stability(Stable)
public CfnClientVpnEndpoint.Builder tagSpecifications(List<? extends Object> tagSpecifications)

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

Parameters:

tagSpecifications - The tags to apply to the Client VPN endpoint during creation. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-tagspecifications

transportProtocol

@Stability(Stable)
public CfnClientVpnEndpoint.Builder transportProtocol(String transportProtocol)

The transport protocol to be used by the VPN session.

Default value: udp

Parameters:

transportProtocol - The transport protocol to be used by the VPN session. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-transportprotocol

vpcId

@Stability(Stable)
public CfnClientVpnEndpoint.Builder vpcId(String vpcId)

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.

Parameters:

vpcId - The ID of the VPC to associate with the Client VPN endpoint. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-vpcid

vpnPort

@Stability(Stable)
public CfnClientVpnEndpoint.Builder vpnPort(Number vpnPort)

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

Valid Values: 443 | 1194

Default Value: 443

Parameters:

vpnPort - The port number to assign to the Client VPN endpoint for TCP and UDP traffic. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-clientvpnendpoint.html#cfn-ec2-clientvpnendpoint-vpnport

build

@Stability(Stable)
public CfnClientVpnEndpoint build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnClientVpnEndpoint>

Returns:

a newly built instance of CfnClientVpnEndpoint.