Package software.amazon.awssdk.services.ec2.model

Interface ModifyClientVpnEndpointRequest.Builder

All Superinterfaces:

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

Enclosing class:

ModifyClientVpnEndpointRequest

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

Method Summary

Modifier and Type	Method	Description
default ModifyClientVpnEndpointRequest.Builder	clientConnectOptions(Consumer<ClientConnectOptions.Builder> clientConnectOptions)	The options for managing connection authorization for new client connections.
ModifyClientVpnEndpointRequest.Builder	clientConnectOptions(ClientConnectOptions clientConnectOptions)	The options for managing connection authorization for new client connections.
default ModifyClientVpnEndpointRequest.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.
ModifyClientVpnEndpointRequest.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.
ModifyClientVpnEndpointRequest.Builder	clientVpnEndpointId(String clientVpnEndpointId)	The ID of the Client VPN endpoint to modify.
default ModifyClientVpnEndpointRequest.Builder	connectionLogOptions(Consumer<ConnectionLogOptions.Builder> connectionLogOptions)	Information about the client connection logging options.
ModifyClientVpnEndpointRequest.Builder	connectionLogOptions(ConnectionLogOptions connectionLogOptions)	Information about the client connection logging options.
ModifyClientVpnEndpointRequest.Builder	description(String description)	A brief description of the Client VPN endpoint.
default ModifyClientVpnEndpointRequest.Builder	dnsServers(Consumer<DnsServersOptionsModifyStructure.Builder> dnsServers)	Information about the DNS servers to be used by Client VPN connections.
ModifyClientVpnEndpointRequest.Builder	dnsServers(DnsServersOptionsModifyStructure dnsServers)	Information about the DNS servers to be used by Client VPN connections.
ModifyClientVpnEndpointRequest.Builder	dryRun(Boolean dryRun)	Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
ModifyClientVpnEndpointRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ModifyClientVpnEndpointRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
ModifyClientVpnEndpointRequest.Builder	securityGroupIds(String... securityGroupIds)	The IDs of one or more security groups to apply to the target network.
ModifyClientVpnEndpointRequest.Builder	securityGroupIds(Collection<String> securityGroupIds)	The IDs of one or more security groups to apply to the target network.
ModifyClientVpnEndpointRequest.Builder	selfServicePortal(String selfServicePortal)	Specify whether to enable the self-service portal for the Client VPN endpoint.
ModifyClientVpnEndpointRequest.Builder	selfServicePortal(SelfServicePortal selfServicePortal)	Specify whether to enable the self-service portal for the Client VPN endpoint.
ModifyClientVpnEndpointRequest.Builder	serverCertificateArn(String serverCertificateArn)	The ARN of the server certificate to be used.
ModifyClientVpnEndpointRequest.Builder	sessionTimeoutHours(Integer sessionTimeoutHours)	The maximum VPN session duration time in hours.
ModifyClientVpnEndpointRequest.Builder	splitTunnel(Boolean splitTunnel)	Indicates whether the VPN is split-tunnel.
ModifyClientVpnEndpointRequest.Builder	vpcId(String vpcId)	The ID of the VPC to associate with the Client VPN endpoint.
ModifyClientVpnEndpointRequest.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.awscore.AwsRequest.Builder

overrideConfiguration

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

copy

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

build

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

applyMutation, build

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

equalsBySdkFields, sdkFields

Method Details

clientVpnEndpointId

ModifyClientVpnEndpointRequest.Builder clientVpnEndpointId(String clientVpnEndpointId)

The ID of the Client VPN endpoint to modify.

Parameters:

clientVpnEndpointId - The ID of the Client VPN endpoint to modify.

Returns:

Returns a reference to this object so that method calls can be chained together.

serverCertificateArn

ModifyClientVpnEndpointRequest.Builder serverCertificateArn(String serverCertificateArn)

The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM).

Parameters:

serverCertificateArn - The ARN of the server certificate to be used. The server certificate must be provisioned in Certificate Manager (ACM).

Returns:

Returns a reference to this object so that method calls can be chained together.

connectionLogOptions

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

ModifyClientVpnEndpointRequest.Builder dnsServers(DnsServersOptionsModifyStructure dnsServers)

Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.

Parameters:

dnsServers - Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.

Returns:

Returns a reference to this object so that method calls can be chained together.

dnsServers

default ModifyClientVpnEndpointRequest.Builder dnsServers(Consumer<DnsServersOptionsModifyStructure.Builder> dnsServers)

Information about the DNS servers to be used by Client VPN connections. A Client VPN endpoint can have up to two DNS servers.

This is a convenience method that creates an instance of the DnsServersOptionsModifyStructure.Builder avoiding the need to create one manually via DnsServersOptionsModifyStructure.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dnsServers(DnsServersOptionsModifyStructure).

Parameters:

dnsServers - a consumer that will call methods on DnsServersOptionsModifyStructure.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• dnsServers(DnsServersOptionsModifyStructure)

vpnPort

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

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

ModifyClientVpnEndpointRequest.Builder splitTunnel(Boolean splitTunnel)

Indicates whether the VPN is split-tunnel.

For information about split-tunnel VPN endpoints, see Split-tunnel Client VPN endpoint in the Client VPN Administrator Guide.

Parameters:

splitTunnel - Indicates whether the VPN is split-tunnel.

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.

dryRun

ModifyClientVpnEndpointRequest.Builder dryRun(Boolean dryRun)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Parameters:

dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Returns:

Returns a reference to this object so that method calls can be chained together.

securityGroupIds

ModifyClientVpnEndpointRequest.Builder securityGroupIds(Collection<String> securityGroupIds)

The IDs of one or more security groups to apply to the target network.

Parameters:

securityGroupIds - The IDs of one or more security groups to apply to the target network.

Returns:

Returns a reference to this object so that method calls can be chained together.

securityGroupIds

ModifyClientVpnEndpointRequest.Builder securityGroupIds(String... securityGroupIds)

The IDs of one or more security groups to apply to the target network.

Parameters:

securityGroupIds - The IDs of one or more security groups to apply to the target network.

Returns:

Returns a reference to this object so that method calls can be chained together.

vpcId

ModifyClientVpnEndpointRequest.Builder vpcId(String vpcId)

The ID of the VPC to associate with the Client VPN endpoint.

Parameters:

vpcId - The ID of the VPC to associate with the Client VPN endpoint.

Returns:

Returns a reference to this object so that method calls can be chained together.

selfServicePortal

ModifyClientVpnEndpointRequest.Builder selfServicePortal(String selfServicePortal)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• SelfServicePortal
• SelfServicePortal

selfServicePortal

ModifyClientVpnEndpointRequest.Builder selfServicePortal(SelfServicePortal selfServicePortal)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• SelfServicePortal
• SelfServicePortal

clientConnectOptions

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

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

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

ModifyClientVpnEndpointRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

ModifyClientVpnEndpointRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.