# SamlConfigOptionsProperty

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

- Source: Generated code
- Type last changed: v2.180.0 · 21 Feb 2025

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_opensearchserverless as opensearchserverless } from 'aws-cdk-lib';
const samlConfigOptionsProperty: opensearchserverless.CfnSecurityConfig.SamlConfigOptionsProperty = {
  metadata: 'metadata',

  // the properties below are optional
  groupAttribute: 'groupAttribute',
  openSearchServerlessEntityId: 'openSearchServerlessEntityId',
  sessionTimeout: 123,
  userAttribute: 'userAttribute',
};
```

## Properties

- `groupAttribute`: string — The group attribute for this SAML integration.

- `metadata`: string (required) — The XML IdP metadata file generated from your identity provider.

- `openSearchServerlessEntityId`: string — Custom entity ID attribute to override the default entity ID for this SAML integration.

- `sessionTimeout`: number — The session timeout, in minutes.

  Default is 60 minutes (12 hours).

- `userAttribute`: string — A user attribute for this SAML integration.