Package software.amazon.awssdk.services.elasticsearch.model

Interface SAMLOptionsOutput.Builder

All Superinterfaces:

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

Enclosing class:

SAMLOptionsOutput

@Mutable
@NotThreadSafe
public static interface SAMLOptionsOutput.Builder
extends SdkPojo, CopyableBuilder<SAMLOptionsOutput.Builder,SAMLOptionsOutput>

Method Summary

Modifier and Type	Method	Description
SAMLOptionsOutput.Builder	enabled(Boolean enabled)	True if SAML is enabled.
default SAMLOptionsOutput.Builder	idp(Consumer<SAMLIdp.Builder> idp)	Describes the SAML Identity Provider's information.
SAMLOptionsOutput.Builder	idp(SAMLIdp idp)	Describes the SAML Identity Provider's information.
SAMLOptionsOutput.Builder	rolesKey(String rolesKey)	The key used for matching the SAML Roles attribute.
SAMLOptionsOutput.Builder	sessionTimeoutMinutes(Integer sessionTimeoutMinutes)	The duration, in minutes, after which a user session becomes inactive.
SAMLOptionsOutput.Builder	subjectKey(String subjectKey)	The key used for matching the SAML Subject attribute.

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, sdkFieldNameToField, sdkFields

Method Detail

enabled

SAMLOptionsOutput.Builder enabled(Boolean enabled)

True if SAML is enabled.

Parameters:

enabled - True if SAML is enabled.

Returns:

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

idp

SAMLOptionsOutput.Builder idp(SAMLIdp idp)

Describes the SAML Identity Provider's information.

Parameters:

idp - Describes the SAML Identity Provider's information.

Returns:

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

idp

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

Describes 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)

subjectKey

SAMLOptionsOutput.Builder subjectKey(String subjectKey)

The key used for matching the SAML Subject attribute.

Parameters:

subjectKey - The key used for matching the SAML Subject attribute.

Returns:

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

rolesKey

SAMLOptionsOutput.Builder rolesKey(String rolesKey)

The key used for matching the SAML Roles attribute.

Parameters:

rolesKey - The key used for matching the SAML Roles attribute.

Returns:

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

sessionTimeoutMinutes

SAMLOptionsOutput.Builder sessionTimeoutMinutes(Integer sessionTimeoutMinutes)

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

Parameters:

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

Returns:

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