SamlConfigOptions - Amazon OpenSearch Serverless
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.

SamlConfigOptions

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

Contents

metadata

The XML IdP metadata file generated from your identity provider.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 51200.

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

Required: Yes

groupAttribute

The group attribute for this SAML integration.

Type: String

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

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

Required: No

openSearchServerlessEntityId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

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

Required: No

sessionTimeout

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

Type: Integer

Valid Range: Minimum value of 5. Maximum value of 720.

Required: No

userAttribute

A user attribute for this SAML integration.

Type: String

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

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

Required: No

See Also

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