Package software.amazon.awssdk.services.ec2.model

Class ClientVpnAuthenticationRequest

java.lang.Object

software.amazon.awssdk.services.ec2.model.ClientVpnAuthenticationRequest

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ClientVpnAuthenticationRequest.Builder,ClientVpnAuthenticationRequest>

@Generated("software.amazon.awssdk:codegen")
public final class ClientVpnAuthenticationRequest
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ClientVpnAuthenticationRequest.Builder,ClientVpnAuthenticationRequest>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ClientVpnAuthenticationRequest.Builder

Method Summary

Modifier and Type	Method	Description
DirectoryServiceAuthenticationRequest	activeDirectory()	Information about the Active Directory to be used, if applicable.
static ClientVpnAuthenticationRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
FederatedAuthenticationRequest	federatedAuthentication()	Information about the IAM SAML identity provider to be used, if applicable.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
CertificateAuthenticationRequest	mutualAuthentication()	Information about the authentication certificates to be used, if applicable.
List<SdkField<?>>	sdkFields()
static Class<? extends ClientVpnAuthenticationRequest.Builder>	serializableBuilderClass()
ClientVpnAuthenticationRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
ClientVpnAuthenticationType	type()	The type of client authentication to be used.
String	typeAsString()	The type of client authentication to be used.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

type

public final ClientVpnAuthenticationType type()

The type of client authentication to be used.

If the service returns an enum value that is not available in the current SDK version, type will return ClientVpnAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of client authentication to be used.

See Also:

ClientVpnAuthenticationType

typeAsString

public final String typeAsString()

The type of client authentication to be used.

If the service returns an enum value that is not available in the current SDK version, type will return ClientVpnAuthenticationType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of client authentication to be used.

See Also:

ClientVpnAuthenticationType

activeDirectory

public final DirectoryServiceAuthenticationRequest activeDirectory()

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.

mutualAuthentication

public final CertificateAuthenticationRequest mutualAuthentication()

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.

federatedAuthentication

public final FederatedAuthenticationRequest federatedAuthentication()

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.

toBuilder

public ClientVpnAuthenticationRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ClientVpnAuthenticationRequest.Builder,ClientVpnAuthenticationRequest>

builder

public static ClientVpnAuthenticationRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ClientVpnAuthenticationRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo