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

Interface SetUserPoolMfaConfigRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CognitoIdentityProviderRequest.Builder, CopyableBuilder<SetUserPoolMfaConfigRequest.Builder,SetUserPoolMfaConfigRequest>, SdkBuilder<SetUserPoolMfaConfigRequest.Builder,SetUserPoolMfaConfigRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

SetUserPoolMfaConfigRequest

public static interface SetUserPoolMfaConfigRequest.Builder
extends CognitoIdentityProviderRequest.Builder, SdkPojo, CopyableBuilder<SetUserPoolMfaConfigRequest.Builder,SetUserPoolMfaConfigRequest>

Method Summary

Modifier and Type	Method	Description
SetUserPoolMfaConfigRequest.Builder	mfaConfiguration(String mfaConfiguration)	The MFA configuration.
SetUserPoolMfaConfigRequest.Builder	mfaConfiguration(UserPoolMfaType mfaConfiguration)	The MFA configuration.
SetUserPoolMfaConfigRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SetUserPoolMfaConfigRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default SetUserPoolMfaConfigRequest.Builder	smsMfaConfiguration(Consumer<SmsMfaConfigType.Builder> smsMfaConfiguration)	The SMS text message MFA configuration.
SetUserPoolMfaConfigRequest.Builder	smsMfaConfiguration(SmsMfaConfigType smsMfaConfiguration)	The SMS text message MFA configuration.
default SetUserPoolMfaConfigRequest.Builder	softwareTokenMfaConfiguration(Consumer<SoftwareTokenMfaConfigType.Builder> softwareTokenMfaConfiguration)	The software token MFA configuration.
SetUserPoolMfaConfigRequest.Builder	softwareTokenMfaConfiguration(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration)	The software token MFA configuration.
SetUserPoolMfaConfigRequest.Builder	userPoolId(String userPoolId)	The user pool ID.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

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

build

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 Details

userPoolId

SetUserPoolMfaConfigRequest.Builder userPoolId(String userPoolId)

The user pool ID.

Parameters:

userPoolId - The user pool ID.

Returns:

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

smsMfaConfiguration

SetUserPoolMfaConfigRequest.Builder smsMfaConfiguration(SmsMfaConfigType smsMfaConfiguration)

The SMS text message MFA configuration.

Parameters:

smsMfaConfiguration - The SMS text message MFA configuration.

Returns:

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

smsMfaConfiguration

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

The SMS text message 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

SetUserPoolMfaConfigRequest.Builder softwareTokenMfaConfiguration(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration)

The software token MFA configuration.

Parameters:

softwareTokenMfaConfiguration - The software token MFA configuration.

Returns:

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

softwareTokenMfaConfiguration

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

The software token 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

SetUserPoolMfaConfigRequest.Builder mfaConfiguration(String mfaConfiguration)

The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. 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 MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. 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

SetUserPoolMfaConfigRequest.Builder mfaConfiguration(UserPoolMfaType mfaConfiguration)

The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. 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 MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. 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

overrideConfiguration

SetUserPoolMfaConfigRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

SetUserPoolMfaConfigRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.