Package software.amazon.awscdk.services.opensearchserverless

Interface CfnSecurityConfig.SamlConfigOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSecurityConfig.SamlConfigOptionsProperty.Jsii$Proxy

Enclosing class:

CfnSecurityConfig

@Stability(Stable)
public static interface CfnSecurityConfig.SamlConfigOptionsProperty
extends software.amazon.jsii.JsiiSerializable

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 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();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSecurityConfig.SamlConfigOptionsProperty.Builder	A builder for CfnSecurityConfig.SamlConfigOptionsProperty
static final class	CfnSecurityConfig.SamlConfigOptionsProperty.Jsii$Proxy	An implementation for CfnSecurityConfig.SamlConfigOptionsProperty

Method Summary

Modifier and Type	Method	Description
static CfnSecurityConfig.SamlConfigOptionsProperty.Builder	builder()
default String	getGroupAttribute()	The group attribute for this SAML integration.
String	getMetadata()	The XML IdP metadata file generated from your identity provider.
default String	getOpenSearchServerlessEntityId()	Custom entity ID attribute to override the default entity ID for this SAML integration.
default Number	getSessionTimeout()	The session timeout, in minutes.
default String	getUserAttribute()	A user attribute for this SAML integration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMetadata

@Stability(Stable)
@NotNull
String getMetadata()

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

getGroupAttribute

@Stability(Stable)
@Nullable
default String getGroupAttribute()

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

getOpenSearchServerlessEntityId

@Stability(Stable)
@Nullable
default String getOpenSearchServerlessEntityId()

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

getSessionTimeout

@Stability(Stable)
@Nullable
default Number getSessionTimeout()

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

getUserAttribute

@Stability(Stable)
@Nullable
default String getUserAttribute()

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

builder

@Stability(Stable)
static CfnSecurityConfig.SamlConfigOptionsProperty.Builder builder()

Returns:

a CfnSecurityConfig.SamlConfigOptionsProperty.Builder of CfnSecurityConfig.SamlConfigOptionsProperty