Package software.amazon.awscdk.services.opensearchservice

Class CfnDomain.SAMLOptionsProperty.Builder

java.lang.Object

software.amazon.awscdk.services.opensearchservice.CfnDomain.SAMLOptionsProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDomain.SAMLOptionsProperty>

Enclosing interface:

CfnDomain.SAMLOptionsProperty

@Stability(Stable)
public static final class CfnDomain.SAMLOptionsProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDomain.SAMLOptionsProperty>

A builder for CfnDomain.SAMLOptionsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDomain.SAMLOptionsProperty	build()	Builds the configured instance.
CfnDomain.SAMLOptionsProperty.Builder	enabled(Boolean enabled)	Sets the value of CfnDomain.SAMLOptionsProperty.getEnabled()
CfnDomain.SAMLOptionsProperty.Builder	enabled(IResolvable enabled)	Sets the value of CfnDomain.SAMLOptionsProperty.getEnabled()
CfnDomain.SAMLOptionsProperty.Builder	idp(IResolvable idp)	Sets the value of CfnDomain.SAMLOptionsProperty.getIdp()
CfnDomain.SAMLOptionsProperty.Builder	idp(CfnDomain.IdpProperty idp)	Sets the value of CfnDomain.SAMLOptionsProperty.getIdp()
CfnDomain.SAMLOptionsProperty.Builder	masterBackendRole(String masterBackendRole)	Sets the value of CfnDomain.SAMLOptionsProperty.getMasterBackendRole()
CfnDomain.SAMLOptionsProperty.Builder	masterUserName(String masterUserName)	Sets the value of CfnDomain.SAMLOptionsProperty.getMasterUserName()
CfnDomain.SAMLOptionsProperty.Builder	rolesKey(String rolesKey)	Sets the value of CfnDomain.SAMLOptionsProperty.getRolesKey()
CfnDomain.SAMLOptionsProperty.Builder	sessionTimeoutMinutes(Number sessionTimeoutMinutes)	Sets the value of CfnDomain.SAMLOptionsProperty.getSessionTimeoutMinutes()
CfnDomain.SAMLOptionsProperty.Builder	subjectKey(String subjectKey)	Sets the value of CfnDomain.SAMLOptionsProperty.getSubjectKey()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

enabled

@Stability(Stable)
public CfnDomain.SAMLOptionsProperty.Builder enabled(Boolean enabled)

Sets the value of CfnDomain.SAMLOptionsProperty.getEnabled()

Parameters:

enabled - True to enable SAML authentication for a domain.

Returns:

this

enabled

@Stability(Stable)
public CfnDomain.SAMLOptionsProperty.Builder enabled(IResolvable enabled)

Sets the value of CfnDomain.SAMLOptionsProperty.getEnabled()

Parameters:

enabled - True to enable SAML authentication for a domain.

Returns:

this

idp

@Stability(Stable)
public CfnDomain.SAMLOptionsProperty.Builder idp(IResolvable idp)

Sets the value of CfnDomain.SAMLOptionsProperty.getIdp()

Parameters:

idp - The SAML Identity Provider's information.

Returns:

this

idp

@Stability(Stable)
public CfnDomain.SAMLOptionsProperty.Builder idp(CfnDomain.IdpProperty idp)

Sets the value of CfnDomain.SAMLOptionsProperty.getIdp()

Parameters:

idp - The SAML Identity Provider's information.

Returns:

this

masterBackendRole

@Stability(Stable)
public CfnDomain.SAMLOptionsProperty.Builder masterBackendRole(String masterBackendRole)

Sets the value of CfnDomain.SAMLOptionsProperty.getMasterBackendRole()

Parameters:

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

Returns:

this

masterUserName

@Stability(Stable)
public CfnDomain.SAMLOptionsProperty.Builder masterUserName(String masterUserName)

Sets the value of CfnDomain.SAMLOptionsProperty.getMasterUserName()

Parameters:

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

Returns:

this

rolesKey

@Stability(Stable)
public CfnDomain.SAMLOptionsProperty.Builder rolesKey(String rolesKey)

Sets the value of CfnDomain.SAMLOptionsProperty.getRolesKey()

Parameters:

rolesKey - Element of the SAML assertion to use for backend roles. Default is roles .

Returns:

this

sessionTimeoutMinutes

@Stability(Stable)
public CfnDomain.SAMLOptionsProperty.Builder sessionTimeoutMinutes(Number sessionTimeoutMinutes)

Sets the value of CfnDomain.SAMLOptionsProperty.getSessionTimeoutMinutes()

Parameters:

sessionTimeoutMinutes - The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

Returns:

this

subjectKey

@Stability(Stable)
public CfnDomain.SAMLOptionsProperty.Builder subjectKey(String subjectKey)

Sets the value of CfnDomain.SAMLOptionsProperty.getSubjectKey()

Parameters:

subjectKey - Element of the SAML assertion to use for the user name. Default is NameID .

Returns:

this

build

@Stability(Stable)
public CfnDomain.SAMLOptionsProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDomain.SAMLOptionsProperty>

Returns:

a new instance of CfnDomain.SAMLOptionsProperty

Throws:

NullPointerException - if any required attribute was not provided