com.amazonaws.services.ec2.model.ClientVpnEndpoint Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ec2 Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ec2.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Describes a Client VPN endpoint.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ClientVpnEndpoint implements Serializable, Cloneable {
/**
*
* The ID of the Client VPN endpoint.
*
*/
private String clientVpnEndpointId;
/**
*
* A brief description of the endpoint.
*
*/
private String description;
/**
*
* The current state of the Client VPN endpoint.
*
*/
private ClientVpnEndpointStatus status;
/**
*
* The date and time the Client VPN endpoint was created.
*
*/
private String creationTime;
/**
*
* The date and time the Client VPN endpoint was deleted, if applicable.
*
*/
private String deletionTime;
/**
*
* The DNS name to be used by clients when connecting to the Client VPN endpoint.
*
*/
private String dnsName;
/**
*
* The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
*
*/
private String clientCidrBlock;
/**
*
* Information about the DNS servers to be used for DNS resolution.
*
*/
private com.amazonaws.internal.SdkInternalList dnsServers;
/**
*
* 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.
*
*/
private Boolean splitTunnel;
/**
*
* The protocol used by the VPN session.
*
*/
private String vpnProtocol;
/**
*
* The transport protocol used by the Client VPN endpoint.
*
*/
private String transportProtocol;
/**
*
* The port number for the Client VPN endpoint.
*
*/
private Integer vpnPort;
/**
*
* Information about the associated target networks. A target network is a subnet in a VPC.
*
*/
@Deprecated
private com.amazonaws.internal.SdkInternalList associatedTargetNetworks;
/**
*
* The ARN of the server certificate.
*
*/
private String serverCertificateArn;
/**
*
* Information about the authentication method used by the Client VPN endpoint.
*
*/
private com.amazonaws.internal.SdkInternalList authenticationOptions;
/**
*
* Information about the client connection logging options for the Client VPN endpoint.
*
*/
private ConnectionLogResponseOptions connectionLogOptions;
/**
*
* Any tags assigned to the Client VPN endpoint.
*
*/
private com.amazonaws.internal.SdkInternalList tags;
/**
*
* The IDs of the security groups for the target network.
*
*/
private com.amazonaws.internal.SdkInternalList securityGroupIds;
/**
*
* The ID of the VPC.
*
*/
private String vpcId;
/**
*
* The URL of the self-service portal.
*
*/
private String selfServicePortalUrl;
/**
*
* The options for managing connection authorization for new client connections.
*
*/
private ClientConnectResponseOptions clientConnectOptions;
/**
*
* The maximum VPN session duration time in hours.
*
*
* Valid values: 8 | 10 | 12 | 24
*
*
* Default value: 24
*
*/
private Integer sessionTimeoutHours;
/**
*
* Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients
* when a VPN session is established.
*
*/
private ClientLoginBannerResponseOptions clientLoginBannerOptions;
/**
*
* The ID of the Client VPN endpoint.
*
*
* @param clientVpnEndpointId
* The ID of the Client VPN endpoint.
*/
public void setClientVpnEndpointId(String clientVpnEndpointId) {
this.clientVpnEndpointId = clientVpnEndpointId;
}
/**
*
* The ID of the Client VPN endpoint.
*
*
* @return The ID of the Client VPN endpoint.
*/
public String getClientVpnEndpointId() {
return this.clientVpnEndpointId;
}
/**
*
* The ID of the Client VPN endpoint.
*
*
* @param clientVpnEndpointId
* The ID of the Client VPN endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withClientVpnEndpointId(String clientVpnEndpointId) {
setClientVpnEndpointId(clientVpnEndpointId);
return this;
}
/**
*
* A brief description of the endpoint.
*
*
* @param description
* A brief description of the endpoint.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* A brief description of the endpoint.
*
*
* @return A brief description of the endpoint.
*/
public String getDescription() {
return this.description;
}
/**
*
* A brief description of the endpoint.
*
*
* @param description
* A brief description of the endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* The current state of the Client VPN endpoint.
*
*
* @param status
* The current state of the Client VPN endpoint.
*/
public void setStatus(ClientVpnEndpointStatus status) {
this.status = status;
}
/**
*
* The current state of the Client VPN endpoint.
*
*
* @return The current state of the Client VPN endpoint.
*/
public ClientVpnEndpointStatus getStatus() {
return this.status;
}
/**
*
* The current state of the Client VPN endpoint.
*
*
* @param status
* The current state of the Client VPN endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withStatus(ClientVpnEndpointStatus status) {
setStatus(status);
return this;
}
/**
*
* The date and time the Client VPN endpoint was created.
*
*
* @param creationTime
* The date and time the Client VPN endpoint was created.
*/
public void setCreationTime(String creationTime) {
this.creationTime = creationTime;
}
/**
*
* The date and time the Client VPN endpoint was created.
*
*
* @return The date and time the Client VPN endpoint was created.
*/
public String getCreationTime() {
return this.creationTime;
}
/**
*
* The date and time the Client VPN endpoint was created.
*
*
* @param creationTime
* The date and time the Client VPN endpoint was created.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withCreationTime(String creationTime) {
setCreationTime(creationTime);
return this;
}
/**
*
* The date and time the Client VPN endpoint was deleted, if applicable.
*
*
* @param deletionTime
* The date and time the Client VPN endpoint was deleted, if applicable.
*/
public void setDeletionTime(String deletionTime) {
this.deletionTime = deletionTime;
}
/**
*
* The date and time the Client VPN endpoint was deleted, if applicable.
*
*
* @return The date and time the Client VPN endpoint was deleted, if applicable.
*/
public String getDeletionTime() {
return this.deletionTime;
}
/**
*
* The date and time the Client VPN endpoint was deleted, if applicable.
*
*
* @param deletionTime
* The date and time the Client VPN endpoint was deleted, if applicable.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withDeletionTime(String deletionTime) {
setDeletionTime(deletionTime);
return this;
}
/**
*
* The DNS name to be used by clients when connecting to the Client VPN endpoint.
*
*
* @param dnsName
* The DNS name to be used by clients when connecting to the Client VPN endpoint.
*/
public void setDnsName(String dnsName) {
this.dnsName = dnsName;
}
/**
*
* The DNS name to be used by clients when connecting to the Client VPN endpoint.
*
*
* @return The DNS name to be used by clients when connecting to the Client VPN endpoint.
*/
public String getDnsName() {
return this.dnsName;
}
/**
*
* The DNS name to be used by clients when connecting to the Client VPN endpoint.
*
*
* @param dnsName
* The DNS name to be used by clients when connecting to the Client VPN endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withDnsName(String dnsName) {
setDnsName(dnsName);
return this;
}
/**
*
* The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
*
*
* @param clientCidrBlock
* The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
*/
public void setClientCidrBlock(String clientCidrBlock) {
this.clientCidrBlock = clientCidrBlock;
}
/**
*
* The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
*
*
* @return The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
*/
public String getClientCidrBlock() {
return this.clientCidrBlock;
}
/**
*
* The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
*
*
* @param clientCidrBlock
* The IPv4 address range, in CIDR notation, from which client IP addresses are assigned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withClientCidrBlock(String clientCidrBlock) {
setClientCidrBlock(clientCidrBlock);
return this;
}
/**
*
* Information about the DNS servers to be used for DNS resolution.
*
*
* @return Information about the DNS servers to be used for DNS resolution.
*/
public java.util.List getDnsServers() {
if (dnsServers == null) {
dnsServers = new com.amazonaws.internal.SdkInternalList();
}
return dnsServers;
}
/**
*
* Information about the DNS servers to be used for DNS resolution.
*
*
* @param dnsServers
* Information about the DNS servers to be used for DNS resolution.
*/
public void setDnsServers(java.util.Collection dnsServers) {
if (dnsServers == null) {
this.dnsServers = null;
return;
}
this.dnsServers = new com.amazonaws.internal.SdkInternalList(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
* {@link #setDnsServers(java.util.Collection)} or {@link #withDnsServers(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param dnsServers
* Information about the DNS servers to be used for DNS resolution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withDnsServers(String... dnsServers) {
if (this.dnsServers == null) {
setDnsServers(new com.amazonaws.internal.SdkInternalList(dnsServers.length));
}
for (String ele : dnsServers) {
this.dnsServers.add(ele);
}
return this;
}
/**
*
* Information about the DNS servers to be used for DNS resolution.
*
*
* @param dnsServers
* Information about the DNS servers to be used for DNS resolution.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withDnsServers(java.util.Collection dnsServers) {
setDnsServers(dnsServers);
return this;
}
/**
*
* 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.
*
*
* @param 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 void setSplitTunnel(Boolean splitTunnel) {
this.splitTunnel = 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.
*
*
* @return 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() {
return this.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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withSplitTunnel(Boolean splitTunnel) {
setSplitTunnel(splitTunnel);
return this;
}
/**
*
* 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.
*
*
* @return 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() {
return this.splitTunnel;
}
/**
*
* The protocol used by the VPN session.
*
*
* @param vpnProtocol
* The protocol used by the VPN session.
* @see VpnProtocol
*/
public void setVpnProtocol(String vpnProtocol) {
this.vpnProtocol = vpnProtocol;
}
/**
*
* The protocol used by the VPN session.
*
*
* @return The protocol used by the VPN session.
* @see VpnProtocol
*/
public String getVpnProtocol() {
return this.vpnProtocol;
}
/**
*
* The protocol used by the VPN session.
*
*
* @param vpnProtocol
* The protocol used by the VPN session.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VpnProtocol
*/
public ClientVpnEndpoint withVpnProtocol(String vpnProtocol) {
setVpnProtocol(vpnProtocol);
return this;
}
/**
*
* The protocol used by the VPN session.
*
*
* @param vpnProtocol
* The protocol used by the VPN session.
* @return Returns a reference to this object so that method calls can be chained together.
* @see VpnProtocol
*/
public ClientVpnEndpoint withVpnProtocol(VpnProtocol vpnProtocol) {
this.vpnProtocol = vpnProtocol.toString();
return this;
}
/**
*
* The transport protocol used by the Client VPN endpoint.
*
*
* @param transportProtocol
* The transport protocol used by the Client VPN endpoint.
* @see TransportProtocol
*/
public void setTransportProtocol(String transportProtocol) {
this.transportProtocol = transportProtocol;
}
/**
*
* The transport protocol used by the Client VPN endpoint.
*
*
* @return The transport protocol used by the Client VPN endpoint.
* @see TransportProtocol
*/
public String getTransportProtocol() {
return this.transportProtocol;
}
/**
*
* The transport protocol used by the Client VPN endpoint.
*
*
* @param transportProtocol
* The transport protocol used by the Client VPN endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TransportProtocol
*/
public ClientVpnEndpoint withTransportProtocol(String transportProtocol) {
setTransportProtocol(transportProtocol);
return this;
}
/**
*
* The transport protocol used by the Client VPN endpoint.
*
*
* @param transportProtocol
* The transport protocol used by the Client VPN endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TransportProtocol
*/
public ClientVpnEndpoint withTransportProtocol(TransportProtocol transportProtocol) {
this.transportProtocol = transportProtocol.toString();
return this;
}
/**
*
* The port number for the Client VPN endpoint.
*
*
* @param vpnPort
* The port number for the Client VPN endpoint.
*/
public void setVpnPort(Integer vpnPort) {
this.vpnPort = vpnPort;
}
/**
*
* The port number for the Client VPN endpoint.
*
*
* @return The port number for the Client VPN endpoint.
*/
public Integer getVpnPort() {
return this.vpnPort;
}
/**
*
* The port number for the Client VPN endpoint.
*
*
* @param vpnPort
* The port number for the Client VPN endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withVpnPort(Integer vpnPort) {
setVpnPort(vpnPort);
return this;
}
/**
*
* Information about the associated target networks. A target network is a subnet in a VPC.
*
*
* @return Information about the associated target networks. A target network is a subnet in a VPC.
*/
@Deprecated
public java.util.List getAssociatedTargetNetworks() {
if (associatedTargetNetworks == null) {
associatedTargetNetworks = new com.amazonaws.internal.SdkInternalList();
}
return associatedTargetNetworks;
}
/**
*
* Information about the associated target networks. A target network is a subnet in a VPC.
*
*
* @param associatedTargetNetworks
* Information about the associated target networks. A target network is a subnet in a VPC.
*/
@Deprecated
public void setAssociatedTargetNetworks(java.util.Collection associatedTargetNetworks) {
if (associatedTargetNetworks == null) {
this.associatedTargetNetworks = null;
return;
}
this.associatedTargetNetworks = new com.amazonaws.internal.SdkInternalList(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
* {@link #setAssociatedTargetNetworks(java.util.Collection)} or
* {@link #withAssociatedTargetNetworks(java.util.Collection)} if you want to override the existing values.
*
*
* @param associatedTargetNetworks
* Information about the associated target networks. A target network is a subnet in a VPC.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@Deprecated
public ClientVpnEndpoint withAssociatedTargetNetworks(AssociatedTargetNetwork... associatedTargetNetworks) {
if (this.associatedTargetNetworks == null) {
setAssociatedTargetNetworks(new com.amazonaws.internal.SdkInternalList(associatedTargetNetworks.length));
}
for (AssociatedTargetNetwork ele : associatedTargetNetworks) {
this.associatedTargetNetworks.add(ele);
}
return this;
}
/**
*
* Information about the associated target networks. A target network is a subnet in a VPC.
*
*
* @param associatedTargetNetworks
* Information about the associated target networks. A target network is a subnet in a VPC.
* @return Returns a reference to this object so that method calls can be chained together.
*/
@Deprecated
public ClientVpnEndpoint withAssociatedTargetNetworks(java.util.Collection associatedTargetNetworks) {
setAssociatedTargetNetworks(associatedTargetNetworks);
return this;
}
/**
*
* The ARN of the server certificate.
*
*
* @param serverCertificateArn
* The ARN of the server certificate.
*/
public void setServerCertificateArn(String serverCertificateArn) {
this.serverCertificateArn = serverCertificateArn;
}
/**
*
* The ARN of the server certificate.
*
*
* @return The ARN of the server certificate.
*/
public String getServerCertificateArn() {
return this.serverCertificateArn;
}
/**
*
* The ARN of the server certificate.
*
*
* @param serverCertificateArn
* The ARN of the server certificate.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withServerCertificateArn(String serverCertificateArn) {
setServerCertificateArn(serverCertificateArn);
return this;
}
/**
*
* Information about the authentication method used by the Client VPN endpoint.
*
*
* @return Information about the authentication method used by the Client VPN endpoint.
*/
public java.util.List getAuthenticationOptions() {
if (authenticationOptions == null) {
authenticationOptions = new com.amazonaws.internal.SdkInternalList();
}
return authenticationOptions;
}
/**
*
* Information about the authentication method used by the Client VPN endpoint.
*
*
* @param authenticationOptions
* Information about the authentication method used by the Client VPN endpoint.
*/
public void setAuthenticationOptions(java.util.Collection authenticationOptions) {
if (authenticationOptions == null) {
this.authenticationOptions = null;
return;
}
this.authenticationOptions = new com.amazonaws.internal.SdkInternalList(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
* {@link #setAuthenticationOptions(java.util.Collection)} or
* {@link #withAuthenticationOptions(java.util.Collection)} if you want to override the existing values.
*
*
* @param authenticationOptions
* Information about the authentication method used by the Client VPN endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withAuthenticationOptions(ClientVpnAuthentication... authenticationOptions) {
if (this.authenticationOptions == null) {
setAuthenticationOptions(new com.amazonaws.internal.SdkInternalList(authenticationOptions.length));
}
for (ClientVpnAuthentication ele : authenticationOptions) {
this.authenticationOptions.add(ele);
}
return this;
}
/**
*
* Information about the authentication method used by the Client VPN endpoint.
*
*
* @param authenticationOptions
* Information about the authentication method used by the Client VPN endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withAuthenticationOptions(java.util.Collection authenticationOptions) {
setAuthenticationOptions(authenticationOptions);
return this;
}
/**
*
* Information about the client connection logging options for the Client VPN endpoint.
*
*
* @param connectionLogOptions
* Information about the client connection logging options for the Client VPN endpoint.
*/
public void setConnectionLogOptions(ConnectionLogResponseOptions connectionLogOptions) {
this.connectionLogOptions = connectionLogOptions;
}
/**
*
* Information about the client connection logging options for the Client VPN endpoint.
*
*
* @return Information about the client connection logging options for the Client VPN endpoint.
*/
public ConnectionLogResponseOptions getConnectionLogOptions() {
return this.connectionLogOptions;
}
/**
*
* Information about the client connection logging options for the Client VPN endpoint.
*
*
* @param connectionLogOptions
* Information about the client connection logging options for the Client VPN endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withConnectionLogOptions(ConnectionLogResponseOptions connectionLogOptions) {
setConnectionLogOptions(connectionLogOptions);
return this;
}
/**
*
* Any tags assigned to the Client VPN endpoint.
*
*
* @return Any tags assigned to the Client VPN endpoint.
*/
public java.util.List getTags() {
if (tags == null) {
tags = new com.amazonaws.internal.SdkInternalList();
}
return tags;
}
/**
*
* Any tags assigned to the Client VPN endpoint.
*
*
* @param tags
* Any tags assigned to the Client VPN endpoint.
*/
public void setTags(java.util.Collection tags) {
if (tags == null) {
this.tags = null;
return;
}
this.tags = new com.amazonaws.internal.SdkInternalList(tags);
}
/**
*
* Any tags assigned to the Client VPN endpoint.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setTags(java.util.Collection)} or {@link #withTags(java.util.Collection)} if you want to override the
* existing values.
*
*
* @param tags
* Any tags assigned to the Client VPN endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withTags(Tag... tags) {
if (this.tags == null) {
setTags(new com.amazonaws.internal.SdkInternalList(tags.length));
}
for (Tag ele : tags) {
this.tags.add(ele);
}
return this;
}
/**
*
* Any tags assigned to the Client VPN endpoint.
*
*
* @param tags
* Any tags assigned to the Client VPN endpoint.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withTags(java.util.Collection tags) {
setTags(tags);
return this;
}
/**
*
* The IDs of the security groups for the target network.
*
*
* @return The IDs of the security groups for the target network.
*/
public java.util.List getSecurityGroupIds() {
if (securityGroupIds == null) {
securityGroupIds = new com.amazonaws.internal.SdkInternalList();
}
return securityGroupIds;
}
/**
*
* The IDs of the security groups for the target network.
*
*
* @param securityGroupIds
* The IDs of the security groups for the target network.
*/
public void setSecurityGroupIds(java.util.Collection securityGroupIds) {
if (securityGroupIds == null) {
this.securityGroupIds = null;
return;
}
this.securityGroupIds = new com.amazonaws.internal.SdkInternalList(securityGroupIds);
}
/**
*
* The IDs of the security groups for the target network.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setSecurityGroupIds(java.util.Collection)} or {@link #withSecurityGroupIds(java.util.Collection)} if you
* want to override the existing values.
*
*
* @param securityGroupIds
* The IDs of the security groups for the target network.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withSecurityGroupIds(String... securityGroupIds) {
if (this.securityGroupIds == null) {
setSecurityGroupIds(new com.amazonaws.internal.SdkInternalList(securityGroupIds.length));
}
for (String ele : securityGroupIds) {
this.securityGroupIds.add(ele);
}
return this;
}
/**
*
* The IDs of the security groups for the target network.
*
*
* @param securityGroupIds
* The IDs of the security groups for the target network.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withSecurityGroupIds(java.util.Collection securityGroupIds) {
setSecurityGroupIds(securityGroupIds);
return this;
}
/**
*
* The ID of the VPC.
*
*
* @param vpcId
* The ID of the VPC.
*/
public void setVpcId(String vpcId) {
this.vpcId = vpcId;
}
/**
*
* The ID of the VPC.
*
*
* @return The ID of the VPC.
*/
public String getVpcId() {
return this.vpcId;
}
/**
*
* The ID of the VPC.
*
*
* @param vpcId
* The ID of the VPC.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withVpcId(String vpcId) {
setVpcId(vpcId);
return this;
}
/**
*
* The URL of the self-service portal.
*
*
* @param selfServicePortalUrl
* The URL of the self-service portal.
*/
public void setSelfServicePortalUrl(String selfServicePortalUrl) {
this.selfServicePortalUrl = selfServicePortalUrl;
}
/**
*
* The URL of the self-service portal.
*
*
* @return The URL of the self-service portal.
*/
public String getSelfServicePortalUrl() {
return this.selfServicePortalUrl;
}
/**
*
* The URL of the self-service portal.
*
*
* @param selfServicePortalUrl
* The URL of the self-service portal.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withSelfServicePortalUrl(String selfServicePortalUrl) {
setSelfServicePortalUrl(selfServicePortalUrl);
return this;
}
/**
*
* The options for managing connection authorization for new client connections.
*
*
* @param clientConnectOptions
* The options for managing connection authorization for new client connections.
*/
public void setClientConnectOptions(ClientConnectResponseOptions clientConnectOptions) {
this.clientConnectOptions = clientConnectOptions;
}
/**
*
* The options for managing connection authorization for new client connections.
*
*
* @return The options for managing connection authorization for new client connections.
*/
public ClientConnectResponseOptions getClientConnectOptions() {
return this.clientConnectOptions;
}
/**
*
* The options for managing connection authorization for new client connections.
*
*
* @param clientConnectOptions
* The options for managing connection authorization for new client connections.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withClientConnectOptions(ClientConnectResponseOptions clientConnectOptions) {
setClientConnectOptions(clientConnectOptions);
return this;
}
/**
*
* The maximum VPN session duration time in hours.
*
*
* Valid values: 8 | 10 | 12 | 24
*
*
* Default value: 24
*
*
* @param sessionTimeoutHours
* The maximum VPN session duration time in hours.
*
* Valid values: 8 | 10 | 12 | 24
*
*
* Default value: 24
*/
public void setSessionTimeoutHours(Integer sessionTimeoutHours) {
this.sessionTimeoutHours = sessionTimeoutHours;
}
/**
*
* The maximum VPN session duration time in hours.
*
*
* Valid values: 8 | 10 | 12 | 24
*
*
* Default value: 24
*
*
* @return The maximum VPN session duration time in hours.
*
* Valid values: 8 | 10 | 12 | 24
*
*
* Default value: 24
*/
public Integer getSessionTimeoutHours() {
return this.sessionTimeoutHours;
}
/**
*
* The maximum VPN session duration time in hours.
*
*
* Valid values: 8 | 10 | 12 | 24
*
*
* Default value: 24
*
*
* @param sessionTimeoutHours
* The maximum VPN session duration time in hours.
*
* Valid values: 8 | 10 | 12 | 24
*
*
* Default value: 24
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withSessionTimeoutHours(Integer sessionTimeoutHours) {
setSessionTimeoutHours(sessionTimeoutHours);
return this;
}
/**
*
* Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients
* when a VPN session is established.
*
*
* @param 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 void setClientLoginBannerOptions(ClientLoginBannerResponseOptions clientLoginBannerOptions) {
this.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.
*
*
* @return 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() {
return this.clientLoginBannerOptions;
}
/**
*
* Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided clients
* when a VPN session is established.
*
*
* @param clientLoginBannerOptions
* Options for enabling a customizable text banner that will be displayed on Amazon Web Services provided
* clients when a VPN session is established.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnEndpoint withClientLoginBannerOptions(ClientLoginBannerResponseOptions clientLoginBannerOptions) {
setClientLoginBannerOptions(clientLoginBannerOptions);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getClientVpnEndpointId() != null)
sb.append("ClientVpnEndpointId: ").append(getClientVpnEndpointId()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getStatus() != null)
sb.append("Status: ").append(getStatus()).append(",");
if (getCreationTime() != null)
sb.append("CreationTime: ").append(getCreationTime()).append(",");
if (getDeletionTime() != null)
sb.append("DeletionTime: ").append(getDeletionTime()).append(",");
if (getDnsName() != null)
sb.append("DnsName: ").append(getDnsName()).append(",");
if (getClientCidrBlock() != null)
sb.append("ClientCidrBlock: ").append(getClientCidrBlock()).append(",");
if (getDnsServers() != null)
sb.append("DnsServers: ").append(getDnsServers()).append(",");
if (getSplitTunnel() != null)
sb.append("SplitTunnel: ").append(getSplitTunnel()).append(",");
if (getVpnProtocol() != null)
sb.append("VpnProtocol: ").append(getVpnProtocol()).append(",");
if (getTransportProtocol() != null)
sb.append("TransportProtocol: ").append(getTransportProtocol()).append(",");
if (getVpnPort() != null)
sb.append("VpnPort: ").append(getVpnPort()).append(",");
if (getAssociatedTargetNetworks() != null)
sb.append("AssociatedTargetNetworks: ").append(getAssociatedTargetNetworks()).append(",");
if (getServerCertificateArn() != null)
sb.append("ServerCertificateArn: ").append(getServerCertificateArn()).append(",");
if (getAuthenticationOptions() != null)
sb.append("AuthenticationOptions: ").append(getAuthenticationOptions()).append(",");
if (getConnectionLogOptions() != null)
sb.append("ConnectionLogOptions: ").append(getConnectionLogOptions()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getSecurityGroupIds() != null)
sb.append("SecurityGroupIds: ").append(getSecurityGroupIds()).append(",");
if (getVpcId() != null)
sb.append("VpcId: ").append(getVpcId()).append(",");
if (getSelfServicePortalUrl() != null)
sb.append("SelfServicePortalUrl: ").append(getSelfServicePortalUrl()).append(",");
if (getClientConnectOptions() != null)
sb.append("ClientConnectOptions: ").append(getClientConnectOptions()).append(",");
if (getSessionTimeoutHours() != null)
sb.append("SessionTimeoutHours: ").append(getSessionTimeoutHours()).append(",");
if (getClientLoginBannerOptions() != null)
sb.append("ClientLoginBannerOptions: ").append(getClientLoginBannerOptions());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ClientVpnEndpoint == false)
return false;
ClientVpnEndpoint other = (ClientVpnEndpoint) obj;
if (other.getClientVpnEndpointId() == null ^ this.getClientVpnEndpointId() == null)
return false;
if (other.getClientVpnEndpointId() != null && other.getClientVpnEndpointId().equals(this.getClientVpnEndpointId()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getStatus() == null ^ this.getStatus() == null)
return false;
if (other.getStatus() != null && other.getStatus().equals(this.getStatus()) == false)
return false;
if (other.getCreationTime() == null ^ this.getCreationTime() == null)
return false;
if (other.getCreationTime() != null && other.getCreationTime().equals(this.getCreationTime()) == false)
return false;
if (other.getDeletionTime() == null ^ this.getDeletionTime() == null)
return false;
if (other.getDeletionTime() != null && other.getDeletionTime().equals(this.getDeletionTime()) == false)
return false;
if (other.getDnsName() == null ^ this.getDnsName() == null)
return false;
if (other.getDnsName() != null && other.getDnsName().equals(this.getDnsName()) == false)
return false;
if (other.getClientCidrBlock() == null ^ this.getClientCidrBlock() == null)
return false;
if (other.getClientCidrBlock() != null && other.getClientCidrBlock().equals(this.getClientCidrBlock()) == false)
return false;
if (other.getDnsServers() == null ^ this.getDnsServers() == null)
return false;
if (other.getDnsServers() != null && other.getDnsServers().equals(this.getDnsServers()) == false)
return false;
if (other.getSplitTunnel() == null ^ this.getSplitTunnel() == null)
return false;
if (other.getSplitTunnel() != null && other.getSplitTunnel().equals(this.getSplitTunnel()) == false)
return false;
if (other.getVpnProtocol() == null ^ this.getVpnProtocol() == null)
return false;
if (other.getVpnProtocol() != null && other.getVpnProtocol().equals(this.getVpnProtocol()) == false)
return false;
if (other.getTransportProtocol() == null ^ this.getTransportProtocol() == null)
return false;
if (other.getTransportProtocol() != null && other.getTransportProtocol().equals(this.getTransportProtocol()) == false)
return false;
if (other.getVpnPort() == null ^ this.getVpnPort() == null)
return false;
if (other.getVpnPort() != null && other.getVpnPort().equals(this.getVpnPort()) == false)
return false;
if (other.getAssociatedTargetNetworks() == null ^ this.getAssociatedTargetNetworks() == null)
return false;
if (other.getAssociatedTargetNetworks() != null && other.getAssociatedTargetNetworks().equals(this.getAssociatedTargetNetworks()) == false)
return false;
if (other.getServerCertificateArn() == null ^ this.getServerCertificateArn() == null)
return false;
if (other.getServerCertificateArn() != null && other.getServerCertificateArn().equals(this.getServerCertificateArn()) == false)
return false;
if (other.getAuthenticationOptions() == null ^ this.getAuthenticationOptions() == null)
return false;
if (other.getAuthenticationOptions() != null && other.getAuthenticationOptions().equals(this.getAuthenticationOptions()) == false)
return false;
if (other.getConnectionLogOptions() == null ^ this.getConnectionLogOptions() == null)
return false;
if (other.getConnectionLogOptions() != null && other.getConnectionLogOptions().equals(this.getConnectionLogOptions()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getSecurityGroupIds() == null ^ this.getSecurityGroupIds() == null)
return false;
if (other.getSecurityGroupIds() != null && other.getSecurityGroupIds().equals(this.getSecurityGroupIds()) == false)
return false;
if (other.getVpcId() == null ^ this.getVpcId() == null)
return false;
if (other.getVpcId() != null && other.getVpcId().equals(this.getVpcId()) == false)
return false;
if (other.getSelfServicePortalUrl() == null ^ this.getSelfServicePortalUrl() == null)
return false;
if (other.getSelfServicePortalUrl() != null && other.getSelfServicePortalUrl().equals(this.getSelfServicePortalUrl()) == false)
return false;
if (other.getClientConnectOptions() == null ^ this.getClientConnectOptions() == null)
return false;
if (other.getClientConnectOptions() != null && other.getClientConnectOptions().equals(this.getClientConnectOptions()) == false)
return false;
if (other.getSessionTimeoutHours() == null ^ this.getSessionTimeoutHours() == null)
return false;
if (other.getSessionTimeoutHours() != null && other.getSessionTimeoutHours().equals(this.getSessionTimeoutHours()) == false)
return false;
if (other.getClientLoginBannerOptions() == null ^ this.getClientLoginBannerOptions() == null)
return false;
if (other.getClientLoginBannerOptions() != null && other.getClientLoginBannerOptions().equals(this.getClientLoginBannerOptions()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getClientVpnEndpointId() == null) ? 0 : getClientVpnEndpointId().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getStatus() == null) ? 0 : getStatus().hashCode());
hashCode = prime * hashCode + ((getCreationTime() == null) ? 0 : getCreationTime().hashCode());
hashCode = prime * hashCode + ((getDeletionTime() == null) ? 0 : getDeletionTime().hashCode());
hashCode = prime * hashCode + ((getDnsName() == null) ? 0 : getDnsName().hashCode());
hashCode = prime * hashCode + ((getClientCidrBlock() == null) ? 0 : getClientCidrBlock().hashCode());
hashCode = prime * hashCode + ((getDnsServers() == null) ? 0 : getDnsServers().hashCode());
hashCode = prime * hashCode + ((getSplitTunnel() == null) ? 0 : getSplitTunnel().hashCode());
hashCode = prime * hashCode + ((getVpnProtocol() == null) ? 0 : getVpnProtocol().hashCode());
hashCode = prime * hashCode + ((getTransportProtocol() == null) ? 0 : getTransportProtocol().hashCode());
hashCode = prime * hashCode + ((getVpnPort() == null) ? 0 : getVpnPort().hashCode());
hashCode = prime * hashCode + ((getAssociatedTargetNetworks() == null) ? 0 : getAssociatedTargetNetworks().hashCode());
hashCode = prime * hashCode + ((getServerCertificateArn() == null) ? 0 : getServerCertificateArn().hashCode());
hashCode = prime * hashCode + ((getAuthenticationOptions() == null) ? 0 : getAuthenticationOptions().hashCode());
hashCode = prime * hashCode + ((getConnectionLogOptions() == null) ? 0 : getConnectionLogOptions().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getSecurityGroupIds() == null) ? 0 : getSecurityGroupIds().hashCode());
hashCode = prime * hashCode + ((getVpcId() == null) ? 0 : getVpcId().hashCode());
hashCode = prime * hashCode + ((getSelfServicePortalUrl() == null) ? 0 : getSelfServicePortalUrl().hashCode());
hashCode = prime * hashCode + ((getClientConnectOptions() == null) ? 0 : getClientConnectOptions().hashCode());
hashCode = prime * hashCode + ((getSessionTimeoutHours() == null) ? 0 : getSessionTimeoutHours().hashCode());
hashCode = prime * hashCode + ((getClientLoginBannerOptions() == null) ? 0 : getClientLoginBannerOptions().hashCode());
return hashCode;
}
@Override
public ClientVpnEndpoint clone() {
try {
return (ClientVpnEndpoint) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}