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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb

Overview

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,
}

Specifies the SAML application configuration for the domain.

Constant Summary collapse

SENSITIVE =
[:master_user_name]

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

True if SAML is enabled.

Returns:

  • (Boolean)


3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 3861

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

#idpTypes::SAMLIdp

Specifies the SAML Identity Provider's information.

Returns:



3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 3861

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_roleString

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

Returns:

  • (String)


3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 3861

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_nameString

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

Returns:

  • (String)


3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 3861

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_keyString

The key to use for matching the SAML Roles attribute.

Returns:

  • (String)


3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 3861

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_minutesInteger

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)


3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 3861

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_keyString

The key to use for matching the SAML Subject attribute.

Returns:

  • (String)


3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 3861

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