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:

  • Method Details

    • 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:

    • 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:

    • 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()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ClientVpnAuthenticationRequest.Builder,ClientVpnAuthenticationRequest>
      Returns:
      a builder for type T

    • 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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.