com.amazonaws.services.ec2.model

Class CreateClientVpnEndpointRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.CreateClientVpnEndpointRequest

All Implemented Interfaces:

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

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

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateClientVpnEndpointRequest()

Method Summary

Modifier and Type	Method and Description
CreateClientVpnEndpointRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
List<ClientVpnAuthenticationRequest>	getAuthenticationOptions() Information about the authentication method to be used to authenticate clients.
String	getClientCidrBlock() The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
String	getClientToken() Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
ConnectionLogOptions	getConnectionLogOptions() Information about the client connection logging options.
String	getDescription() A brief description of the Client VPN endpoint.
List<String>	getDnsServers() Information about the DNS servers to be used for DNS resolution.
Request<CreateClientVpnEndpointRequest>	getDryRunRequest() This method is intended for internal use only.
String	getServerCertificateArn() The ARN of the server certificate.
Boolean	getSplitTunnel() Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
List<TagSpecification>	getTagSpecifications() The tags to apply to the Client VPN endpoint during creation.
String	getTransportProtocol() The transport protocol to be used by the VPN session.
int	hashCode()
Boolean	isSplitTunnel() Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
void	setAuthenticationOptions(Collection<ClientVpnAuthenticationRequest> authenticationOptions) Information about the authentication method to be used to authenticate clients.
void	setClientCidrBlock(String clientCidrBlock) The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
void	setClientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
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(Collection<String> dnsServers) Information about the DNS servers to be used for DNS resolution.
void	setServerCertificateArn(String serverCertificateArn) The ARN of the server certificate.
void	setSplitTunnel(Boolean splitTunnel) Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
void	setTagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to apply to the Client VPN endpoint during creation.
void	setTransportProtocol(String transportProtocol) The transport protocol to be used by the VPN session.
String	toString() Returns a string representation of this object.
CreateClientVpnEndpointRequest	withAuthenticationOptions(ClientVpnAuthenticationRequest... authenticationOptions) Information about the authentication method to be used to authenticate clients.
CreateClientVpnEndpointRequest	withAuthenticationOptions(Collection<ClientVpnAuthenticationRequest> authenticationOptions) Information about the authentication method to be used to authenticate clients.
CreateClientVpnEndpointRequest	withClientCidrBlock(String clientCidrBlock) The IPv4 address range, in CIDR notation, from which to assign client IP addresses.
CreateClientVpnEndpointRequest	withClientToken(String clientToken) Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
CreateClientVpnEndpointRequest	withConnectionLogOptions(ConnectionLogOptions connectionLogOptions) Information about the client connection logging options.
CreateClientVpnEndpointRequest	withDescription(String description) A brief description of the Client VPN endpoint.
CreateClientVpnEndpointRequest	withDnsServers(Collection<String> dnsServers) Information about the DNS servers to be used for DNS resolution.
CreateClientVpnEndpointRequest	withDnsServers(String... dnsServers) Information about the DNS servers to be used for DNS resolution.
CreateClientVpnEndpointRequest	withServerCertificateArn(String serverCertificateArn) The ARN of the server certificate.
CreateClientVpnEndpointRequest	withSplitTunnel(Boolean splitTunnel) Indicates whether split-tunnel is enabled on the AWS Client VPN endpoint.
CreateClientVpnEndpointRequest	withTagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to apply to the Client VPN endpoint during creation.
CreateClientVpnEndpointRequest	withTagSpecifications(TagSpecification... tagSpecifications) The tags to apply to the Client VPN endpoint during creation.
CreateClientVpnEndpointRequest	withTransportProtocol(String transportProtocol) The transport protocol to be used by the VPN session.
CreateClientVpnEndpointRequest	withTransportProtocol(TransportProtocol transportProtocol) The transport protocol to be used by the VPN session.

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

CreateClientVpnEndpointRequest

public CreateClientVpnEndpointRequest()

Method Detail

setClientCidrBlock

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

getClientCidrBlock

public String getClientCidrBlock()

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:

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.

withClientCidrBlock

public CreateClientVpnEndpointRequest withClientCidrBlock(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.

setServerCertificateArn

public void setServerCertificateArn(String serverCertificateArn)

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

Parameters:

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

getServerCertificateArn

public String getServerCertificateArn()

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

Returns:

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

withServerCertificateArn

public CreateClientVpnEndpointRequest withServerCertificateArn(String serverCertificateArn)

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

Parameters:

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

Returns:

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

getAuthenticationOptions

public List<ClientVpnAuthenticationRequest> getAuthenticationOptions()

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

Returns:

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

setAuthenticationOptions

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

withAuthenticationOptions

public CreateClientVpnEndpointRequest withAuthenticationOptions(ClientVpnAuthenticationRequest... authenticationOptions)

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

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

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.

withAuthenticationOptions

public CreateClientVpnEndpointRequest withAuthenticationOptions(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.

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

getDnsServers

public List<String> getDnsServers()

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:

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.

setDnsServers

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

withDnsServers

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

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

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.

withDnsServers

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

setTransportProtocol

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

See Also:

TransportProtocol

getTransportProtocol

public String getTransportProtocol()

The transport protocol to be used by the VPN session.

Default value: udp

Returns:

The transport protocol to be used by the VPN session.

Default value: udp

See Also:

TransportProtocol

withTransportProtocol

public CreateClientVpnEndpointRequest withTransportProtocol(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

withTransportProtocol

public CreateClientVpnEndpointRequest withTransportProtocol(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

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

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.

getSplitTunnel

public Boolean getSplitTunnel()

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:

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.

withSplitTunnel

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

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:

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

isSplitTunnel

public Boolean isSplitTunnel()

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:

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.

setClientToken

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

getClientToken

public String getClientToken()

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

Returns:

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. For more information, see How to Ensure Idempotency.

withClientToken

public CreateClientVpnEndpointRequest withClientToken(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.

getTagSpecifications

public List<TagSpecification> getTagSpecifications()

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

Returns:

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

setTagSpecifications

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

withTagSpecifications

public CreateClientVpnEndpointRequest withTagSpecifications(TagSpecification... tagSpecifications)

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

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

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.

withTagSpecifications

public CreateClientVpnEndpointRequest withTagSpecifications(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.

getDryRunRequest

public Request<CreateClientVpnEndpointRequest> 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<CreateClientVpnEndpointRequest>

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 CreateClientVpnEndpointRequest 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()