AWS::OpenSearchServerless::SecurityConfig SamlConfigOptions - AWS CloudFormation
SyntaxProperties

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

AWS::OpenSearchServerless::SecurityConfig SamlConfigOptions

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

Syntax

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

JSON

{
  "GroupAttribute" : String,
  "Metadata" : String,
  "OpenSearchServerlessEntityId" : String,
  "SessionTimeout" : Integer,
  "UserAttribute" : String
}

Properties

GroupAttribute

The group attribute for this SAML integration.

Required: No

Type: String

Pattern: [\w+=,.@-]+

Minimum: 1

Maximum: 2048

Update requires: No interruption

Metadata

The XML IdP metadata file generated from your identity provider.

Required: Yes

Type: String

Pattern: [\u0009\u000A\u000D\u0020-\u007E\u00A1-\u00FF]+

Minimum: 1

Maximum: 51200

Update requires: No interruption

OpenSearchServerlessEntityId

Custom entity ID attribute to override the default entity ID for this SAML integration.

Required: No

Type: String

Pattern: ^aws:opensearch:[0-9]{12}:*

Minimum: 1

Maximum: 1024

Update requires: No interruption

SessionTimeout

The session timeout, in minutes. Default is 60 minutes (12 hours).

Required: No

Type: Integer

Minimum: 5

Maximum: 720

Update requires: No interruption

UserAttribute

A user attribute for this SAML integration.

Required: No

Type: String

Pattern: [\w+=,.@-]+

Minimum: 1

Maximum: 2048

Update requires: No interruption