Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface GetUserPoolMfaConfigResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CognitoIdentityProviderResponse.Builder, CopyableBuilder<GetUserPoolMfaConfigResponse.Builder,GetUserPoolMfaConfigResponse>, SdkBuilder<GetUserPoolMfaConfigResponse.Builder,GetUserPoolMfaConfigResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetUserPoolMfaConfigResponse

public static interface GetUserPoolMfaConfigResponse.Builder
extends CognitoIdentityProviderResponse.Builder, SdkPojo, CopyableBuilder<GetUserPoolMfaConfigResponse.Builder,GetUserPoolMfaConfigResponse>

Method Summary

Modifier and Type	Method	Description
GetUserPoolMfaConfigResponse.Builder	mfaConfiguration(String mfaConfiguration)	The multi-factor authentication (MFA) configuration.
GetUserPoolMfaConfigResponse.Builder	mfaConfiguration(UserPoolMfaType mfaConfiguration)	The multi-factor authentication (MFA) configuration.
default GetUserPoolMfaConfigResponse.Builder	smsMfaConfiguration(Consumer<SmsMfaConfigType.Builder> smsMfaConfiguration)	The SMS text message multi-factor authentication (MFA) configuration.
GetUserPoolMfaConfigResponse.Builder	smsMfaConfiguration(SmsMfaConfigType smsMfaConfiguration)	The SMS text message multi-factor authentication (MFA) configuration.
default GetUserPoolMfaConfigResponse.Builder	softwareTokenMfaConfiguration(Consumer<SoftwareTokenMfaConfigType.Builder> softwareTokenMfaConfiguration)	The software token multi-factor authentication (MFA) configuration.
GetUserPoolMfaConfigResponse.Builder	softwareTokenMfaConfiguration(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration)	The software token multi-factor authentication (MFA) configuration.

Methods inherited from interface software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse.Builder

build, responseMetadata, responseMetadata

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

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

smsMfaConfiguration

GetUserPoolMfaConfigResponse.Builder smsMfaConfiguration(SmsMfaConfigType smsMfaConfiguration)

The SMS text message multi-factor authentication (MFA) configuration.

Parameters:

smsMfaConfiguration - The SMS text message multi-factor authentication (MFA) configuration.

Returns:

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

smsMfaConfiguration

default GetUserPoolMfaConfigResponse.Builder smsMfaConfiguration(Consumer<SmsMfaConfigType.Builder> smsMfaConfiguration)

The SMS text message multi-factor authentication (MFA) configuration.

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

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

Parameters:

smsMfaConfiguration - a consumer that will call methods on SmsMfaConfigType.Builder

Returns:

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

See Also:

• smsMfaConfiguration(SmsMfaConfigType)

softwareTokenMfaConfiguration

GetUserPoolMfaConfigResponse.Builder softwareTokenMfaConfiguration(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration)

The software token multi-factor authentication (MFA) configuration.

Parameters:

softwareTokenMfaConfiguration - The software token multi-factor authentication (MFA) configuration.

Returns:

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

softwareTokenMfaConfiguration

default GetUserPoolMfaConfigResponse.Builder softwareTokenMfaConfiguration(Consumer<SoftwareTokenMfaConfigType.Builder> softwareTokenMfaConfiguration)

The software token multi-factor authentication (MFA) configuration.

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

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

Parameters:

softwareTokenMfaConfiguration - a consumer that will call methods on SoftwareTokenMfaConfigType.Builder

Returns:

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

See Also:

• softwareTokenMfaConfiguration(SoftwareTokenMfaConfigType)

mfaConfiguration

GetUserPoolMfaConfigResponse.Builder mfaConfiguration(String mfaConfiguration)

The multi-factor authentication (MFA) configuration. Valid values include:

• OFF MFA won't be used for any users.

• ON MFA is required for all users to sign in.

• OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

Parameters:

mfaConfiguration - The multi-factor authentication (MFA) configuration. Valid values include:

• OFF MFA won't be used for any users.

• ON MFA is required for all users to sign in.

• OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

Returns:

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

See Also:

• UserPoolMfaType
• UserPoolMfaType

mfaConfiguration

GetUserPoolMfaConfigResponse.Builder mfaConfiguration(UserPoolMfaType mfaConfiguration)

The multi-factor authentication (MFA) configuration. Valid values include:

• OFF MFA won't be used for any users.

• ON MFA is required for all users to sign in.

• OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

Parameters:

mfaConfiguration - The multi-factor authentication (MFA) configuration. Valid values include:

• OFF MFA won't be used for any users.

• ON MFA is required for all users to sign in.

• OPTIONAL MFA will be required only for individual users who have an MFA factor activated.

Returns:

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

See Also:

• UserPoolMfaType
• UserPoolMfaType