You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElasticsearchService::Types::SAMLOptionsInput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SAMLOptionsInput as input to an Aws::Client method, you can use a vanilla 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,
}

Specifies the SAML application configuration for the domain.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#enabled ⇒ Boolean

True if SAML is enabled.

Returns:

  • (Boolean) —

    True if SAML is enabled.

#idp ⇒ Types::SAMLIdp

Specifies the SAML Identity Provider\'s information.

Returns:

  • (Types::SAMLIdp) —

    Specifies the SAML Identity Provider\'s information.

#master_backend_role ⇒ String

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

Returns:

  • (String) —

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

#master_user_name ⇒ String

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

Returns:

  • (String) —

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

#roles_key ⇒ String

The key to use for matching the SAML Roles attribute.

Returns:

  • (String) —

    The key to use for matching the SAML Roles attribute.

#session_timeout_minutes ⇒ Integer

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:

  • (Integer) —

    The duration, in minutes, after which a user session becomes inactive.

#subject_key ⇒ String

The key to use for matching the SAML Subject attribute.

Returns:

  • (String) —

    The key to use for matching the SAML Subject attribute.