com.amazonaws.services.ec2.model.ClientVpnAuthenticationRequest 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 the authentication method to be used by a Client VPN endpoint. For more information, see Authentication in the Client VPN Administrator Guide.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ClientVpnAuthenticationRequest implements Serializable, Cloneable {
/**
*
* The type of client authentication to be used.
*
*/
private String type;
/**
*
* Information about the Active Directory to be used, if applicable. You must provide this information if
* Type is directory-service-authentication.
*
*/
private DirectoryServiceAuthenticationRequest activeDirectory;
/**
*
* Information about the authentication certificates to be used, if applicable. You must provide this information if
* Type is certificate-authentication.
*
*/
private CertificateAuthenticationRequest mutualAuthentication;
/**
*
* Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if
* Type is federated-authentication.
*
*/
private FederatedAuthenticationRequest federatedAuthentication;
/**
*
* The type of client authentication to be used.
*
*
* @param type
* The type of client authentication to be used.
* @see ClientVpnAuthenticationType
*/
public void setType(String type) {
this.type = type;
}
/**
*
* The type of client authentication to be used.
*
*
* @return The type of client authentication to be used.
* @see ClientVpnAuthenticationType
*/
public String getType() {
return this.type;
}
/**
*
* The type of client authentication to be used.
*
*
* @param type
* The type of client authentication to be used.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ClientVpnAuthenticationType
*/
public ClientVpnAuthenticationRequest withType(String type) {
setType(type);
return this;
}
/**
*
* The type of client authentication to be used.
*
*
* @param type
* The type of client authentication to be used.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ClientVpnAuthenticationType
*/
public ClientVpnAuthenticationRequest withType(ClientVpnAuthenticationType type) {
this.type = type.toString();
return this;
}
/**
*
* Information about the Active Directory to be used, if applicable. You must provide this information if
* Type is directory-service-authentication.
*
*
* @param activeDirectory
* Information about the Active Directory to be used, if applicable. You must provide this information if
* Type is directory-service-authentication.
*/
public void setActiveDirectory(DirectoryServiceAuthenticationRequest activeDirectory) {
this.activeDirectory = activeDirectory;
}
/**
*
* Information about the Active Directory to be used, if applicable. You must provide this information if
* Type is directory-service-authentication.
*
*
* @return Information about the Active Directory to be used, if applicable. You must provide this information if
* Type is directory-service-authentication.
*/
public DirectoryServiceAuthenticationRequest getActiveDirectory() {
return this.activeDirectory;
}
/**
*
* Information about the Active Directory to be used, if applicable. You must provide this information if
* Type is directory-service-authentication.
*
*
* @param activeDirectory
* Information about the Active Directory to be used, if applicable. You must provide this information if
* Type is directory-service-authentication.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnAuthenticationRequest withActiveDirectory(DirectoryServiceAuthenticationRequest activeDirectory) {
setActiveDirectory(activeDirectory);
return this;
}
/**
*
* Information about the authentication certificates to be used, if applicable. You must provide this information if
* Type is certificate-authentication.
*
*
* @param mutualAuthentication
* Information about the authentication certificates to be used, if applicable. You must provide this
* information if Type is certificate-authentication.
*/
public void setMutualAuthentication(CertificateAuthenticationRequest mutualAuthentication) {
this.mutualAuthentication = mutualAuthentication;
}
/**
*
* Information about the authentication certificates to be used, if applicable. You must provide this information if
* Type is certificate-authentication.
*
*
* @return Information about the authentication certificates to be used, if applicable. You must provide this
* information if Type is certificate-authentication.
*/
public CertificateAuthenticationRequest getMutualAuthentication() {
return this.mutualAuthentication;
}
/**
*
* Information about the authentication certificates to be used, if applicable. You must provide this information if
* Type is certificate-authentication.
*
*
* @param mutualAuthentication
* Information about the authentication certificates to be used, if applicable. You must provide this
* information if Type is certificate-authentication.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnAuthenticationRequest withMutualAuthentication(CertificateAuthenticationRequest mutualAuthentication) {
setMutualAuthentication(mutualAuthentication);
return this;
}
/**
*
* Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if
* Type is federated-authentication.
*
*
* @param federatedAuthentication
* Information about the IAM SAML identity provider to be used, if applicable. You must provide this
* information if Type is federated-authentication.
*/
public void setFederatedAuthentication(FederatedAuthenticationRequest federatedAuthentication) {
this.federatedAuthentication = federatedAuthentication;
}
/**
*
* Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if
* Type is federated-authentication.
*
*
* @return Information about the IAM SAML identity provider to be used, if applicable. You must provide this
* information if Type is federated-authentication.
*/
public FederatedAuthenticationRequest getFederatedAuthentication() {
return this.federatedAuthentication;
}
/**
*
* Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if
* Type is federated-authentication.
*
*
* @param federatedAuthentication
* Information about the IAM SAML identity provider to be used, if applicable. You must provide this
* information if Type is federated-authentication.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ClientVpnAuthenticationRequest withFederatedAuthentication(FederatedAuthenticationRequest federatedAuthentication) {
setFederatedAuthentication(federatedAuthentication);
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 (getType() != null)
sb.append("Type: ").append(getType()).append(",");
if (getActiveDirectory() != null)
sb.append("ActiveDirectory: ").append(getActiveDirectory()).append(",");
if (getMutualAuthentication() != null)
sb.append("MutualAuthentication: ").append(getMutualAuthentication()).append(",");
if (getFederatedAuthentication() != null)
sb.append("FederatedAuthentication: ").append(getFederatedAuthentication());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ClientVpnAuthenticationRequest == false)
return false;
ClientVpnAuthenticationRequest other = (ClientVpnAuthenticationRequest) obj;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
if (other.getActiveDirectory() == null ^ this.getActiveDirectory() == null)
return false;
if (other.getActiveDirectory() != null && other.getActiveDirectory().equals(this.getActiveDirectory()) == false)
return false;
if (other.getMutualAuthentication() == null ^ this.getMutualAuthentication() == null)
return false;
if (other.getMutualAuthentication() != null && other.getMutualAuthentication().equals(this.getMutualAuthentication()) == false)
return false;
if (other.getFederatedAuthentication() == null ^ this.getFederatedAuthentication() == null)
return false;
if (other.getFederatedAuthentication() != null && other.getFederatedAuthentication().equals(this.getFederatedAuthentication()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
hashCode = prime * hashCode + ((getActiveDirectory() == null) ? 0 : getActiveDirectory().hashCode());
hashCode = prime * hashCode + ((getMutualAuthentication() == null) ? 0 : getMutualAuthentication().hashCode());
hashCode = prime * hashCode + ((getFederatedAuthentication() == null) ? 0 : getFederatedAuthentication().hashCode());
return hashCode;
}
@Override
public ClientVpnAuthenticationRequest clone() {
try {
return (ClientVpnAuthenticationRequest) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}