aws-cdk-lib.aws_opensearchserverless.CfnSecurityConfig.SamlConfigOptionsProperty

interface SamlConfigOptionsProperty

LanguageType name
.NETAmazon.CDK.AWS.OpenSearchServerless.CfnSecurityConfig.SamlConfigOptionsProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsopensearchserverless#CfnSecurityConfig_SamlConfigOptionsProperty
Javasoftware.amazon.awscdk.services.opensearchserverless.CfnSecurityConfig.SamlConfigOptionsProperty
Pythonaws_cdk.aws_opensearchserverless.CfnSecurityConfig.SamlConfigOptionsProperty
TypeScript aws-cdk-lib » aws_opensearchserverless » CfnSecurityConfig » SamlConfigOptionsProperty

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

Example

// 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',
  sessionTimeout: 123,
  userAttribute: 'userAttribute',
};

Properties

NameTypeDescription
metadatastringThe XML IdP metadata file generated from your identity provider.
groupAttribute?stringThe group attribute for this SAML integration.
sessionTimeout?numberThe session timeout, in minutes.
userAttribute?stringA user attribute for this SAML integration.

metadata

Type: string

The XML IdP metadata file generated from your identity provider.


groupAttribute?

Type: string (optional)

The group attribute for this SAML integration.


sessionTimeout?

Type: number (optional)

The session timeout, in minutes.

Default is 60 minutes (12 hours).


userAttribute?

Type: string (optional)

A user attribute for this SAML integration.