Class SAMLOptionsInput

java.lang.Object
software.amazon.awssdk.services.opensearch.model.SAMLOptionsInput
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SAMLOptionsInput.Builder,SAMLOptionsInput>
@Generated("software.amazon.awssdk:codegen") public final class SAMLOptionsInput extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SAMLOptionsInput.Builder,SAMLOptionsInput>

The SAML authentication configuration for an Amazon OpenSearch Service domain.

See Also:

  • Method Details

    • enabled

      public final Boolean enabled()

      True to enable SAML authentication for a domain.

      Returns:
      True to enable SAML authentication for a domain.

    • idp

      public final SAMLIdp idp()

      The SAML Identity Provider's information.

      Returns:
      The SAML Identity Provider's information.

    • masterUserName

      public final String masterUserName()

      The SAML master user name, which is stored in the domain's internal user database.

      Returns:
      The SAML master user name, which is stored in the domain's internal user database.

    • masterBackendRole

      public final String masterBackendRole()

      The backend role that the SAML master user is mapped to.

      Returns:
      The backend role that the SAML master user is mapped to.

    • subjectKey

      public final String subjectKey()

      Element of the SAML assertion to use for the user name. Default is NameID.

      Returns:
      Element of the SAML assertion to use for the user name. Default is NameID.

    • rolesKey

      public final String rolesKey()

      Element of the SAML assertion to use for backend roles. Default is roles.

      Returns:
      Element of the SAML assertion to use for backend roles. Default is roles.

    • sessionTimeoutMinutes

      public final Integer sessionTimeoutMinutes()

      The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

      Returns:
      The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

    • toBuilder

      public SAMLOptionsInput.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<SAMLOptionsInput.Builder,SAMLOptionsInput>
      Returns:
      a builder for type T

    • builder

      public static SAMLOptionsInput.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SAMLOptionsInput.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.