com.amazonaws.services.ec2.model

Class ModifyClientVpnEndpointRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.ModifyClientVpnEndpointRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<ModifyClientVpnEndpointRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ModifyClientVpnEndpointRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<ModifyClientVpnEndpointRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
ModifyClientVpnEndpointRequest()

Method Summary

Modifier and Type	Method and Description
ModifyClientVpnEndpointRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
ClientConnectOptions	getClientConnectOptions() The options for managing connection authorization for new client connections.
ClientLoginBannerOptions	getClientLoginBannerOptions() Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
String	getClientVpnEndpointId() The ID of the Client VPN endpoint to modify.
ConnectionLogOptions	getConnectionLogOptions() Information about the client connection logging options.
String	getDescription() A brief description of the Client VPN endpoint.
DnsServersOptionsModifyStructure	getDnsServers() Information about the DNS servers to be used by Client VPN connections.
Request<ModifyClientVpnEndpointRequest>	getDryRunRequest() This method is intended for internal use only.
List<String>	getSecurityGroupIds() The IDs of one or more security groups to apply to the target network.
String	getSelfServicePortal() Specify whether to enable the self-service portal for the Client VPN endpoint.
String	getServerCertificateArn() The ARN of the server certificate to be used.
Integer	getSessionTimeoutHours() The maximum VPN session duration time in hours.
Boolean	getSplitTunnel() Indicates whether the VPN is split-tunnel.
String	getVpcId() The ID of the VPC to associate with the Client VPN endpoint.
Integer	getVpnPort() The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
int	hashCode()
Boolean	isSplitTunnel() Indicates whether the VPN is split-tunnel.
void	setClientConnectOptions(ClientConnectOptions clientConnectOptions) The options for managing connection authorization for new client connections.
void	setClientLoginBannerOptions(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.
void	setClientVpnEndpointId(String clientVpnEndpointId) The ID of the Client VPN endpoint to modify.
void	setConnectionLogOptions(ConnectionLogOptions connectionLogOptions) Information about the client connection logging options.
void	setDescription(String description) A brief description of the Client VPN endpoint.
void	setDnsServers(DnsServersOptionsModifyStructure dnsServers) Information about the DNS servers to be used by Client VPN connections.
void	setSecurityGroupIds(Collection<String> securityGroupIds) The IDs of one or more security groups to apply to the target network.
void	setSelfServicePortal(String selfServicePortal) Specify whether to enable the self-service portal for the Client VPN endpoint.
void	setServerCertificateArn(String serverCertificateArn) The ARN of the server certificate to be used.
void	setSessionTimeoutHours(Integer sessionTimeoutHours) The maximum VPN session duration time in hours.
void	setSplitTunnel(Boolean splitTunnel) Indicates whether the VPN is split-tunnel.
void	setVpcId(String vpcId) The ID of the VPC to associate with the Client VPN endpoint.
void	setVpnPort(Integer vpnPort) The port number to assign to the Client VPN endpoint for TCP and UDP traffic.
String	toString() Returns a string representation of this object.
ModifyClientVpnEndpointRequest	withClientConnectOptions(ClientConnectOptions clientConnectOptions) The options for managing connection authorization for new client connections.
ModifyClientVpnEndpointRequest	withClientLoginBannerOptions(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	withClientVpnEndpointId(String clientVpnEndpointId) The ID of the Client VPN endpoint to modify.
ModifyClientVpnEndpointRequest	withConnectionLogOptions(ConnectionLogOptions connectionLogOptions) Information about the client connection logging options.
ModifyClientVpnEndpointRequest	withDescription(String description) A brief description of the Client VPN endpoint.
ModifyClientVpnEndpointRequest	withDnsServers(DnsServersOptionsModifyStructure dnsServers) Information about the DNS servers to be used by Client VPN connections.
ModifyClientVpnEndpointRequest	withSecurityGroupIds(Collection<String> securityGroupIds) The IDs of one or more security groups to apply to the target network.
ModifyClientVpnEndpointRequest	withSecurityGroupIds(String... securityGroupIds) The IDs of one or more security groups to apply to the target network.
ModifyClientVpnEndpointRequest	withSelfServicePortal(SelfServicePortal selfServicePortal) Specify whether to enable the self-service portal for the Client VPN endpoint.
ModifyClientVpnEndpointRequest	withSelfServicePortal(String selfServicePortal) Specify whether to enable the self-service portal for the Client VPN endpoint.
ModifyClientVpnEndpointRequest	withServerCertificateArn(String serverCertificateArn) The ARN of the server certificate to be used.
ModifyClientVpnEndpointRequest	withSessionTimeoutHours(Integer sessionTimeoutHours) The maximum VPN session duration time in hours.
ModifyClientVpnEndpointRequest	withSplitTunnel(Boolean splitTunnel) Indicates whether the VPN is split-tunnel.
ModifyClientVpnEndpointRequest	withVpcId(String vpcId) The ID of the VPC to associate with the Client VPN endpoint.
ModifyClientVpnEndpointRequest	withVpnPort(Integer vpnPort) The port number to assign to the Client VPN endpoint for TCP and UDP traffic.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ModifyClientVpnEndpointRequest

public ModifyClientVpnEndpointRequest()

Method Detail

setClientVpnEndpointId

public void setClientVpnEndpointId(String clientVpnEndpointId)

The ID of the Client VPN endpoint to modify.

Parameters:

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

getClientVpnEndpointId

public String getClientVpnEndpointId()

The ID of the Client VPN endpoint to modify.

Returns:

The ID of the Client VPN endpoint to modify.

withClientVpnEndpointId

public ModifyClientVpnEndpointRequest withClientVpnEndpointId(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.

setServerCertificateArn

public void setServerCertificateArn(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).

getServerCertificateArn

public String getServerCertificateArn()

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

Returns:

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

withServerCertificateArn

public ModifyClientVpnEndpointRequest withServerCertificateArn(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.

setConnectionLogOptions

public void setConnectionLogOptions(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

getConnectionLogOptions

public ConnectionLogOptions getConnectionLogOptions()

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:

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

withConnectionLogOptions

public ModifyClientVpnEndpointRequest withConnectionLogOptions(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.

setDnsServers

public void setDnsServers(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.

getDnsServers

public DnsServersOptionsModifyStructure getDnsServers()

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

Returns:

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

withDnsServers

public ModifyClientVpnEndpointRequest withDnsServers(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.

setVpnPort

public void setVpnPort(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

getVpnPort

public Integer getVpnPort()

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

Valid Values: 443 | 1194

Default Value: 443

Returns:

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

Valid Values: 443 | 1194

Default Value: 443

withVpnPort

public ModifyClientVpnEndpointRequest withVpnPort(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.

setDescription

public void setDescription(String description)

A brief description of the Client VPN endpoint.

Parameters:

description - A brief description of the Client VPN endpoint.

getDescription

public String getDescription()

A brief description of the Client VPN endpoint.

Returns:

A brief description of the Client VPN endpoint.

withDescription

public ModifyClientVpnEndpointRequest withDescription(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.

setSplitTunnel

public void setSplitTunnel(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.

getSplitTunnel

public Boolean getSplitTunnel()

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:

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.

withSplitTunnel

public ModifyClientVpnEndpointRequest withSplitTunnel(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.

isSplitTunnel

public Boolean isSplitTunnel()

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:

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.

getSecurityGroupIds

public List<String> getSecurityGroupIds()

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

Returns:

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

setSecurityGroupIds

public void setSecurityGroupIds(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.

withSecurityGroupIds

public ModifyClientVpnEndpointRequest withSecurityGroupIds(String... securityGroupIds)

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

NOTE: This method appends the values to the existing list (if any). Use setSecurityGroupIds(java.util.Collection) or withSecurityGroupIds(java.util.Collection) if you want to override the existing values.

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.

withSecurityGroupIds

public ModifyClientVpnEndpointRequest withSecurityGroupIds(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.

setVpcId

public void setVpcId(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.

getVpcId

public String getVpcId()

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

Returns:

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

withVpcId

public ModifyClientVpnEndpointRequest withVpcId(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.

setSelfServicePortal

public void setSelfServicePortal(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.

See Also:

SelfServicePortal

getSelfServicePortal

public String getSelfServicePortal()

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

Returns:

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

See Also:

SelfServicePortal

withSelfServicePortal

public ModifyClientVpnEndpointRequest withSelfServicePortal(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

withSelfServicePortal

public ModifyClientVpnEndpointRequest withSelfServicePortal(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

setClientConnectOptions

public void setClientConnectOptions(ClientConnectOptions clientConnectOptions)

The options for managing connection authorization for new client connections.

Parameters:

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

getClientConnectOptions

public ClientConnectOptions getClientConnectOptions()

The options for managing connection authorization for new client connections.

Returns:

The options for managing connection authorization for new client connections.

withClientConnectOptions

public ModifyClientVpnEndpointRequest withClientConnectOptions(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.

setSessionTimeoutHours

public void setSessionTimeoutHours(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

getSessionTimeoutHours

public Integer getSessionTimeoutHours()

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

Returns:

The maximum VPN session duration time in hours.

Valid values: 8 | 10 | 12 | 24

Default value: 24

withSessionTimeoutHours

public ModifyClientVpnEndpointRequest withSessionTimeoutHours(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.

setClientLoginBannerOptions

public void setClientLoginBannerOptions(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.

getClientLoginBannerOptions

public ClientLoginBannerOptions getClientLoginBannerOptions()

Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

Returns:

Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.

withClientLoginBannerOptions

public ModifyClientVpnEndpointRequest withClientLoginBannerOptions(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.

getDryRunRequest

public Request<ModifyClientVpnEndpointRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<ModifyClientVpnEndpointRequest>

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public ModifyClientVpnEndpointRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()