Package software.amazon.awssdk.services.opensearch.model

Interface SAMLOptionsInput.Builder

All Superinterfaces:

Buildable, CopyableBuilder<SAMLOptionsInput.Builder,SAMLOptionsInput>, SdkBuilder<SAMLOptionsInput.Builder,SAMLOptionsInput>, SdkPojo

Enclosing class:

SAMLOptionsInput

public static interface SAMLOptionsInput.Builder
extends SdkPojo, CopyableBuilder<SAMLOptionsInput.Builder,SAMLOptionsInput>

Method Summary

Modifier and Type	Method	Description
SAMLOptionsInput.Builder	enabled(Boolean enabled)	True to enable SAML authentication for a domain.
default SAMLOptionsInput.Builder	idp(Consumer<SAMLIdp.Builder> idp)	The SAML Identity Provider's information.
SAMLOptionsInput.Builder	idp(SAMLIdp idp)	The SAML Identity Provider's information.
SAMLOptionsInput.Builder	masterBackendRole(String masterBackendRole)	The backend role that the SAML master user is mapped to.
SAMLOptionsInput.Builder	masterUserName(String masterUserName)	The SAML master user name, which is stored in the domain's internal user database.
SAMLOptionsInput.Builder	rolesKey(String rolesKey)	Element of the SAML assertion to use for backend roles.
SAMLOptionsInput.Builder	sessionTimeoutMinutes(Integer sessionTimeoutMinutes)	The duration, in minutes, after which a user session becomes inactive.
SAMLOptionsInput.Builder	subjectKey(String subjectKey)	Element of the SAML assertion to use for the user name.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Method Detail

enabled

SAMLOptionsInput.Builder enabled(Boolean enabled)

True to enable SAML authentication for a domain.

Parameters:

enabled - True to enable SAML authentication for a domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

idp

SAMLOptionsInput.Builder idp(SAMLIdp idp)

The SAML Identity Provider's information.

Parameters:

idp - The SAML Identity Provider's information.

Returns:

Returns a reference to this object so that method calls can be chained together.

idp

default SAMLOptionsInput.Builder idp(Consumer<SAMLIdp.Builder> idp)

The SAML Identity Provider's information.

This is a convenience method that creates an instance of the SAMLIdp.Builder avoiding the need to create one manually via SAMLIdp.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to idp(SAMLIdp).

Parameters:

idp - a consumer that will call methods on SAMLIdp.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

idp(SAMLIdp)

masterUserName

SAMLOptionsInput.Builder masterUserName(String masterUserName)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

masterBackendRole

SAMLOptionsInput.Builder masterBackendRole(String masterBackendRole)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

subjectKey

SAMLOptionsInput.Builder subjectKey(String subjectKey)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

rolesKey

SAMLOptionsInput.Builder rolesKey(String rolesKey)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

sessionTimeoutMinutes

SAMLOptionsInput.Builder sessionTimeoutMinutes(Integer 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.

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:

Returns a reference to this object so that method calls can be chained together.