class Aws::OpenSearchService::Types::SAMLOptionsInput

The SAML application configuration for the domain.

@note When making an API call, you may pass SAMLOptionsInput

data as a hash:

    {
      enabled: false,
      idp: {
        metadata_content: "SAMLMetadata", # required
        entity_id: "SAMLEntityId", # required
      },
      master_user_name: "Username",
      master_backend_role: "BackendRole",
      subject_key: "String",
      roles_key: "String",
      session_timeout_minutes: 1,
    }

@!attribute [rw] enabled

True if SAML is enabled.
@return [Boolean]

@!attribute [rw] idp

The SAML Identity Provider's information.
@return [Types::SAMLIdp]

@!attribute [rw] master_user_name

The SAML master username, which is stored in the Amazon OpenSearch
Service domain's internal database.
@return [String]

@!attribute [rw] master_backend_role

The backend role that the SAML master user is mapped to.
@return [String]

@!attribute [rw] subject_key

Element of the SAML assertion to use for username. Default is
NameID.
@return [String]

@!attribute [rw] roles_key

Element of the SAML assertion to use for backend roles. Default is
roles.
@return [String]

@!attribute [rw] session_timeout_minutes

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

@see docs.aws.amazon.com/goto/WebAPI/opensearch-2021-01-01/SAMLOptionsInput AWS API Documentation

Constants

SENSITIVE