ClientVpnAuthenticationRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.ec2.model.ClientVpnAuthenticationRequest

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class ClientVpnAuthenticationRequest
extends Object
implements Serializable, Cloneable
```
Describes the authentication method to be used by a Client VPN endpoint. For more information, see Authentication in the Client VPN Administrator Guide.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

ClientVpnAuthenticationRequest()

Constructors
Constructor and Description
`ClientVpnAuthenticationRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ClientVpnAuthenticationRequest`	`clone()`
`boolean`	`equals(Object obj)`
`DirectoryServiceAuthenticationRequest`	`getActiveDirectory()` Information about the Active Directory to be used, if applicable.
`FederatedAuthenticationRequest`	`getFederatedAuthentication()` Information about the IAM SAML identity provider to be used, if applicable.
`CertificateAuthenticationRequest`	`getMutualAuthentication()` Information about the authentication certificates to be used, if applicable.
`String`	`getType()` The type of client authentication to be used.
`int`	`hashCode()`
`void`	`setActiveDirectory(DirectoryServiceAuthenticationRequest activeDirectory)` Information about the Active Directory to be used, if applicable.
`void`	`setFederatedAuthentication(FederatedAuthenticationRequest federatedAuthentication)` Information about the IAM SAML identity provider to be used, if applicable.
`void`	`setMutualAuthentication(CertificateAuthenticationRequest mutualAuthentication)` Information about the authentication certificates to be used, if applicable.
`void`	`setType(String type)` The type of client authentication to be used.
`String`	`toString()` Returns a string representation of this object.
`ClientVpnAuthenticationRequest`	`withActiveDirectory(DirectoryServiceAuthenticationRequest activeDirectory)` Information about the Active Directory to be used, if applicable.
`ClientVpnAuthenticationRequest`	`withFederatedAuthentication(FederatedAuthenticationRequest federatedAuthentication)` Information about the IAM SAML identity provider to be used, if applicable.
`ClientVpnAuthenticationRequest`	`withMutualAuthentication(CertificateAuthenticationRequest mutualAuthentication)` Information about the authentication certificates to be used, if applicable.
`ClientVpnAuthenticationRequest`	`withType(ClientVpnAuthenticationType type)` The type of client authentication to be used.
`ClientVpnAuthenticationRequest`	`withType(String type)` The type of client authentication to be used.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - ClientVpnAuthenticationRequest
```
public ClientVpnAuthenticationRequest()
```
- Method Detail
  - setType
```
public void setType(String type)
```
    The type of client authentication to be used.
    
    Parameters:
    
    type - The type of client authentication to be used.
    
    See Also:
    
    ClientVpnAuthenticationType
  - getType
```
public String getType()
```
    The type of client authentication to be used.
    
    Returns:
    
    The type of client authentication to be used.
    
    See Also:
    
    ClientVpnAuthenticationType
  - withType
```
public ClientVpnAuthenticationRequest withType(String type)
```
    The type of client authentication to be used.
    
    Parameters:
    
    type - The type of client authentication to be used.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClientVpnAuthenticationType
  - withType
```
public ClientVpnAuthenticationRequest withType(ClientVpnAuthenticationType type)
```
    The type of client authentication to be used.
    
    Parameters:
    
    type - The type of client authentication to be used.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ClientVpnAuthenticationType
  - setActiveDirectory
```
public void setActiveDirectory(DirectoryServiceAuthenticationRequest activeDirectory)
```
    Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication.
    
    Parameters:
    
    activeDirectory - Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication.
  - getActiveDirectory
```
public DirectoryServiceAuthenticationRequest getActiveDirectory()
```
    Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication.
    
    Returns:
    
    Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication.
  - withActiveDirectory
```
public ClientVpnAuthenticationRequest withActiveDirectory(DirectoryServiceAuthenticationRequest activeDirectory)
```
    Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication.
    
    Parameters:
    
    activeDirectory - Information about the Active Directory to be used, if applicable. You must provide this information if Type is directory-service-authentication.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMutualAuthentication
```
public void setMutualAuthentication(CertificateAuthenticationRequest mutualAuthentication)
```
    Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication.
    
    Parameters:
    
    mutualAuthentication - Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication.
  - getMutualAuthentication
```
public CertificateAuthenticationRequest getMutualAuthentication()
```
    Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication.
    
    Returns:
    
    Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication.
  - withMutualAuthentication
```
public ClientVpnAuthenticationRequest withMutualAuthentication(CertificateAuthenticationRequest mutualAuthentication)
```
    Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication.
    
    Parameters:
    
    mutualAuthentication - Information about the authentication certificates to be used, if applicable. You must provide this information if Type is certificate-authentication.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFederatedAuthentication
```
public void setFederatedAuthentication(FederatedAuthenticationRequest federatedAuthentication)
```
    Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication.
    
    Parameters:
    
    federatedAuthentication - Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication.
  - getFederatedAuthentication
```
public FederatedAuthenticationRequest getFederatedAuthentication()
```
    Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication.
    
    Returns:
    
    Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication.
  - withFederatedAuthentication
```
public ClientVpnAuthenticationRequest withFederatedAuthentication(FederatedAuthenticationRequest federatedAuthentication)
```
    Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication.
    
    Parameters:
    
    federatedAuthentication - Information about the IAM SAML identity provider to be used, if applicable. You must provide this information if Type is federated-authentication.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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 ClientVpnAuthenticationRequest clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class ClientVpnAuthenticationRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ClientVpnAuthenticationRequest

Method Detail

setType

getType

withType

withType

setActiveDirectory

getActiveDirectory

withActiveDirectory

setMutualAuthentication

getMutualAuthentication

withMutualAuthentication

setFederatedAuthentication

getFederatedAuthentication

withFederatedAuthentication

toString

equals

hashCode

clone