Class: Aws::OpenSearchService::Types::SAMLOptionsInput

Inherits:

Struct

• Object
• Struct
• Aws::OpenSearchService::Types::SAMLOptionsInput

Includes:

Structure

Defined in:

lib/aws-sdk-opensearchservice/types.rb

Overview

The SAML authentication configuration for an Amazon OpenSearch Service domain.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:master_user_name]

Instance Attribute Summary

• #enabled ⇒ Boolean

  True to enable SAML authentication for a domain.

• #idp ⇒ Types::SAMLIdp

  The SAML Identity Provider’s information.

• #master_backend_role ⇒ String

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

• #master_user_name ⇒ String

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

• #roles_key ⇒ String

  Element of the SAML assertion to use for backend roles.

• #session_timeout_minutes ⇒ Integer

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

• #subject_key ⇒ String

  Element of the SAML assertion to use for the user name.

Instance Attribute Details

#enabled ⇒ Boolean

True to enable SAML authentication for a domain.

Returns:

• (Boolean)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6662

class SAMLOptionsInput < Struct.new(
  :enabled,
  :idp,
  :master_user_name,
  :master_backend_role,
  :subject_key,
  :roles_key,
  :session_timeout_minutes)
  SENSITIVE = [:master_user_name]
  include Aws::Structure
end

#idp ⇒ Types::SAMLIdp

The SAML Identity Provider’s information.

Returns:

• (Types::SAMLIdp)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6662

class SAMLOptionsInput < Struct.new(
  :enabled,
  :idp,
  :master_user_name,
  :master_backend_role,
  :subject_key,
  :roles_key,
  :session_timeout_minutes)
  SENSITIVE = [:master_user_name]
  include Aws::Structure
end

#master_backend_role ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6662

class SAMLOptionsInput < Struct.new(
  :enabled,
  :idp,
  :master_user_name,
  :master_backend_role,
  :subject_key,
  :roles_key,
  :session_timeout_minutes)
  SENSITIVE = [:master_user_name]
  include Aws::Structure
end

#master_user_name ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6662

class SAMLOptionsInput < Struct.new(
  :enabled,
  :idp,
  :master_user_name,
  :master_backend_role,
  :subject_key,
  :roles_key,
  :session_timeout_minutes)
  SENSITIVE = [:master_user_name]
  include Aws::Structure
end

#roles_key ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6662

class SAMLOptionsInput < Struct.new(
  :enabled,
  :idp,
  :master_user_name,
  :master_backend_role,
  :subject_key,
  :roles_key,
  :session_timeout_minutes)
  SENSITIVE = [:master_user_name]
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6662

class SAMLOptionsInput < Struct.new(
  :enabled,
  :idp,
  :master_user_name,
  :master_backend_role,
  :subject_key,
  :roles_key,
  :session_timeout_minutes)
  SENSITIVE = [:master_user_name]
  include Aws::Structure
end

#subject_key ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-opensearchservice/types.rb', line 6662

class SAMLOptionsInput < Struct.new(
  :enabled,
  :idp,
  :master_user_name,
  :master_backend_role,
  :subject_key,
  :roles_key,
  :session_timeout_minutes)
  SENSITIVE = [:master_user_name]
  include Aws::Structure
end