Class: Aws::ElasticsearchService::Types::AdvancedSecurityOptionsInput

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 AdvancedSecurityOptionsInput data as a hash:

{
  enabled: false,
  internal_user_database_enabled: false,
  master_user_options: {
    master_user_arn: "ARN",
    master_user_name: "Username",
    master_user_password: "Password",
  },
  saml_options: {
    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,
  },
  anonymous_auth_enabled: false,
}

Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#anonymous_auth_enabled ⇒ Boolean

True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

Returns:

  • (Boolean) 


253
254
255
256
257
258
259
260
261
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 253

class AdvancedSecurityOptionsInput < Struct.new(
  :enabled,
  :internal_user_database_enabled,
  :master_user_options,
  :saml_options,
  :anonymous_auth_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#enabled ⇒ Boolean

True if advanced security is enabled.

Returns:

  • (Boolean) 


253
254
255
256
257
258
259
260
261
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 253

class AdvancedSecurityOptionsInput < Struct.new(
  :enabled,
  :internal_user_database_enabled,
  :master_user_options,
  :saml_options,
  :anonymous_auth_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#internal_user_database_enabled ⇒ Boolean

True if the internal user database is enabled.

Returns:

  • (Boolean) 


253
254
255
256
257
258
259
260
261
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 253

class AdvancedSecurityOptionsInput < Struct.new(
  :enabled,
  :internal_user_database_enabled,
  :master_user_options,
  :saml_options,
  :anonymous_auth_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#master_user_options ⇒ Types::MasterUserOptions

Credentials for the master user: username and password, ARN, or both.

Returns:



253
254
255
256
257
258
259
260
261
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 253

class AdvancedSecurityOptionsInput < Struct.new(
  :enabled,
  :internal_user_database_enabled,
  :master_user_options,
  :saml_options,
  :anonymous_auth_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#saml_options ⇒ Types::SAMLOptionsInput

Specifies the SAML application configuration for the domain.

Returns:



253
254
255
256
257
258
259
260
261
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/types.rb', line 253

class AdvancedSecurityOptionsInput < Struct.new(
  :enabled,
  :internal_user_database_enabled,
  :master_user_options,
  :saml_options,
  :anonymous_auth_enabled)
  SENSITIVE = []
  include Aws::Structure
end