Interface AdminSetUserMfaPreferenceRequest.Builder

All Superinterfaces:

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

Enclosing class:

AdminSetUserMfaPreferenceRequest

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

Method Summary

Modifier and Type	Method	Description
default AdminSetUserMfaPreferenceRequest.Builder	emailMfaSettings(Consumer<EmailMfaSettingsType.Builder> emailMfaSettings)	User preferences for email message MFA.
AdminSetUserMfaPreferenceRequest.Builder	emailMfaSettings(EmailMfaSettingsType emailMfaSettings)	User preferences for email message MFA.
AdminSetUserMfaPreferenceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
AdminSetUserMfaPreferenceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default AdminSetUserMfaPreferenceRequest.Builder	smsMfaSettings(Consumer<SMSMfaSettingsType.Builder> smsMfaSettings)	User preferences for SMS message MFA.
AdminSetUserMfaPreferenceRequest.Builder	smsMfaSettings(SMSMfaSettingsType smsMfaSettings)	User preferences for SMS message MFA.
default AdminSetUserMfaPreferenceRequest.Builder	softwareTokenMfaSettings(Consumer<SoftwareTokenMfaSettingsType.Builder> softwareTokenMfaSettings)	User preferences for time-based one-time password (TOTP) MFA.
AdminSetUserMfaPreferenceRequest.Builder	softwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings)	User preferences for time-based one-time password (TOTP) MFA.
AdminSetUserMfaPreferenceRequest.Builder	username(String username)	The name of the user that you want to query or modify.
AdminSetUserMfaPreferenceRequest.Builder	userPoolId(String userPoolId)	The ID of the user pool where you want to set a user's MFA preferences.

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

Method Details

smsMfaSettings

AdminSetUserMfaPreferenceRequest.Builder smsMfaSettings(SMSMfaSettingsType smsMfaSettings)

User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as the preferred MFA method when multiple methods are available.

Parameters:

smsMfaSettings - User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as the preferred MFA method when multiple methods are available.

Returns:

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

smsMfaSettings

default AdminSetUserMfaPreferenceRequest.Builder smsMfaSettings(Consumer<SMSMfaSettingsType.Builder> smsMfaSettings)

User preferences for SMS message MFA. Activates or deactivates SMS MFA and sets it as the preferred MFA method when multiple methods are available.

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

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

Parameters:

smsMfaSettings - a consumer that will call methods on SMSMfaSettingsType.Builder

Returns:

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

See Also:

• smsMfaSettings(SMSMfaSettingsType)

softwareTokenMfaSettings

AdminSetUserMfaPreferenceRequest.Builder softwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings)

User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates TOTP MFA and sets it as the preferred MFA method when multiple methods are available. This operation can set TOTP as a user's preferred MFA method before they register a TOTP authenticator.

Parameters:

softwareTokenMfaSettings - User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates TOTP MFA and sets it as the preferred MFA method when multiple methods are available. This operation can set TOTP as a user's preferred MFA method before they register a TOTP authenticator.

Returns:

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

softwareTokenMfaSettings

default AdminSetUserMfaPreferenceRequest.Builder softwareTokenMfaSettings(Consumer<SoftwareTokenMfaSettingsType.Builder> softwareTokenMfaSettings)

User preferences for time-based one-time password (TOTP) MFA. Activates or deactivates TOTP MFA and sets it as the preferred MFA method when multiple methods are available. This operation can set TOTP as a user's preferred MFA method before they register a TOTP authenticator.

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

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

Parameters:

softwareTokenMfaSettings - a consumer that will call methods on SoftwareTokenMfaSettingsType.Builder

Returns:

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

See Also:

• softwareTokenMfaSettings(SoftwareTokenMfaSettingsType)

emailMfaSettings

AdminSetUserMfaPreferenceRequest.Builder emailMfaSettings(EmailMfaSettingsType emailMfaSettings)

User preferences for email message MFA. Activates or deactivates email MFA and sets it as the preferred MFA method when multiple methods are available. To activate this setting, your user pool must be in the Essentials tier or higher.

Parameters:

emailMfaSettings - User preferences for email message MFA. Activates or deactivates email MFA and sets it as the preferred MFA method when multiple methods are available. To activate this setting, your user pool must be in the Essentials tier or higher.

Returns:

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

emailMfaSettings

default AdminSetUserMfaPreferenceRequest.Builder emailMfaSettings(Consumer<EmailMfaSettingsType.Builder> emailMfaSettings)

User preferences for email message MFA. Activates or deactivates email MFA and sets it as the preferred MFA method when multiple methods are available. To activate this setting, your user pool must be in the Essentials tier or higher.

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

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

Parameters:

emailMfaSettings - a consumer that will call methods on EmailMfaSettingsType.Builder

Returns:

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

See Also:

• emailMfaSettings(EmailMfaSettingsType)

username

AdminSetUserMfaPreferenceRequest.Builder username(String username)

The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Parameters:

username - The name of the user that you want to query or modify. The value of this parameter is typically your user's username, but it can be any of their alias attributes. If username isn't an alias attribute in your user pool, this value must be the sub of a local user or the username of a user from a third-party IdP.

Returns:

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

userPoolId

AdminSetUserMfaPreferenceRequest.Builder userPoolId(String userPoolId)

The ID of the user pool where you want to set a user's MFA preferences.

Parameters:

userPoolId - The ID of the user pool where you want to set a user's MFA preferences.

Returns:

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

overrideConfiguration

AdminSetUserMfaPreferenceRequest.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

AdminSetUserMfaPreferenceRequest.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.