IdentityCenterOptionsInput - Amazon OpenSearch Service
ContentsSee Also
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

IdentityCenterOptionsInput

Configuration settings for enabling and managing IAM Identity Center.

Contents

EnabledAPIAccess

Indicates whether IAM Identity Center is enabled for API access in Amazon OpenSearch Service.

Type: Boolean

Required: No

IdentityCenterInstanceARN

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

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws[a-z\\-]*:[a-z]+:[a-z0-9\\-]*:[0-9]*:[a-z0-9\\-]+\/[a-z0-9\\-]+

Required: No

RolesKey

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

Type: String

Valid Values: GroupName | GroupId

Required: No

SubjectKey

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

Type: String

Valid Values: UserName | UserId | Email

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: