CreateClientVpnEndpointRequest.Builder (AWS Java SDK :: Services

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateClientVpnEndpointRequest.Builder,CreateClientVpnEndpointRequest>, Ec2Request.Builder, SdkBuilder<CreateClientVpnEndpointRequest.Builder,CreateClientVpnEndpointRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateClientVpnEndpointRequest
```
public static interface CreateClientVpnEndpointRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CreateClientVpnEndpointRequest.Builder,CreateClientVpnEndpointRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`CreateClientVpnEndpointRequest.Builder`	`authenticationOptions(ClientVpnAuthenticationRequest... authenticationOptions)` Information about the authentication method to be used to authenticate clients.
`CreateClientVpnEndpointRequest.Builder`	`authenticationOptions(Collection<ClientVpnAuthenticationRequest> authenticationOptions)` Information about the authentication method to be used to authenticate clients.
`CreateClientVpnEndpointRequest.Builder`	`authenticationOptions(Consumer<ClientVpnAuthenticationRequest.Builder>... authenticationOptions)` Information about the authentication method to be used to authenticate clients.
`CreateClientVpnEndpointRequest.Builder`	`clientCidrBlock(String clientCidrBlock)` The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
`CreateClientVpnEndpointRequest.Builder`	`clientConnectOptions(ClientConnectOptions clientConnectOptions)` The options for managing connection authorization for new client connections.
`default CreateClientVpnEndpointRequest.Builder`	`clientConnectOptions(Consumer<ClientConnectOptions.Builder> clientConnectOptions)` The options for managing connection authorization for new client connections.
`CreateClientVpnEndpointRequest.Builder`	`clientLoginBannerOptions(ClientLoginBannerOptions clientLoginBannerOptions)` Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
`default CreateClientVpnEndpointRequest.Builder`	`clientLoginBannerOptions(Consumer<ClientLoginBannerOptions.Builder> clientLoginBannerOptions)` Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
`CreateClientVpnEndpointRequest.Builder`	`clientToken(String clientToken)` Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
`CreateClientVpnEndpointRequest.Builder`	`connectionLogOptions(ConnectionLogOptions connectionLogOptions)` Information about the client connection logging options.
`default CreateClientVpnEndpointRequest.Builder`	`connectionLogOptions(Consumer<ConnectionLogOptions.Builder> connectionLogOptions)` Information about the client connection logging options.
`CreateClientVpnEndpointRequest.Builder`	`description(String description)` A brief description of the Client VPN endpoint.
`CreateClientVpnEndpointRequest.Builder`	`dnsServers(Collection<String> dnsServers)` Information about the DNS servers to be used for DNS resolution.
`CreateClientVpnEndpointRequest.Builder`	`dnsServers(String... dnsServers)` Information about the DNS servers to be used for DNS resolution.
`CreateClientVpnEndpointRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`CreateClientVpnEndpointRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`CreateClientVpnEndpointRequest.Builder`	`securityGroupIds(Collection<String> securityGroupIds)` The IDs of one or more security groups to apply to the target network.
`CreateClientVpnEndpointRequest.Builder`	`securityGroupIds(String... securityGroupIds)` The IDs of one or more security groups to apply to the target network.
`CreateClientVpnEndpointRequest.Builder`	`selfServicePortal(SelfServicePortal selfServicePortal)` Specify whether to enable the self-service portal for the Client VPN endpoint.
`CreateClientVpnEndpointRequest.Builder`	`selfServicePortal(String selfServicePortal)` Specify whether to enable the self-service portal for the Client VPN endpoint.
`CreateClientVpnEndpointRequest.Builder`	`serverCertificateArn(String serverCertificateArn)` The ARN of the server certificate.
`CreateClientVpnEndpointRequest.Builder`	`sessionTimeoutHours(Integer sessionTimeoutHours)` The maximum VPN session duration time in hours.
`CreateClientVpnEndpointRequest.Builder`	`splitTunnel(Boolean splitTunnel)` Indicates whether split-tunnel is enabled on the Client VPN endpoint.
`CreateClientVpnEndpointRequest.Builder`	`tagSpecifications(Collection<TagSpecification> tagSpecifications)` The tags to apply to the Client VPN endpoint during creation.
`CreateClientVpnEndpointRequest.Builder`	`tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)` The tags to apply to the Client VPN endpoint during creation.
`CreateClientVpnEndpointRequest.Builder`	`tagSpecifications(TagSpecification... tagSpecifications)` The tags to apply to the Client VPN endpoint during creation.
`CreateClientVpnEndpointRequest.Builder`	`transportProtocol(String transportProtocol)` The transport protocol to be used by the VPN session.
`CreateClientVpnEndpointRequest.Builder`	`transportProtocol(TransportProtocol transportProtocol)` The transport protocol to be used by the VPN session.
`CreateClientVpnEndpointRequest.Builder`	`vpcId(String vpcId)` The ID of the VPC to associate with the Client VPN endpoint.
`CreateClientVpnEndpointRequest.Builder`	`vpnPort(Integer vpnPort)` The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - clientCidrBlock
```
CreateClientVpnEndpointRequest.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. The CIDR block should be /22 or greater.
    
    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. The CIDR block should be /22 or greater.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - serverCertificateArn
```
CreateClientVpnEndpointRequest.Builder serverCertificateArn(String serverCertificateArn)
```
    The ARN of the server certificate. For more information, see the Certificate Manager User Guide.
    
    Parameters:
    
    serverCertificateArn - The ARN of the server certificate. For more information, see the Certificate Manager User Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - authenticationOptions
```
CreateClientVpnEndpointRequest.Builder authenticationOptions(Collection<ClientVpnAuthenticationRequest> 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - authenticationOptions
```
CreateClientVpnEndpointRequest.Builder authenticationOptions(ClientVpnAuthenticationRequest... 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - authenticationOptions
```
CreateClientVpnEndpointRequest.Builder authenticationOptions(Consumer<ClientVpnAuthenticationRequest.Builder>... authenticationOptions)
```
    Information about the authentication method to be used to authenticate clients.
    This is a convenience method that creates an instance of the .Builder avoiding the need to create one manually via #builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #authenticationOptions(List).
    
    Parameters:
    
    authenticationOptions - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #authenticationOptions(List)
  - connectionLogOptions
```
CreateClientVpnEndpointRequest.Builder connectionLogOptions(ConnectionLogOptions 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.
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - connectionLogOptions
```
default CreateClientVpnEndpointRequest.Builder connectionLogOptions(Consumer<ConnectionLogOptions.Builder> 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
    This is a convenience method that creates an instance of the ConnectionLogOptions.Builder avoiding the need to create one manually via ConnectionLogOptions.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to connectionLogOptions(ConnectionLogOptions).
    Parameters:
    
    connectionLogOptions - a consumer that will call methods on ConnectionLogOptions.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    connectionLogOptions(ConnectionLogOptions)
  - dnsServers
```
CreateClientVpnEndpointRequest.Builder dnsServers(Collection<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. 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - dnsServers
```
CreateClientVpnEndpointRequest.Builder dnsServers(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. 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:
    
    Returns a reference to this object so that method calls can be chained together.
  - transportProtocol
```
CreateClientVpnEndpointRequest.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.
    
    Default value: udp
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TransportProtocol, TransportProtocol
  - transportProtocol
```
CreateClientVpnEndpointRequest.Builder transportProtocol(TransportProtocol 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.
    
    Default value: udp
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    TransportProtocol, TransportProtocol
  - vpnPort
```
CreateClientVpnEndpointRequest.Builder vpnPort(Integer 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.
    
    Valid Values: 443 | 1194
    
    Default Value: 443
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - description
```
CreateClientVpnEndpointRequest.Builder description(String description)
```
    A brief description of the Client VPN endpoint.
    
    Parameters:
    
    description - A brief description of the Client VPN endpoint.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - splitTunnel
```
CreateClientVpnEndpointRequest.Builder splitTunnel(Boolean splitTunnel)
```
    Indicates whether split-tunnel is enabled on the Client VPN endpoint.
    
    By default, split-tunnel on a VPN endpoint is disabled.
    
    For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
    
    Parameters:
    
    splitTunnel - Indicates whether split-tunnel is enabled on the Client VPN endpoint.
    
    By default, split-tunnel on a VPN endpoint is disabled.
    
    For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - clientToken
```
CreateClientVpnEndpointRequest.Builder clientToken(String clientToken)
```
    Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
    
    Parameters:
    
    clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to ensure idempotency.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tagSpecifications
```
CreateClientVpnEndpointRequest.Builder tagSpecifications(Collection<TagSpecification> 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tagSpecifications
```
CreateClientVpnEndpointRequest.Builder tagSpecifications(TagSpecification... 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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tagSpecifications
```
CreateClientVpnEndpointRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)
```
    The tags to apply to the Client VPN endpoint during creation.
    This is a convenience method that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tagSpecifications(List).
    
    Parameters:
    
    tagSpecifications - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #tagSpecifications(List)
  - securityGroupIds
```
CreateClientVpnEndpointRequest.Builder securityGroupIds(Collection<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. You must also specify the ID of the VPC that contains the security groups.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - securityGroupIds
```
CreateClientVpnEndpointRequest.Builder securityGroupIds(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. You must also specify the ID of the VPC that contains the security groups.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - vpcId
```
CreateClientVpnEndpointRequest.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. If no security group IDs are specified in the request, the default security group for the VPC is applied.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - selfServicePortal
```
CreateClientVpnEndpointRequest.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.
    
    Default Value: enabled
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SelfServicePortal, SelfServicePortal
  - selfServicePortal
```
CreateClientVpnEndpointRequest.Builder selfServicePortal(SelfServicePortal 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.
    
    Default Value: enabled
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    SelfServicePortal, SelfServicePortal
  - clientConnectOptions
```
CreateClientVpnEndpointRequest.Builder clientConnectOptions(ClientConnectOptions clientConnectOptions)
```
    The options for managing connection authorization for new client connections.
    
    Parameters:
    
    clientConnectOptions - The options for managing connection authorization for new client connections.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - clientConnectOptions
```
default CreateClientVpnEndpointRequest.Builder clientConnectOptions(Consumer<ClientConnectOptions.Builder> clientConnectOptions)
```
    The options for managing connection authorization for new client connections.
    This is a convenience method that creates an instance of the ClientConnectOptions.Builder avoiding the need to create one manually via ClientConnectOptions.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to clientConnectOptions(ClientConnectOptions).
    
    Parameters:
    
    clientConnectOptions - a consumer that will call methods on ClientConnectOptions.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    clientConnectOptions(ClientConnectOptions)
  - sessionTimeoutHours
```
CreateClientVpnEndpointRequest.Builder sessionTimeoutHours(Integer 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.
    
    Valid values: 8 | 10 | 12 | 24
    
    Default value: 24
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - clientLoginBannerOptions
```
CreateClientVpnEndpointRequest.Builder clientLoginBannerOptions(ClientLoginBannerOptions clientLoginBannerOptions)
```
    Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
    
    Parameters:
    
    clientLoginBannerOptions - Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - clientLoginBannerOptions
```
default CreateClientVpnEndpointRequest.Builder clientLoginBannerOptions(Consumer<ClientLoginBannerOptions.Builder> clientLoginBannerOptions)
```
    Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
    This is a convenience method that creates an instance of the ClientLoginBannerOptions.Builder avoiding the need to create one manually via ClientLoginBannerOptions.builder(). When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to clientLoginBannerOptions(ClientLoginBannerOptions).
    
    Parameters:
    
    clientLoginBannerOptions - a consumer that will call methods on ClientLoginBannerOptions.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    clientLoginBannerOptions(ClientLoginBannerOptions)
  - overrideConfiguration
```
CreateClientVpnEndpointRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
CreateClientVpnEndpointRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface CreateClientVpnEndpointRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

clientCidrBlock

serverCertificateArn

authenticationOptions

authenticationOptions

authenticationOptions

connectionLogOptions

connectionLogOptions

dnsServers

dnsServers

transportProtocol

transportProtocol

vpnPort

description

splitTunnel

clientToken

tagSpecifications

tagSpecifications

tagSpecifications

securityGroupIds

securityGroupIds

vpcId

selfServicePortal

selfServicePortal

clientConnectOptions

clientConnectOptions

sessionTimeoutHours

clientLoginBannerOptions

clientLoginBannerOptions

overrideConfiguration

overrideConfiguration