interface SamlConfigOptionsProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.OpenSearchServerless.Mixins.CfnSecurityConfigPropsMixin.SamlConfigOptionsProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsopensearchserverless/mixins#CfnSecurityConfigPropsMixin_SamlConfigOptionsProperty
Java	software.amazon.awscdk.mixins.preview.services.opensearchserverless.mixins.CfnSecurityConfigPropsMixin.SamlConfigOptionsProperty
Python	aws_cdk.mixins_preview.aws_opensearchserverless.mixins.CfnSecurityConfigPropsMixin.SamlConfigOptionsProperty
TypeScript	@aws-cdk/mixins-preview » aws_opensearchserverless » mixins » CfnSecurityConfigPropsMixin » SamlConfigOptionsProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as opensearchserverless_mixins } from '@aws-cdk/mixins-preview/aws-opensearchserverless';
const samlConfigOptionsProperty: opensearchserverless_mixins.CfnSecurityConfigPropsMixin.SamlConfigOptionsProperty = {
  groupAttribute: 'groupAttribute',
  metadata: 'metadata',
  openSearchServerlessEntityId: 'openSearchServerlessEntityId',
  sessionTimeout: 123,
  userAttribute: 'userAttribute',
};

Properties

Name	Type	Description
groupAttribute?	string	The group attribute for this SAML integration.
metadata?	string	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.
userAttribute?	string	A user attribute for this SAML integration.

---

groupAttribute?

Type: string (optional)

The group attribute for this SAML integration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html#cfn-opensearchserverless-securityconfig-samlconfigoptions-groupattribute

---

metadata?

Type: string (optional)

The XML IdP metadata file generated from your identity provider.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html#cfn-opensearchserverless-securityconfig-samlconfigoptions-metadata

---

openSearchServerlessEntityId?

Type: string (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html#cfn-opensearchserverless-securityconfig-samlconfigoptions-opensearchserverlessentityid

---

sessionTimeout?

Type: number (optional)

The session timeout, in minutes.

Default is 60 minutes (12 hours).

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html#cfn-opensearchserverless-securityconfig-samlconfigoptions-sessiontimeout

---

userAttribute?

Type: string (optional)

A user attribute for this SAML integration.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchserverless-securityconfig-samlconfigoptions.html#cfn-opensearchserverless-securityconfig-samlconfigoptions-userattribute