Package software.amazon.awscdk.cfnpropertymixins.services.ec2

Class CfnClientVpnEndpointMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.ec2.CfnClientVpnEndpointMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnClientVpnEndpointMixinProps>

Enclosing interface:

CfnClientVpnEndpointMixinProps

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

A builder for CfnClientVpnEndpointMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnClientVpnEndpointMixinProps.Builder	authenticationOptions(List<? extends Object> authenticationOptions)	Sets the value of CfnClientVpnEndpointMixinProps.getAuthenticationOptions()
CfnClientVpnEndpointMixinProps.Builder	authenticationOptions(IResolvable authenticationOptions)	Sets the value of CfnClientVpnEndpointMixinProps.getAuthenticationOptions()
CfnClientVpnEndpointMixinProps	build()	Builds the configured instance.
CfnClientVpnEndpointMixinProps.Builder	clientCidrBlock(String clientCidrBlock)	Sets the value of CfnClientVpnEndpointMixinProps.getClientCidrBlock()
CfnClientVpnEndpointMixinProps.Builder	clientConnectOptions(CfnClientVpnEndpointPropsMixin.ClientConnectOptionsProperty clientConnectOptions)	Sets the value of CfnClientVpnEndpointMixinProps.getClientConnectOptions()
CfnClientVpnEndpointMixinProps.Builder	clientConnectOptions(IResolvable clientConnectOptions)	Sets the value of CfnClientVpnEndpointMixinProps.getClientConnectOptions()
CfnClientVpnEndpointMixinProps.Builder	clientLoginBannerOptions(CfnClientVpnEndpointPropsMixin.ClientLoginBannerOptionsProperty clientLoginBannerOptions)	Sets the value of CfnClientVpnEndpointMixinProps.getClientLoginBannerOptions()
CfnClientVpnEndpointMixinProps.Builder	clientLoginBannerOptions(IResolvable clientLoginBannerOptions)	Sets the value of CfnClientVpnEndpointMixinProps.getClientLoginBannerOptions()
CfnClientVpnEndpointMixinProps.Builder	clientRouteEnforcementOptions(CfnClientVpnEndpointPropsMixin.ClientRouteEnforcementOptionsProperty clientRouteEnforcementOptions)	Sets the value of CfnClientVpnEndpointMixinProps.getClientRouteEnforcementOptions()
CfnClientVpnEndpointMixinProps.Builder	clientRouteEnforcementOptions(IResolvable clientRouteEnforcementOptions)	Sets the value of CfnClientVpnEndpointMixinProps.getClientRouteEnforcementOptions()
CfnClientVpnEndpointMixinProps.Builder	connectionLogOptions(CfnClientVpnEndpointPropsMixin.ConnectionLogOptionsProperty connectionLogOptions)	Sets the value of CfnClientVpnEndpointMixinProps.getConnectionLogOptions()
CfnClientVpnEndpointMixinProps.Builder	connectionLogOptions(IResolvable connectionLogOptions)	Sets the value of CfnClientVpnEndpointMixinProps.getConnectionLogOptions()
CfnClientVpnEndpointMixinProps.Builder	description(String description)	Sets the value of CfnClientVpnEndpointMixinProps.getDescription()
CfnClientVpnEndpointMixinProps.Builder	disconnectOnSessionTimeout(Boolean disconnectOnSessionTimeout)	Sets the value of CfnClientVpnEndpointMixinProps.getDisconnectOnSessionTimeout()
CfnClientVpnEndpointMixinProps.Builder	disconnectOnSessionTimeout(IResolvable disconnectOnSessionTimeout)	Sets the value of CfnClientVpnEndpointMixinProps.getDisconnectOnSessionTimeout()
CfnClientVpnEndpointMixinProps.Builder	dnsServers(List<String> dnsServers)	Sets the value of CfnClientVpnEndpointMixinProps.getDnsServers()
CfnClientVpnEndpointMixinProps.Builder	endpointIpAddressType(String endpointIpAddressType)	Sets the value of CfnClientVpnEndpointMixinProps.getEndpointIpAddressType()
CfnClientVpnEndpointMixinProps.Builder	securityGroupIds(List<String> securityGroupIds)	Sets the value of CfnClientVpnEndpointMixinProps.getSecurityGroupIds()
CfnClientVpnEndpointMixinProps.Builder	selfServicePortal(String selfServicePortal)	Sets the value of CfnClientVpnEndpointMixinProps.getSelfServicePortal()
CfnClientVpnEndpointMixinProps.Builder	serverCertificateArn(String serverCertificateArn)	Sets the value of CfnClientVpnEndpointMixinProps.getServerCertificateArn()
CfnClientVpnEndpointMixinProps.Builder	sessionTimeoutHours(Number sessionTimeoutHours)	Sets the value of CfnClientVpnEndpointMixinProps.getSessionTimeoutHours()
CfnClientVpnEndpointMixinProps.Builder	splitTunnel(Boolean splitTunnel)	Sets the value of CfnClientVpnEndpointMixinProps.getSplitTunnel()
CfnClientVpnEndpointMixinProps.Builder	splitTunnel(IResolvable splitTunnel)	Sets the value of CfnClientVpnEndpointMixinProps.getSplitTunnel()
CfnClientVpnEndpointMixinProps.Builder	tagSpecifications(List<? extends Object> tagSpecifications)	Sets the value of CfnClientVpnEndpointMixinProps.getTagSpecifications()
CfnClientVpnEndpointMixinProps.Builder	tagSpecifications(IResolvable tagSpecifications)	Sets the value of CfnClientVpnEndpointMixinProps.getTagSpecifications()
CfnClientVpnEndpointMixinProps.Builder	trafficIpAddressType(String trafficIpAddressType)	Sets the value of CfnClientVpnEndpointMixinProps.getTrafficIpAddressType()
CfnClientVpnEndpointMixinProps.Builder	transportProtocol(String transportProtocol)	Sets the value of CfnClientVpnEndpointMixinProps.getTransportProtocol()
CfnClientVpnEndpointMixinProps.Builder	vpcId(String vpcId)	Sets the value of CfnClientVpnEndpointMixinProps.getVpcId()
CfnClientVpnEndpointMixinProps.Builder	vpnPort(Number vpnPort)	Sets the value of CfnClientVpnEndpointMixinProps.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 CfnClientVpnEndpointMixinProps.Builder authenticationOptions(IResolvable authenticationOptions)

Sets the value of CfnClientVpnEndpointMixinProps.getAuthenticationOptions()

Parameters:

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

Returns:

this

authenticationOptions

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

Sets the value of CfnClientVpnEndpointMixinProps.getAuthenticationOptions()

Parameters:

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

Returns:

this

clientCidrBlock

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

Sets the value of CfnClientVpnEndpointMixinProps.getClientCidrBlock()

Parameters:

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.

Returns:

this

clientConnectOptions

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

Sets the value of CfnClientVpnEndpointMixinProps.getClientConnectOptions()

Parameters:

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

Returns:

this

clientConnectOptions

@Stability(Stable)
public CfnClientVpnEndpointMixinProps.Builder clientConnectOptions(CfnClientVpnEndpointPropsMixin.ClientConnectOptionsProperty clientConnectOptions)

Sets the value of CfnClientVpnEndpointMixinProps.getClientConnectOptions()

Parameters:

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

Returns:

this

clientLoginBannerOptions

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

Sets the value of CfnClientVpnEndpointMixinProps.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 CfnClientVpnEndpointMixinProps.Builder clientLoginBannerOptions(CfnClientVpnEndpointPropsMixin.ClientLoginBannerOptionsProperty clientLoginBannerOptions)

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

clientRouteEnforcementOptions

@Stability(Stable)
public CfnClientVpnEndpointMixinProps.Builder clientRouteEnforcementOptions(IResolvable clientRouteEnforcementOptions)

Sets the value of CfnClientVpnEndpointMixinProps.getClientRouteEnforcementOptions()

Parameters:

clientRouteEnforcementOptions - Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. 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.

Returns:

this

clientRouteEnforcementOptions

@Stability(Stable)
public CfnClientVpnEndpointMixinProps.Builder clientRouteEnforcementOptions(CfnClientVpnEndpointPropsMixin.ClientRouteEnforcementOptionsProperty clientRouteEnforcementOptions)

Sets the value of CfnClientVpnEndpointMixinProps.getClientRouteEnforcementOptions()

Parameters:

clientRouteEnforcementOptions - Client route enforcement is a feature of the Client VPN service that helps enforce administrator defined routes on devices connected through the VPN. 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.

Returns:

this

connectionLogOptions

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

Sets the value of CfnClientVpnEndpointMixinProps.getConnectionLogOptions()

Parameters:

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

Returns:

this

connectionLogOptions

@Stability(Stable)
public CfnClientVpnEndpointMixinProps.Builder connectionLogOptions(CfnClientVpnEndpointPropsMixin.ConnectionLogOptionsProperty connectionLogOptions)

Sets the value of CfnClientVpnEndpointMixinProps.getConnectionLogOptions()

Parameters:

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

Returns:

this

description

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

Sets the value of CfnClientVpnEndpointMixinProps.getDescription()

Parameters:

description - A brief description of the Client VPN endpoint.

Returns:

this

disconnectOnSessionTimeout

@Stability(Stable)
public CfnClientVpnEndpointMixinProps.Builder disconnectOnSessionTimeout(Boolean disconnectOnSessionTimeout)

Sets the value of CfnClientVpnEndpointMixinProps.getDisconnectOnSessionTimeout()

Parameters:

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

Returns:

this

disconnectOnSessionTimeout

@Stability(Stable)
public CfnClientVpnEndpointMixinProps.Builder disconnectOnSessionTimeout(IResolvable disconnectOnSessionTimeout)

Sets the value of CfnClientVpnEndpointMixinProps.getDisconnectOnSessionTimeout()

Parameters:

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

Returns:

this

dnsServers

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

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

endpointIpAddressType

@Stability(Stable)
public CfnClientVpnEndpointMixinProps.Builder endpointIpAddressType(String endpointIpAddressType)

Sets the value of CfnClientVpnEndpointMixinProps.getEndpointIpAddressType()

Parameters:

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

Returns:

this

securityGroupIds

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

Sets the value of CfnClientVpnEndpointMixinProps.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 CfnClientVpnEndpointMixinProps.Builder selfServicePortal(String selfServicePortal)

Sets the value of CfnClientVpnEndpointMixinProps.getSelfServicePortal()

Parameters:

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

Returns:

this

serverCertificateArn

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

Sets the value of CfnClientVpnEndpointMixinProps.getServerCertificateArn()

Parameters:

serverCertificateArn - The ARN of the server certificate. For more information, see the Certificate Manager User Guide .

Returns:

this

sessionTimeoutHours

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

Sets the value of CfnClientVpnEndpointMixinProps.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 CfnClientVpnEndpointMixinProps.Builder splitTunnel(Boolean splitTunnel)

Sets the value of CfnClientVpnEndpointMixinProps.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 CfnClientVpnEndpointMixinProps.Builder splitTunnel(IResolvable splitTunnel)

Sets the value of CfnClientVpnEndpointMixinProps.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 CfnClientVpnEndpointMixinProps.Builder tagSpecifications(IResolvable tagSpecifications)

Sets the value of CfnClientVpnEndpointMixinProps.getTagSpecifications()

Parameters:

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

Returns:

this

tagSpecifications

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

Sets the value of CfnClientVpnEndpointMixinProps.getTagSpecifications()

Parameters:

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

Returns:

this

trafficIpAddressType

@Stability(Stable)
public CfnClientVpnEndpointMixinProps.Builder trafficIpAddressType(String trafficIpAddressType)

Sets the value of CfnClientVpnEndpointMixinProps.getTrafficIpAddressType()

Parameters:

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

Returns:

this

transportProtocol

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

Sets the value of CfnClientVpnEndpointMixinProps.getTransportProtocol()

Parameters:

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

Returns:

this

vpcId

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

Sets the value of CfnClientVpnEndpointMixinProps.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 CfnClientVpnEndpointMixinProps.Builder vpnPort(Number vpnPort)

Sets the value of CfnClientVpnEndpointMixinProps.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 CfnClientVpnEndpointMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnClientVpnEndpointMixinProps

Throws:

NullPointerException - if any required attribute was not provided