public static final class ClientVpnEndpointOptions.Builder
extends java.lang.Object
ClientVpnEndpointOptions
Constructor and Description |
---|
Builder() |
public ClientVpnEndpointOptions.Builder cidr(java.lang.String cidr)
ClientVpnEndpointOptions.getCidr()
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.
this
public ClientVpnEndpointOptions.Builder serverCertificateArn(java.lang.String serverCertificateArn)
ClientVpnEndpointOptions.getServerCertificateArn()
serverCertificateArn
- The ARN of the server certificate. This parameter is required.this
public ClientVpnEndpointOptions.Builder authorizeAllUsersToVpcCidr(java.lang.Boolean authorizeAllUsersToVpcCidr)
ClientVpnEndpointOptions.getAuthorizeAllUsersToVpcCidr()
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.this
public ClientVpnEndpointOptions.Builder clientCertificateArn(java.lang.String clientCertificateArn)
ClientVpnEndpointOptions.getClientCertificateArn()
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).this
public ClientVpnEndpointOptions.Builder clientConnectionHandler(IClientVpnConnectionHandler clientConnectionHandler)
ClientVpnEndpointOptions.getClientConnectionHandler()
clientConnectionHandler
- The AWS Lambda function used for connection authorization.
The name of the Lambda function must begin with the AWSClientVPN-
prefixthis
public ClientVpnEndpointOptions.Builder clientLoginBanner(java.lang.String clientLoginBanner)
ClientVpnEndpointOptions.getClientLoginBanner()
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.this
public ClientVpnEndpointOptions.Builder description(java.lang.String description)
ClientVpnEndpointOptions.getDescription()
description
- A brief description of the Client VPN endpoint.this
public ClientVpnEndpointOptions.Builder dnsServers(java.util.List<java.lang.String> dnsServers)
ClientVpnEndpointOptions.getDnsServers()
dnsServers
- Information about the DNS servers to be used for DNS resolution.
A Client VPN endpoint can have up to two DNS servers.this
public ClientVpnEndpointOptions.Builder logging(java.lang.Boolean logging)
ClientVpnEndpointOptions.getLogging()
logging
- Whether to enable connections logging.this
public ClientVpnEndpointOptions.Builder logGroup(ILogGroup logGroup)
ClientVpnEndpointOptions.getLogGroup()
logGroup
- A CloudWatch Logs log group for connection logging.this
public ClientVpnEndpointOptions.Builder logStream(ILogStream logStream)
ClientVpnEndpointOptions.getLogStream()
logStream
- A CloudWatch Logs log stream for connection logging.this
public ClientVpnEndpointOptions.Builder port(VpnPort port)
ClientVpnEndpointOptions.getPort()
port
- The port number to assign to the Client VPN endpoint for TCP and UDP traffic.this
public ClientVpnEndpointOptions.Builder securityGroups(java.util.List<? extends ISecurityGroup> securityGroups)
ClientVpnEndpointOptions.getSecurityGroups()
securityGroups
- The security groups to apply to the target network.this
public ClientVpnEndpointOptions.Builder selfServicePortal(java.lang.Boolean selfServicePortal)
ClientVpnEndpointOptions.getSelfServicePortal()
selfServicePortal
- Specify whether to enable the self-service portal for the Client VPN endpoint.this
public ClientVpnEndpointOptions.Builder sessionTimeout(ClientVpnSessionTimeout sessionTimeout)
ClientVpnEndpointOptions.getSessionTimeout()
sessionTimeout
- The maximum VPN session duration time.this
public ClientVpnEndpointOptions.Builder splitTunnel(java.lang.Boolean splitTunnel)
ClientVpnEndpointOptions.getSplitTunnel()
splitTunnel
- Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.this
public ClientVpnEndpointOptions.Builder transportProtocol(TransportProtocol transportProtocol)
ClientVpnEndpointOptions.getTransportProtocol()
transportProtocol
- The transport protocol to be used by the VPN session.this
public ClientVpnEndpointOptions.Builder userBasedAuthentication(ClientVpnUserBasedAuthentication userBasedAuthentication)
ClientVpnEndpointOptions.getUserBasedAuthentication()
userBasedAuthentication
- The type of user-based authentication to use.this
public ClientVpnEndpointOptions.Builder vpcSubnets(SubnetSelection vpcSubnets)
ClientVpnEndpointOptions.getVpcSubnets()
vpcSubnets
- Subnets to associate to the client VPN endpoint.this
public ClientVpnEndpointOptions build()
ClientVpnEndpointOptions
java.lang.NullPointerException
- if any required attribute was not provided