@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ClientVpnEndpoint extends Object implements Serializable, Cloneable
Describes a Client VPN endpoint.
Constructor and Description |
---|
ClientVpnEndpoint() |
Modifier and Type | Method and Description |
---|---|
ClientVpnEndpoint |
clone() |
boolean |
equals(Object obj) |
List<AssociatedTargetNetwork> |
getAssociatedTargetNetworks()
Deprecated.
|
List<ClientVpnAuthentication> |
getAuthenticationOptions()
Information about the authentication method used by the Client VPN endpoint.
|
String |
getClientCidrBlock()
The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
|
ClientConnectResponseOptions |
getClientConnectOptions()
The options for managing connection authorization for new client connections.
|
ClientLoginBannerResponseOptions |
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.
|
ConnectionLogResponseOptions |
getConnectionLogOptions()
Information about the client connection logging options for the Client VPN endpoint.
|
String |
getCreationTime()
The date and time the Client VPN endpoint was created.
|
String |
getDeletionTime()
The date and time the Client VPN endpoint was deleted, if applicable.
|
String |
getDescription()
A brief description of the endpoint.
|
String |
getDnsName()
The DNS name to be used by clients when connecting to the Client VPN endpoint.
|
List<String> |
getDnsServers()
Information about the DNS servers to be used for DNS resolution.
|
List<String> |
getSecurityGroupIds()
The IDs of the security groups for the target network.
|
String |
getSelfServicePortalUrl()
The URL of the self-service portal.
|
String |
getServerCertificateArn()
The ARN of the server certificate.
|
Integer |
getSessionTimeoutHours()
The maximum VPN session duration time in hours.
|
Boolean |
getSplitTunnel()
Indicates whether split-tunnel is enabled in the Client VPN endpoint.
|
ClientVpnEndpointStatus |
getStatus()
The current state of the Client VPN endpoint.
|
List<Tag> |
getTags()
Any tags assigned to the Client VPN endpoint.
|
String |
getTransportProtocol()
The transport protocol used by the Client VPN endpoint.
|
String |
getVpcId()
The ID of the VPC.
|
Integer |
getVpnPort()
The port number for the Client VPN endpoint.
|
String |
getVpnProtocol()
The protocol used by the VPN session.
|
int |
hashCode() |
Boolean |
isSplitTunnel()
Indicates whether split-tunnel is enabled in the Client VPN endpoint.
|
void |
setAssociatedTargetNetworks(Collection<AssociatedTargetNetwork> associatedTargetNetworks)
Deprecated.
|
void |
setAuthenticationOptions(Collection<ClientVpnAuthentication> authenticationOptions)
Information about the authentication method used by the Client VPN endpoint.
|
void |
setClientCidrBlock(String clientCidrBlock)
The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
|
void |
setClientConnectOptions(ClientConnectResponseOptions clientConnectOptions)
The options for managing connection authorization for new client connections.
|
void |
setClientLoginBannerOptions(ClientLoginBannerResponseOptions 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.
|
void |
setConnectionLogOptions(ConnectionLogResponseOptions connectionLogOptions)
Information about the client connection logging options for the Client VPN endpoint.
|
void |
setCreationTime(String creationTime)
The date and time the Client VPN endpoint was created.
|
void |
setDeletionTime(String deletionTime)
The date and time the Client VPN endpoint was deleted, if applicable.
|
void |
setDescription(String description)
A brief description of the endpoint.
|
void |
setDnsName(String dnsName)
The DNS name to be used by clients when connecting to the Client VPN endpoint.
|
void |
setDnsServers(Collection<String> dnsServers)
Information about the DNS servers to be used for DNS resolution.
|
void |
setSecurityGroupIds(Collection<String> securityGroupIds)
The IDs of the security groups for the target network.
|
void |
setSelfServicePortalUrl(String selfServicePortalUrl)
The URL of the self-service portal.
|
void |
setServerCertificateArn(String serverCertificateArn)
The ARN of the server certificate.
|
void |
setSessionTimeoutHours(Integer sessionTimeoutHours)
The maximum VPN session duration time in hours.
|
void |
setSplitTunnel(Boolean splitTunnel)
Indicates whether split-tunnel is enabled in the Client VPN endpoint.
|
void |
setStatus(ClientVpnEndpointStatus status)
The current state of the Client VPN endpoint.
|
void |
setTags(Collection<Tag> tags)
Any tags assigned to the Client VPN endpoint.
|
void |
setTransportProtocol(String transportProtocol)
The transport protocol used by the Client VPN endpoint.
|
void |
setVpcId(String vpcId)
The ID of the VPC.
|
void |
setVpnPort(Integer vpnPort)
The port number for the Client VPN endpoint.
|
void |
setVpnProtocol(String vpnProtocol)
The protocol used by the VPN session.
|
String |
toString()
Returns a string representation of this object.
|
ClientVpnEndpoint |
withAssociatedTargetNetworks(AssociatedTargetNetwork... associatedTargetNetworks)
Deprecated.
|
ClientVpnEndpoint |
withAssociatedTargetNetworks(Collection<AssociatedTargetNetwork> associatedTargetNetworks)
Deprecated.
|
ClientVpnEndpoint |
withAuthenticationOptions(ClientVpnAuthentication... authenticationOptions)
Information about the authentication method used by the Client VPN endpoint.
|
ClientVpnEndpoint |
withAuthenticationOptions(Collection<ClientVpnAuthentication> authenticationOptions)
Information about the authentication method used by the Client VPN endpoint.
|
ClientVpnEndpoint |
withClientCidrBlock(String clientCidrBlock)
The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
|
ClientVpnEndpoint |
withClientConnectOptions(ClientConnectResponseOptions clientConnectOptions)
The options for managing connection authorization for new client connections.
|
ClientVpnEndpoint |
withClientLoginBannerOptions(ClientLoginBannerResponseOptions clientLoginBannerOptions)
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients
when a VPN session is established.
|
ClientVpnEndpoint |
withClientVpnEndpointId(String clientVpnEndpointId)
The ID of the Client VPN endpoint.
|
ClientVpnEndpoint |
withConnectionLogOptions(ConnectionLogResponseOptions connectionLogOptions)
Information about the client connection logging options for the Client VPN endpoint.
|
ClientVpnEndpoint |
withCreationTime(String creationTime)
The date and time the Client VPN endpoint was created.
|
ClientVpnEndpoint |
withDeletionTime(String deletionTime)
The date and time the Client VPN endpoint was deleted, if applicable.
|
ClientVpnEndpoint |
withDescription(String description)
A brief description of the endpoint.
|
ClientVpnEndpoint |
withDnsName(String dnsName)
The DNS name to be used by clients when connecting to the Client VPN endpoint.
|
ClientVpnEndpoint |
withDnsServers(Collection<String> dnsServers)
Information about the DNS servers to be used for DNS resolution.
|
ClientVpnEndpoint |
withDnsServers(String... dnsServers)
Information about the DNS servers to be used for DNS resolution.
|
ClientVpnEndpoint |
withSecurityGroupIds(Collection<String> securityGroupIds)
The IDs of the security groups for the target network.
|
ClientVpnEndpoint |
withSecurityGroupIds(String... securityGroupIds)
The IDs of the security groups for the target network.
|
ClientVpnEndpoint |
withSelfServicePortalUrl(String selfServicePortalUrl)
The URL of the self-service portal.
|
ClientVpnEndpoint |
withServerCertificateArn(String serverCertificateArn)
The ARN of the server certificate.
|
ClientVpnEndpoint |
withSessionTimeoutHours(Integer sessionTimeoutHours)
The maximum VPN session duration time in hours.
|
ClientVpnEndpoint |
withSplitTunnel(Boolean splitTunnel)
Indicates whether split-tunnel is enabled in the Client VPN endpoint.
|
ClientVpnEndpoint |
withStatus(ClientVpnEndpointStatus status)
The current state of the Client VPN endpoint.
|
ClientVpnEndpoint |
withTags(Collection<Tag> tags)
Any tags assigned to the Client VPN endpoint.
|
ClientVpnEndpoint |
withTags(Tag... tags)
Any tags assigned to the Client VPN endpoint.
|
ClientVpnEndpoint |
withTransportProtocol(String transportProtocol)
The transport protocol used by the Client VPN endpoint.
|
ClientVpnEndpoint |
withTransportProtocol(TransportProtocol transportProtocol)
The transport protocol used by the Client VPN endpoint.
|
ClientVpnEndpoint |
withVpcId(String vpcId)
The ID of the VPC.
|
ClientVpnEndpoint |
withVpnPort(Integer vpnPort)
The port number for the Client VPN endpoint.
|
ClientVpnEndpoint |
withVpnProtocol(String vpnProtocol)
The protocol used by the VPN session.
|
ClientVpnEndpoint |
withVpnProtocol(VpnProtocol vpnProtocol)
The protocol used by the VPN session.
|
public void setClientVpnEndpointId(String clientVpnEndpointId)
The ID of the Client VPN endpoint.
clientVpnEndpointId
- The ID of the Client VPN endpoint.public String getClientVpnEndpointId()
The ID of the Client VPN endpoint.
public ClientVpnEndpoint withClientVpnEndpointId(String clientVpnEndpointId)
The ID of the Client VPN endpoint.
clientVpnEndpointId
- The ID of the Client VPN endpoint.public void setDescription(String description)
A brief description of the endpoint.
description
- A brief description of the endpoint.public String getDescription()
A brief description of the endpoint.
public ClientVpnEndpoint withDescription(String description)
A brief description of the endpoint.
description
- A brief description of the endpoint.public void setStatus(ClientVpnEndpointStatus status)
The current state of the Client VPN endpoint.
status
- The current state of the Client VPN endpoint.public ClientVpnEndpointStatus getStatus()
The current state of the Client VPN endpoint.
public ClientVpnEndpoint withStatus(ClientVpnEndpointStatus status)
The current state of the Client VPN endpoint.
status
- The current state of the Client VPN endpoint.public void setCreationTime(String creationTime)
The date and time the Client VPN endpoint was created.
creationTime
- The date and time the Client VPN endpoint was created.public String getCreationTime()
The date and time the Client VPN endpoint was created.
public ClientVpnEndpoint withCreationTime(String creationTime)
The date and time the Client VPN endpoint was created.
creationTime
- The date and time the Client VPN endpoint was created.public void setDeletionTime(String deletionTime)
The date and time the Client VPN endpoint was deleted, if applicable.
deletionTime
- The date and time the Client VPN endpoint was deleted, if applicable.public String getDeletionTime()
The date and time the Client VPN endpoint was deleted, if applicable.
public ClientVpnEndpoint withDeletionTime(String deletionTime)
The date and time the Client VPN endpoint was deleted, if applicable.
deletionTime
- The date and time the Client VPN endpoint was deleted, if applicable.public void setDnsName(String dnsName)
The DNS name to be used by clients when connecting to the Client VPN endpoint.
dnsName
- The DNS name to be used by clients when connecting to the Client VPN endpoint.public String getDnsName()
The DNS name to be used by clients when connecting to the Client VPN endpoint.
public ClientVpnEndpoint withDnsName(String dnsName)
The DNS name to be used by clients when connecting to the Client VPN endpoint.
dnsName
- The DNS name to be used by clients when connecting to the Client VPN endpoint.public void setClientCidrBlock(String clientCidrBlock)
The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
clientCidrBlock
- The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.public String getClientCidrBlock()
The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
public ClientVpnEndpoint withClientCidrBlock(String clientCidrBlock)
The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
clientCidrBlock
- The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.public List<String> getDnsServers()
Information about the DNS servers to be used for DNS resolution.
public void setDnsServers(Collection<String> dnsServers)
Information about the DNS servers to be used for DNS resolution.
dnsServers
- Information about the DNS servers to be used for DNS resolution.public ClientVpnEndpoint withDnsServers(String... dnsServers)
Information about the DNS servers to be used for DNS resolution.
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.
dnsServers
- Information about the DNS servers to be used for DNS resolution.public ClientVpnEndpoint withDnsServers(Collection<String> dnsServers)
Information about the DNS servers to be used for DNS resolution.
dnsServers
- Information about the DNS servers to be used for DNS resolution.public void setSplitTunnel(Boolean splitTunnel)
Indicates whether split-tunnel is enabled in the Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
splitTunnel
- Indicates whether split-tunnel is enabled in the Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
public Boolean getSplitTunnel()
Indicates whether split-tunnel is enabled in the Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
public ClientVpnEndpoint withSplitTunnel(Boolean splitTunnel)
Indicates whether split-tunnel is enabled in the Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
splitTunnel
- Indicates whether split-tunnel is enabled in the Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
public Boolean isSplitTunnel()
Indicates whether split-tunnel is enabled in the Client VPN endpoint.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
For information about split-tunnel VPN endpoints, see Split-Tunnel Client VPN endpoint in the Client VPN Administrator Guide.
public void setVpnProtocol(String vpnProtocol)
The protocol used by the VPN session.
vpnProtocol
- The protocol used by the VPN session.VpnProtocol
public String getVpnProtocol()
The protocol used by the VPN session.
VpnProtocol
public ClientVpnEndpoint withVpnProtocol(String vpnProtocol)
The protocol used by the VPN session.
vpnProtocol
- The protocol used by the VPN session.VpnProtocol
public ClientVpnEndpoint withVpnProtocol(VpnProtocol vpnProtocol)
The protocol used by the VPN session.
vpnProtocol
- The protocol used by the VPN session.VpnProtocol
public void setTransportProtocol(String transportProtocol)
The transport protocol used by the Client VPN endpoint.
transportProtocol
- The transport protocol used by the Client VPN endpoint.TransportProtocol
public String getTransportProtocol()
The transport protocol used by the Client VPN endpoint.
TransportProtocol
public ClientVpnEndpoint withTransportProtocol(String transportProtocol)
The transport protocol used by the Client VPN endpoint.
transportProtocol
- The transport protocol used by the Client VPN endpoint.TransportProtocol
public ClientVpnEndpoint withTransportProtocol(TransportProtocol transportProtocol)
The transport protocol used by the Client VPN endpoint.
transportProtocol
- The transport protocol used by the Client VPN endpoint.TransportProtocol
public void setVpnPort(Integer vpnPort)
The port number for the Client VPN endpoint.
vpnPort
- The port number for the Client VPN endpoint.public Integer getVpnPort()
The port number for the Client VPN endpoint.
public ClientVpnEndpoint withVpnPort(Integer vpnPort)
The port number for the Client VPN endpoint.
vpnPort
- The port number for the Client VPN endpoint.@Deprecated public List<AssociatedTargetNetwork> getAssociatedTargetNetworks()
Information about the associated target networks. A target network is a subnet in a VPC.
@Deprecated public void setAssociatedTargetNetworks(Collection<AssociatedTargetNetwork> associatedTargetNetworks)
Information about the associated target networks. A target network is a subnet in a VPC.
associatedTargetNetworks
- Information about the associated target networks. A target network is a subnet in a VPC.@Deprecated public ClientVpnEndpoint withAssociatedTargetNetworks(AssociatedTargetNetwork... associatedTargetNetworks)
Information about the associated target networks. A target network is a subnet in a VPC.
NOTE: This method appends the values to the existing list (if any). Use
setAssociatedTargetNetworks(java.util.Collection)
or
withAssociatedTargetNetworks(java.util.Collection)
if you want to override the existing values.
associatedTargetNetworks
- Information about the associated target networks. A target network is a subnet in a VPC.@Deprecated public ClientVpnEndpoint withAssociatedTargetNetworks(Collection<AssociatedTargetNetwork> associatedTargetNetworks)
Information about the associated target networks. A target network is a subnet in a VPC.
associatedTargetNetworks
- Information about the associated target networks. A target network is a subnet in a VPC.public void setServerCertificateArn(String serverCertificateArn)
The ARN of the server certificate.
serverCertificateArn
- The ARN of the server certificate.public String getServerCertificateArn()
The ARN of the server certificate.
public ClientVpnEndpoint withServerCertificateArn(String serverCertificateArn)
The ARN of the server certificate.
serverCertificateArn
- The ARN of the server certificate.public List<ClientVpnAuthentication> getAuthenticationOptions()
Information about the authentication method used by the Client VPN endpoint.
public void setAuthenticationOptions(Collection<ClientVpnAuthentication> authenticationOptions)
Information about the authentication method used by the Client VPN endpoint.
authenticationOptions
- Information about the authentication method used by the Client VPN endpoint.public ClientVpnEndpoint withAuthenticationOptions(ClientVpnAuthentication... authenticationOptions)
Information about the authentication method used by the Client VPN endpoint.
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.
authenticationOptions
- Information about the authentication method used by the Client VPN endpoint.public ClientVpnEndpoint withAuthenticationOptions(Collection<ClientVpnAuthentication> authenticationOptions)
Information about the authentication method used by the Client VPN endpoint.
authenticationOptions
- Information about the authentication method used by the Client VPN endpoint.public void setConnectionLogOptions(ConnectionLogResponseOptions connectionLogOptions)
Information about the client connection logging options for the Client VPN endpoint.
connectionLogOptions
- Information about the client connection logging options for the Client VPN endpoint.public ConnectionLogResponseOptions getConnectionLogOptions()
Information about the client connection logging options for the Client VPN endpoint.
public ClientVpnEndpoint withConnectionLogOptions(ConnectionLogResponseOptions connectionLogOptions)
Information about the client connection logging options for the Client VPN endpoint.
connectionLogOptions
- Information about the client connection logging options for the Client VPN endpoint.public List<Tag> getTags()
Any tags assigned to the Client VPN endpoint.
public void setTags(Collection<Tag> tags)
Any tags assigned to the Client VPN endpoint.
tags
- Any tags assigned to the Client VPN endpoint.public ClientVpnEndpoint withTags(Tag... tags)
Any tags assigned to the Client VPN endpoint.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
tags
- Any tags assigned to the Client VPN endpoint.public ClientVpnEndpoint withTags(Collection<Tag> tags)
Any tags assigned to the Client VPN endpoint.
tags
- Any tags assigned to the Client VPN endpoint.public List<String> getSecurityGroupIds()
The IDs of the security groups for the target network.
public void setSecurityGroupIds(Collection<String> securityGroupIds)
The IDs of the security groups for the target network.
securityGroupIds
- The IDs of the security groups for the target network.public ClientVpnEndpoint withSecurityGroupIds(String... securityGroupIds)
The IDs of the security groups for 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.
securityGroupIds
- The IDs of the security groups for the target network.public ClientVpnEndpoint withSecurityGroupIds(Collection<String> securityGroupIds)
The IDs of the security groups for the target network.
securityGroupIds
- The IDs of the security groups for the target network.public void setVpcId(String vpcId)
The ID of the VPC.
vpcId
- The ID of the VPC.public String getVpcId()
The ID of the VPC.
public ClientVpnEndpoint withVpcId(String vpcId)
The ID of the VPC.
vpcId
- The ID of the VPC.public void setSelfServicePortalUrl(String selfServicePortalUrl)
The URL of the self-service portal.
selfServicePortalUrl
- The URL of the self-service portal.public String getSelfServicePortalUrl()
The URL of the self-service portal.
public ClientVpnEndpoint withSelfServicePortalUrl(String selfServicePortalUrl)
The URL of the self-service portal.
selfServicePortalUrl
- The URL of the self-service portal.public void setClientConnectOptions(ClientConnectResponseOptions clientConnectOptions)
The options for managing connection authorization for new client connections.
clientConnectOptions
- The options for managing connection authorization for new client connections.public ClientConnectResponseOptions getClientConnectOptions()
The options for managing connection authorization for new client connections.
public ClientVpnEndpoint withClientConnectOptions(ClientConnectResponseOptions clientConnectOptions)
The options for managing connection authorization for new client connections.
clientConnectOptions
- The options for managing connection authorization for new client connections.public void setSessionTimeoutHours(Integer sessionTimeoutHours)
The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
sessionTimeoutHours
- The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
public Integer getSessionTimeoutHours()
The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
Valid values: 8 | 10 | 12 | 24
Default value: 24
public ClientVpnEndpoint withSessionTimeoutHours(Integer sessionTimeoutHours)
The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
sessionTimeoutHours
- The maximum VPN session duration time in hours.
Valid values: 8 | 10 | 12 | 24
Default value: 24
public void setClientLoginBannerOptions(ClientLoginBannerResponseOptions clientLoginBannerOptions)
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
clientLoginBannerOptions
- Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided
clients when a VPN session is established.public ClientLoginBannerResponseOptions getClientLoginBannerOptions()
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
public ClientVpnEndpoint withClientLoginBannerOptions(ClientLoginBannerResponseOptions clientLoginBannerOptions)
Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients when a VPN session is established.
clientLoginBannerOptions
- Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided
clients when a VPN session is established.public String toString()
toString
in class Object
Object.toString()
public ClientVpnEndpoint clone()