AWS::OpenSearchServerless::SecurityConfig IamIdentityCenterConfigOptions - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::OpenSearchServerless::SecurityConfig IamIdentityCenterConfigOptions

Describes IAM Identity Center options for an OpenSearch Serverless security configuration in the form of a key-value map.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "ApplicationArn" : String,
  "ApplicationDescription" : String,
  "ApplicationName" : String,
  "GroupAttribute" : String,
  "InstanceArn" : String,
  "UserAttribute" : String
}

Properties

ApplicationArn

The ARN of the IAM Identity Center application used to integrate with OpenSearch Serverless.

Required: No

Type: String

Pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso::\d{12}:application/(sso)?ins-[a-zA-Z0-9-.]{16}/apl-[a-zA-Z0-9]{16}

Minimum: 10

Maximum: 1224

Update requires: No interruption

ApplicationDescription

The description of the IAM Identity Center application used to integrate with OpenSearch Serverless.

Required: No

Type: String

Update requires: No interruption

ApplicationName

The name of the IAM Identity Center application used to integrate with OpenSearch Serverless.

Required: No

Type: String

Update requires: No interruption

GroupAttribute

The group attribute for this IAM Identity Center integration. Defaults to GroupId.

Required: No

Type: String

Allowed values: GroupId | GroupName

Update requires: No interruption

InstanceArn

The ARN of the IAM Identity Center instance used to integrate with OpenSearch Serverless.

Required: Yes

Type: String

Pattern: arn:(aws|aws-us-gov|aws-cn|aws-iso|aws-iso-b):sso:::instance/(sso)?ins-[a-zA-Z0-9-.]{16}

Minimum: 10

Maximum: 1224

Update requires: Replacement

UserAttribute

The user attribute for this IAM Identity Center integration. Defaults to UserId

Required: No

Type: String

Allowed values: UserId | UserName | Email

Update requires: No interruption