Class: Aws::OpenSearchService::Types::IdentityCenterOptionsInput

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

Overview

Configuration settings for enabling and managing IAM Identity Center.

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 API access in Amazon OpenSearch Service.

Returns:

  • (Boolean) 


5731
5732
5733
5734
5735
5736
5737
5738
5739
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5731

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

#identity_center_instance_arn ⇒ String

The ARN of the IAM Identity Center instance used to create an OpenSearch UI application that uses IAM Identity Center for authentication.

Returns:

  • (String) 


5731
5732
5733
5734
5735
5736
5737
5738
5739
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5731

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

#identity_center_instance_region ⇒ String

The Region of the IAM Identity Center instance.

Returns:

  • (String) 


5731
5732
5733
5734
5735
5736
5737
5738
5739
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5731

class IdentityCenterOptionsInput < Struct.new(
  :enabled_api_access,
  :identity_center_instance_arn,
  :identity_center_instance_region,
  :subject_key,
  :roles_key)
  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) 


5731
5732
5733
5734
5735
5736
5737
5738
5739
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5731

class IdentityCenterOptionsInput < Struct.new(
  :enabled_api_access,
  :identity_center_instance_arn,
  :identity_center_instance_region,
  :subject_key,
  :roles_key)
  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) 


5731
5732
5733
5734
5735
5736
5737
5738
5739
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/types.rb', line 5731

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