Package software.amazon.awscdk.services.opensearchservice

Class SAMLOptionsProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<SAMLOptionsProperty>

Enclosing interface:

SAMLOptionsProperty

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

A builder for SAMLOptionsProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SAMLOptionsProperty	build()	Builds the configured instance.
SAMLOptionsProperty.Builder	idpEntityId(String idpEntityId)	Sets the value of SAMLOptionsProperty.getIdpEntityId()
SAMLOptionsProperty.Builder	idpMetadataContent(String idpMetadataContent)	Sets the value of SAMLOptionsProperty.getIdpMetadataContent()
SAMLOptionsProperty.Builder	masterBackendRole(String masterBackendRole)	Sets the value of SAMLOptionsProperty.getMasterBackendRole()
SAMLOptionsProperty.Builder	masterUserName(String masterUserName)	Sets the value of SAMLOptionsProperty.getMasterUserName()
SAMLOptionsProperty.Builder	rolesKey(String rolesKey)	Sets the value of SAMLOptionsProperty.getRolesKey()
SAMLOptionsProperty.Builder	sessionTimeoutMinutes(Number sessionTimeoutMinutes)	Sets the value of SAMLOptionsProperty.getSessionTimeoutMinutes()
SAMLOptionsProperty.Builder	subjectKey(String subjectKey)	Sets the value of 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

idpEntityId

@Stability(Stable)
public SAMLOptionsProperty.Builder idpEntityId(String idpEntityId)

Sets the value of SAMLOptionsProperty.getIdpEntityId()

Parameters:

idpEntityId - The unique entity ID of the application in the SAML identity provider. This parameter is required.

Returns:

this

idpMetadataContent

@Stability(Stable)
public SAMLOptionsProperty.Builder idpMetadataContent(String idpMetadataContent)

Sets the value of SAMLOptionsProperty.getIdpMetadataContent()

Parameters:

idpMetadataContent - The metadata of the SAML application, in XML format. This parameter is required.

Returns:

this

masterBackendRole

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

Sets the value of SAMLOptionsProperty.getMasterBackendRole()

Parameters:

masterBackendRole - The backend role that the SAML master user is mapped to. Any users with this backend role receives full permission in OpenSearch Dashboards/Kibana. To use a SAML master backend role, configure the rolesKey property.

Returns:

this

masterUserName

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

Sets the value of SAMLOptionsProperty.getMasterUserName()

Parameters:

masterUserName - The SAML master username, which is stored in the domain's internal user database. This SAML user receives full permission in OpenSearch Dashboards/Kibana. Creating a new master username does not delete any existing master usernames.

Returns:

this

rolesKey

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

Sets the value of SAMLOptionsProperty.getRolesKey()

Parameters:

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

Returns:

this

sessionTimeoutMinutes

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

Sets the value of SAMLOptionsProperty.getSessionTimeoutMinutes()

Parameters:

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

Returns:

this

subjectKey

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

Sets the value of SAMLOptionsProperty.getSubjectKey()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public SAMLOptionsProperty build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SAMLOptionsProperty

Throws:

NullPointerException - if any required attribute was not provided