Class: Aws::OpenSearchService::Types::IdentityCenterOptions

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-opensearchservice/types.rb

Overview

Container for IAM Identity Center Options settings.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enabled_api_access ⇒ Boolean

True to enable IAM Identity Center for API access in Amazon OpenSearch Service.

Returns:

  • (Boolean) 


4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 4257

class IdentityCenterOptions < Struct.new(
  :enabled_api_access,
  :identity_center_instance_arn,
  :subject_key,
  :roles_key,
  :identity_center_application_arn,
  :identity_store_id)
  SENSITIVE = []
  include Aws::Structure
end

#identity_center_application_arn ⇒ String

The ARN for IAM Identity Center Application which will integrate with Amazon OpenSearch Service.

Returns:

  • (String) 


4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 4257

class IdentityCenterOptions < Struct.new(
  :enabled_api_access,
  :identity_center_instance_arn,
  :subject_key,
  :roles_key,
  :identity_center_application_arn,
  :identity_store_id)
  SENSITIVE = []
  include Aws::Structure
end

#identity_center_instance_arn ⇒ String

The ARN for IAM Identity Center Instance.

Returns:

  • (String) 


4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 4257

class IdentityCenterOptions < Struct.new(
  :enabled_api_access,
  :identity_center_instance_arn,
  :subject_key,
  :roles_key,
  :identity_center_application_arn,
  :identity_store_id)
  SENSITIVE = []
  include Aws::Structure
end

#identity_store_id ⇒ String

The ID of IAM Identity Store.

Returns:

  • (String) 


4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 4257

class IdentityCenterOptions < Struct.new(
  :enabled_api_access,
  :identity_center_instance_arn,
  :subject_key,
  :roles_key,
  :identity_center_application_arn,
  :identity_store_id)
  SENSITIVE = []
  include Aws::Structure
end

#roles_key ⇒ String

Specify the attribute that contains the backend role (groupName, groupID) of IAM Identity Center

Returns:

  • (String) 


4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 4257

class IdentityCenterOptions < Struct.new(
  :enabled_api_access,
  :identity_center_instance_arn,
  :subject_key,
  :roles_key,
  :identity_center_application_arn,
  :identity_store_id)
  SENSITIVE = []
  include Aws::Structure
end

#subject_key ⇒ String

Specify the attribute that contains the subject (username, userID, email) of IAM Identity Center.

Returns:

  • (String) 


4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
 
# File 'lib/aws-sdk-opensearchservice/types.rb', line 4257

class IdentityCenterOptions < Struct.new(
  :enabled_api_access,
  :identity_center_instance_arn,
  :subject_key,
  :roles_key,
  :identity_center_application_arn,
  :identity_store_id)
  SENSITIVE = []
  include Aws::Structure
end