SamlConfigOptionsProperty Struct
Describes SAML options for an OpenSearch Serverless security configuration in the form of a key-value map.
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',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_opensearchserverless as opensearchserverless
saml_config_options_property = opensearchserverless.CfnSecurityConfig.SamlConfigOptionsProperty(
metadata="metadata",
# the properties below are optional
group_attribute="groupAttribute",
open_search_serverless_entity_id="openSearchServerlessEntityId",
session_timeout=123,
user_attribute="userAttribute"
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.opensearchserverless.*;
SamlConfigOptionsProperty samlConfigOptionsProperty = SamlConfigOptionsProperty.builder()
.metadata("metadata")
// the properties below are optional
.groupAttribute("groupAttribute")
.openSearchServerlessEntityId("openSearchServerlessEntityId")
.sessionTimeout(123)
.userAttribute("userAttribute")
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.OpenSearchServerless;
var samlConfigOptionsProperty = new SamlConfigOptionsProperty {
Metadata = "metadata",
// the properties below are optional
GroupAttribute = "groupAttribute",
OpenSearchServerlessEntityId = "openSearchServerlessEntityId",
SessionTimeout = 123,
UserAttribute = "userAttribute"
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
samlConfigOptionsProperty := &SamlConfigOptionsProperty{
Metadata: jsii.String("metadata"),
// the properties below are optional
GroupAttribute: jsii.String("groupAttribute"),
OpenSearchServerlessEntityId: jsii.String("openSearchServerlessEntityId"),
SessionTimeout: jsii.Number(123),
UserAttribute: jsii.String("userAttribute"),
}
Properties
groupAttributeoptionalstringgroup_attributeoptionalstrgroupAttributeoptionalStringGroupAttributeoptionalstringGroupAttributeoptional*string#The group attribute for this SAML integration.
The XML IdP metadata file generated from your identity provider.
openSearchServerlessEntityIdoptionalstringopen_search_serverless_entity_idoptionalstropenSearchServerlessEntityIdoptionalStringOpenSearchServerlessEntityIdoptionalstringOpenSearchServerlessEntityIdoptional*string#Custom entity ID attribute to override the default entity ID for this SAML integration.
sessionTimeoutoptionalnumbersession_timeoutoptionalint | floatsessionTimeoutoptionalNumberSessionTimeoutoptionaldoubleSessionTimeoutoptional*float64#The session timeout, in minutes.
Default is 60 minutes (12 hours).
userAttributeoptionalstringuser_attributeoptionalstruserAttributeoptionalStringUserAttributeoptionalstringUserAttributeoptional*string#A user attribute for this SAML integration.