Package software.amazon.awscdk.services.ec2

Class ClientVpnEndpointOptions.Builder

java.lang.Object

software.amazon.awscdk.services.ec2.ClientVpnEndpointOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<ClientVpnEndpointOptions>

Enclosing interface:

ClientVpnEndpointOptions

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

A builder for ClientVpnEndpointOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ClientVpnEndpointOptions.Builder	authorizeAllUsersToVpcCidr(Boolean authorizeAllUsersToVpcCidr)	Sets the value of ClientVpnEndpointOptions.getAuthorizeAllUsersToVpcCidr()
ClientVpnEndpointOptions	build()	Builds the configured instance.
ClientVpnEndpointOptions.Builder	cidr(String cidr)	Sets the value of ClientVpnEndpointOptions.getCidr()
ClientVpnEndpointOptions.Builder	clientCertificateArn(String clientCertificateArn)	Sets the value of ClientVpnEndpointOptions.getClientCertificateArn()
ClientVpnEndpointOptions.Builder	clientConnectionHandler(IClientVpnConnectionHandler clientConnectionHandler)	Sets the value of ClientVpnEndpointOptions.getClientConnectionHandler()
ClientVpnEndpointOptions.Builder	clientLoginBanner(String clientLoginBanner)	Sets the value of ClientVpnEndpointOptions.getClientLoginBanner()
ClientVpnEndpointOptions.Builder	description(String description)	Sets the value of ClientVpnEndpointOptions.getDescription()
ClientVpnEndpointOptions.Builder	dnsServers(List<String> dnsServers)	Sets the value of ClientVpnEndpointOptions.getDnsServers()
ClientVpnEndpointOptions.Builder	logging(Boolean logging)	Sets the value of ClientVpnEndpointOptions.getLogging()
ClientVpnEndpointOptions.Builder	logGroup(ILogGroup logGroup)	Sets the value of ClientVpnEndpointOptions.getLogGroup()
ClientVpnEndpointOptions.Builder	logStream(ILogStream logStream)	Sets the value of ClientVpnEndpointOptions.getLogStream()
ClientVpnEndpointOptions.Builder	port(VpnPort port)	Sets the value of ClientVpnEndpointOptions.getPort()
ClientVpnEndpointOptions.Builder	securityGroups(List<? extends ISecurityGroup> securityGroups)	Sets the value of ClientVpnEndpointOptions.getSecurityGroups()
ClientVpnEndpointOptions.Builder	selfServicePortal(Boolean selfServicePortal)	Sets the value of ClientVpnEndpointOptions.getSelfServicePortal()
ClientVpnEndpointOptions.Builder	serverCertificateArn(String serverCertificateArn)	Sets the value of ClientVpnEndpointOptions.getServerCertificateArn()
ClientVpnEndpointOptions.Builder	sessionTimeout(ClientVpnSessionTimeout sessionTimeout)	Sets the value of ClientVpnEndpointOptions.getSessionTimeout()
ClientVpnEndpointOptions.Builder	splitTunnel(Boolean splitTunnel)	Sets the value of ClientVpnEndpointOptions.getSplitTunnel()
ClientVpnEndpointOptions.Builder	transportProtocol(TransportProtocol transportProtocol)	Sets the value of ClientVpnEndpointOptions.getTransportProtocol()
ClientVpnEndpointOptions.Builder	userBasedAuthentication(ClientVpnUserBasedAuthentication userBasedAuthentication)	Sets the value of ClientVpnEndpointOptions.getUserBasedAuthentication()
ClientVpnEndpointOptions.Builder	vpcSubnets(SubnetSelection vpcSubnets)	Sets the value of ClientVpnEndpointOptions.getVpcSubnets()

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

cidr

@Stability(Stable)
public ClientVpnEndpointOptions.Builder cidr(String cidr)

Sets the value of ClientVpnEndpointOptions.getCidr()

Parameters:

cidr - 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.

Changing the address range will replace the Client VPN endpoint.

The CIDR block should be /22 or greater.

Returns:

this

serverCertificateArn

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

Sets the value of ClientVpnEndpointOptions.getServerCertificateArn()

Parameters:

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

Returns:

this

authorizeAllUsersToVpcCidr

@Stability(Stable)
public ClientVpnEndpointOptions.Builder authorizeAllUsersToVpcCidr(Boolean authorizeAllUsersToVpcCidr)

Sets the value of ClientVpnEndpointOptions.getAuthorizeAllUsersToVpcCidr()

Parameters:

authorizeAllUsersToVpcCidr - 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.

Returns:

this

clientCertificateArn

@Stability(Stable)
public ClientVpnEndpointOptions.Builder clientCertificateArn(String clientCertificateArn)

Sets the value of ClientVpnEndpointOptions.getClientCertificateArn()

Parameters:

clientCertificateArn - 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).

Returns:

this

clientConnectionHandler

@Stability(Stable)
public ClientVpnEndpointOptions.Builder clientConnectionHandler(IClientVpnConnectionHandler clientConnectionHandler)

Sets the value of ClientVpnEndpointOptions.getClientConnectionHandler()

Parameters:

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

Returns:

this

clientLoginBanner

@Stability(Stable)
public ClientVpnEndpointOptions.Builder clientLoginBanner(String clientLoginBanner)

Sets the value of ClientVpnEndpointOptions.getClientLoginBanner()

Parameters:

clientLoginBanner - 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.

Returns:

this

description

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

Sets the value of ClientVpnEndpointOptions.getDescription()

Parameters:

description - A brief description of the Client VPN endpoint.

Returns:

this

dnsServers

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

Sets the value of ClientVpnEndpointOptions.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.

Returns:

this

logging

@Stability(Stable)
public ClientVpnEndpointOptions.Builder logging(Boolean logging)

Sets the value of ClientVpnEndpointOptions.getLogging()

Parameters:

logging - Whether to enable connections logging.

Returns:

this

logGroup

@Stability(Stable)
public ClientVpnEndpointOptions.Builder logGroup(ILogGroup logGroup)

Sets the value of ClientVpnEndpointOptions.getLogGroup()

Parameters:

logGroup - A CloudWatch Logs log group for connection logging.

Returns:

this

logStream

@Stability(Stable)
public ClientVpnEndpointOptions.Builder logStream(ILogStream logStream)

Sets the value of ClientVpnEndpointOptions.getLogStream()

Parameters:

logStream - A CloudWatch Logs log stream for connection logging.

Returns:

this

port

@Stability(Stable)
public ClientVpnEndpointOptions.Builder port(VpnPort port)

Sets the value of ClientVpnEndpointOptions.getPort()

Parameters:

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

Returns:

this

securityGroups

@Stability(Stable)
public ClientVpnEndpointOptions.Builder securityGroups(List<? extends ISecurityGroup> securityGroups)

Sets the value of ClientVpnEndpointOptions.getSecurityGroups()

Parameters:

securityGroups - The security groups to apply to the target network.

Returns:

this

selfServicePortal

@Stability(Stable)
public ClientVpnEndpointOptions.Builder selfServicePortal(Boolean selfServicePortal)

Sets the value of ClientVpnEndpointOptions.getSelfServicePortal()

Parameters:

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

Returns:

this

sessionTimeout

@Stability(Stable)
public ClientVpnEndpointOptions.Builder sessionTimeout(ClientVpnSessionTimeout sessionTimeout)

Sets the value of ClientVpnEndpointOptions.getSessionTimeout()

Parameters:

sessionTimeout - The maximum VPN session duration time.

Returns:

this

splitTunnel

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

Sets the value of ClientVpnEndpointOptions.getSplitTunnel()

Parameters:

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

Returns:

this

transportProtocol

@Stability(Stable)
public ClientVpnEndpointOptions.Builder transportProtocol(TransportProtocol transportProtocol)

Sets the value of ClientVpnEndpointOptions.getTransportProtocol()

Parameters:

transportProtocol - The transport protocol to be used by the VPN session.

Returns:

this

userBasedAuthentication

@Stability(Stable)
public ClientVpnEndpointOptions.Builder userBasedAuthentication(ClientVpnUserBasedAuthentication userBasedAuthentication)

Sets the value of ClientVpnEndpointOptions.getUserBasedAuthentication()

Parameters:

userBasedAuthentication - The type of user-based authentication to use.

Returns:

this

vpcSubnets

@Stability(Stable)
public ClientVpnEndpointOptions.Builder vpcSubnets(SubnetSelection vpcSubnets)

Sets the value of ClientVpnEndpointOptions.getVpcSubnets()

Parameters:

vpcSubnets - Subnets to associate to the client VPN endpoint.

Returns:

this

build

@Stability(Stable)
public ClientVpnEndpointOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of ClientVpnEndpointOptions

Throws:

NullPointerException - if any required attribute was not provided