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

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

Overview

Settings container for integrating IAM Identity Center with OpenSearch UI applications, which enables enabling secure user authentication and access control across multiple data sources. This setup supports single sign-on (SSO) through IAM Identity Center, allowing centralized user management.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enabled_api_access ⇒ Boolean

Indicates whether IAM Identity Center is enabled for the application.

Returns:

  • (Boolean) 


4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4813

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 of the IAM Identity Center application that integrates with Amazon OpenSearch Service.

Returns:

  • (String) 


4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4813

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 Amazon Resource Name (ARN) of the IAM Identity Center instance.

Returns:

  • (String) 


4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4813

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 identifier of the IAM Identity Store.

Returns:

  • (String) 


4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4813

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

Specifies the attribute that contains the backend role identifier (such as group name or group ID) in IAM Identity Center.

Returns:

  • (String) 


4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4813

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

Specifies the attribute that contains the subject identifier (such as username, user ID, or email) in IAM Identity Center.

Returns:

  • (String) 


4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 4813

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