Interface SAMLOptionsInput.Builder

All Superinterfaces:
Buildable, CopyableBuilder<SAMLOptionsInput.Builder,SAMLOptionsInput>, SdkBuilder<SAMLOptionsInput.Builder,SAMLOptionsInput>, SdkPojo
Enclosing class:
SAMLOptionsInput
@Mutable @NotThreadSafe public static interface SAMLOptionsInput.Builder extends SdkPojo, CopyableBuilder<SAMLOptionsInput.Builder,SAMLOptionsInput>

  • Method Details

    • enabled

      SAMLOptionsInput.Builder enabled(Boolean enabled)

      True if SAML is enabled.

      Parameters:
      enabled - True if SAML is enabled.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • idp

      SAMLOptionsInput.Builder idp(SAMLIdp idp)

      Specifies the SAML Identity Provider's information.

      Parameters:
      idp - Specifies the SAML Identity Provider's information.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • idp

      default SAMLOptionsInput.Builder idp(Consumer<SAMLIdp.Builder> idp)

      Specifies the SAML Identity Provider's information.

      This is a convenience method that creates an instance of the SAMLIdp.Builder avoiding the need to create one manually via SAMLIdp.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to idp(SAMLIdp).

      Parameters:
      idp - a consumer that will call methods on SAMLIdp.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • masterUserName

      SAMLOptionsInput.Builder masterUserName(String masterUserName)

      The SAML master username, which is stored in the Amazon Elasticsearch Service domain's internal database.

      Parameters:
      masterUserName - The SAML master username, which is stored in the Amazon Elasticsearch Service domain's internal database.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • masterBackendRole

      SAMLOptionsInput.Builder masterBackendRole(String masterBackendRole)

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

      Parameters:
      masterBackendRole - The backend role to which the SAML master user is mapped to.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • subjectKey

      SAMLOptionsInput.Builder subjectKey(String subjectKey)

      The key to use for matching the SAML Subject attribute.

      Parameters:
      subjectKey - The key to use for matching the SAML Subject attribute.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rolesKey

      SAMLOptionsInput.Builder rolesKey(String rolesKey)

      The key to use for matching the SAML Roles attribute.

      Parameters:
      rolesKey - The key to use for matching the SAML Roles attribute.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • sessionTimeoutMinutes

      SAMLOptionsInput.Builder sessionTimeoutMinutes(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.