Package software.amazon.awscdk.services.ec2

Class CfnClientVpnEndpointProps.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.CfnClientVpnEndpointProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnClientVpnEndpointProps>

Enclosing interface:

CfnClientVpnEndpointProps

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

A builder for CfnClientVpnEndpointProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnClientVpnEndpointProps.Builder	authenticationOptions(List<? extends Object> authenticationOptions)	Sets the value of CfnClientVpnEndpointProps.getAuthenticationOptions()
CfnClientVpnEndpointProps.Builder	authenticationOptions(IResolvable authenticationOptions)	Sets the value of CfnClientVpnEndpointProps.getAuthenticationOptions()
CfnClientVpnEndpointProps	build()	Builds the configured instance.
CfnClientVpnEndpointProps.Builder	clientCidrBlock(String clientCidrBlock)	Sets the value of CfnClientVpnEndpointProps.getClientCidrBlock()
CfnClientVpnEndpointProps.Builder	clientConnectOptions(IResolvable clientConnectOptions)	Sets the value of CfnClientVpnEndpointProps.getClientConnectOptions()
CfnClientVpnEndpointProps.Builder	clientConnectOptions(CfnClientVpnEndpoint.ClientConnectOptionsProperty clientConnectOptions)	Sets the value of CfnClientVpnEndpointProps.getClientConnectOptions()
CfnClientVpnEndpointProps.Builder	clientLoginBannerOptions(IResolvable clientLoginBannerOptions)	Sets the value of CfnClientVpnEndpointProps.getClientLoginBannerOptions()
CfnClientVpnEndpointProps.Builder	clientLoginBannerOptions(CfnClientVpnEndpoint.ClientLoginBannerOptionsProperty clientLoginBannerOptions)	Sets the value of CfnClientVpnEndpointProps.getClientLoginBannerOptions()
CfnClientVpnEndpointProps.Builder	connectionLogOptions(IResolvable connectionLogOptions)	Sets the value of CfnClientVpnEndpointProps.getConnectionLogOptions()
CfnClientVpnEndpointProps.Builder	connectionLogOptions(CfnClientVpnEndpoint.ConnectionLogOptionsProperty connectionLogOptions)	Sets the value of CfnClientVpnEndpointProps.getConnectionLogOptions()
CfnClientVpnEndpointProps.Builder	description(String description)	Sets the value of CfnClientVpnEndpointProps.getDescription()
CfnClientVpnEndpointProps.Builder	dnsServers(List<String> dnsServers)	Sets the value of CfnClientVpnEndpointProps.getDnsServers()
CfnClientVpnEndpointProps.Builder	securityGroupIds(List<String> securityGroupIds)	Sets the value of CfnClientVpnEndpointProps.getSecurityGroupIds()
CfnClientVpnEndpointProps.Builder	selfServicePortal(String selfServicePortal)	Sets the value of CfnClientVpnEndpointProps.getSelfServicePortal()
CfnClientVpnEndpointProps.Builder	serverCertificateArn(String serverCertificateArn)	Sets the value of CfnClientVpnEndpointProps.getServerCertificateArn()
CfnClientVpnEndpointProps.Builder	sessionTimeoutHours(Number sessionTimeoutHours)	Sets the value of CfnClientVpnEndpointProps.getSessionTimeoutHours()
CfnClientVpnEndpointProps.Builder	splitTunnel(Boolean splitTunnel)	Sets the value of CfnClientVpnEndpointProps.getSplitTunnel()
CfnClientVpnEndpointProps.Builder	splitTunnel(IResolvable splitTunnel)	Sets the value of CfnClientVpnEndpointProps.getSplitTunnel()
CfnClientVpnEndpointProps.Builder	tagSpecifications(List<? extends Object> tagSpecifications)	Sets the value of CfnClientVpnEndpointProps.getTagSpecifications()
CfnClientVpnEndpointProps.Builder	tagSpecifications(IResolvable tagSpecifications)	Sets the value of CfnClientVpnEndpointProps.getTagSpecifications()
CfnClientVpnEndpointProps.Builder	transportProtocol(String transportProtocol)	Sets the value of CfnClientVpnEndpointProps.getTransportProtocol()
CfnClientVpnEndpointProps.Builder	vpcId(String vpcId)	Sets the value of CfnClientVpnEndpointProps.getVpcId()
CfnClientVpnEndpointProps.Builder	vpnPort(Number vpnPort)	Sets the value of CfnClientVpnEndpointProps.getVpnPort()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

authenticationOptions

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

Sets the value of CfnClientVpnEndpointProps.getAuthenticationOptions()

Parameters:

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

Returns:

this

authenticationOptions

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

Sets the value of CfnClientVpnEndpointProps.getAuthenticationOptions()

Parameters:

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

Returns:

this

clientCidrBlock

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

Sets the value of CfnClientVpnEndpointProps.getClientCidrBlock()

Parameters:

clientCidrBlock - The IPv4 address range, in CIDR notation, from which to assign client IP addresses. This parameter is required. 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.

Returns:

this

connectionLogOptions

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

Sets the value of CfnClientVpnEndpointProps.getConnectionLogOptions()

Parameters:

connectionLogOptions - Information about the client connection logging options. This parameter is required. 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

Returns:

this

connectionLogOptions

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

Sets the value of CfnClientVpnEndpointProps.getConnectionLogOptions()

Parameters:

connectionLogOptions - Information about the client connection logging options. This parameter is required. 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

Returns:

this

serverCertificateArn

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

Sets the value of CfnClientVpnEndpointProps.getServerCertificateArn()

Parameters:

serverCertificateArn - The ARN of the server certificate. This parameter is required. For more information, see the AWS Certificate Manager User Guide .

Returns:

this

clientConnectOptions

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

Sets the value of CfnClientVpnEndpointProps.getClientConnectOptions()

Parameters:

clientConnectOptions - The options for managing connection authorization for new client connections.

Returns:

this

clientConnectOptions

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

Sets the value of CfnClientVpnEndpointProps.getClientConnectOptions()

Parameters:

clientConnectOptions - The options for managing connection authorization for new client connections.

Returns:

this

clientLoginBannerOptions

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

Sets the value of CfnClientVpnEndpointProps.getClientLoginBannerOptions()

Parameters:

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

Returns:

this

clientLoginBannerOptions

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

Sets the value of CfnClientVpnEndpointProps.getClientLoginBannerOptions()

Parameters:

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

Returns:

this

description

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

Sets the value of CfnClientVpnEndpointProps.getDescription()

Parameters:

description - A brief description of the Client VPN endpoint.

Returns:

this

dnsServers

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

Sets the value of CfnClientVpnEndpointProps.getDnsServers()

Parameters:

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.

Returns:

this

securityGroupIds

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

Sets the value of CfnClientVpnEndpointProps.getSecurityGroupIds()

Parameters:

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.

Returns:

this

selfServicePortal

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

Sets the value of CfnClientVpnEndpointProps.getSelfServicePortal()

Parameters:

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

Returns:

this

sessionTimeoutHours

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

Sets the value of CfnClientVpnEndpointProps.getSessionTimeoutHours()

Parameters:

sessionTimeoutHours - The maximum VPN session duration time in hours. Valid values: 8 | 10 | 12 | 24

Default value: 24

Returns:

this

splitTunnel

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

Sets the value of CfnClientVpnEndpointProps.getSplitTunnel()

Parameters:

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 .

Returns:

this

splitTunnel

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

Sets the value of CfnClientVpnEndpointProps.getSplitTunnel()

Parameters:

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 .

Returns:

this

tagSpecifications

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

Sets the value of CfnClientVpnEndpointProps.getTagSpecifications()

Parameters:

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

Returns:

this

tagSpecifications

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

Sets the value of CfnClientVpnEndpointProps.getTagSpecifications()

Parameters:

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

Returns:

this

transportProtocol

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

Sets the value of CfnClientVpnEndpointProps.getTransportProtocol()

Parameters:

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

Returns:

this

vpcId

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

Sets the value of CfnClientVpnEndpointProps.getVpcId()

Parameters:

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.

Returns:

this

vpnPort

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

Sets the value of CfnClientVpnEndpointProps.getVpnPort()

Parameters:

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

Default Value: 443

Returns:

this

build

@Stability(Stable)
public CfnClientVpnEndpointProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnClientVpnEndpointProps

Throws:

NullPointerException - if any required attribute was not provided