Package software.amazon.awscdk.services.opensearchservice

Interface CfnDomain.SAMLOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDomain.SAMLOptionsProperty.Jsii$Proxy

Enclosing class:

CfnDomain

@Stability(Stable)
public static interface CfnDomain.SAMLOptionsProperty
extends software.amazon.jsii.JsiiSerializable

Container for information about the SAML configuration for OpenSearch Dashboards.

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.opensearchservice.*;
 SAMLOptionsProperty sAMLOptionsProperty = SAMLOptionsProperty.builder()
         .enabled(false)
         .idp(IdpProperty.builder()
                 .entityId("entityId")
                 .metadataContent("metadataContent")
                 .build())
         .masterBackendRole("masterBackendRole")
         .masterUserName("masterUserName")
         .rolesKey("rolesKey")
         .sessionTimeoutMinutes(123)
         .subjectKey("subjectKey")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDomain.SAMLOptionsProperty.Builder	builder()
default Object	getEnabled()	True to enable SAML authentication for a domain.
default Object	getIdp()	The SAML Identity Provider's information.
default String	getMasterBackendRole()	The backend role that the SAML master user is mapped to.
default String	getMasterUserName()	The SAML master user name, which is stored in the domain's internal user database.
default String	getRolesKey()	Element of the SAML assertion to use for backend roles.
default Number	getSessionTimeoutMinutes()	The duration, in minutes, after which a user session becomes inactive.
default String	getSubjectKey()	Element of the SAML assertion to use for the user name.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEnabled

@Stability(Stable)
@Nullable
default Object getEnabled()

True to enable SAML authentication for a domain.

Returns union: either Boolean or IResolvable

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-enabled

getIdp

@Stability(Stable)
@Nullable
default Object getIdp()

The SAML Identity Provider's information.

Returns union: either IResolvable or CfnDomain.IdpProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-idp

getMasterBackendRole

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

The backend role that the SAML master user is mapped to.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-masterbackendrole

getMasterUserName

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

The SAML master user name, which is stored in the domain's internal user database.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-masterusername

getRolesKey

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

Element of the SAML assertion to use for backend roles.

Default is roles .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-roleskey

getSessionTimeoutMinutes

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

The duration, in minutes, after which a user session becomes inactive.

Acceptable values are between 1 and 1440, and the default value is 60.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-sessiontimeoutminutes

getSubjectKey

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

Element of the SAML assertion to use for the user name.

Default is NameID .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opensearchservice-domain-samloptions.html#cfn-opensearchservice-domain-samloptions-subjectkey

builder

@Stability(Stable)
static CfnDomain.SAMLOptionsProperty.Builder builder()

Returns:

a CfnDomain.SAMLOptionsProperty.Builder of CfnDomain.SAMLOptionsProperty