Interface SetUserMfaPreferenceRequest.Builder

All Superinterfaces:

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

Enclosing class:

SetUserMfaPreferenceRequest

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

Method Summary

Modifier and Type	Method	Description
SetUserMfaPreferenceRequest.Builder	accessToken(String accessToken)	A valid access token that Amazon Cognito issued to the currently signed-in user.
default SetUserMfaPreferenceRequest.Builder	emailMfaSettings(Consumer<EmailMfaSettingsType.Builder> emailMfaSettings)	User preferences for email message MFA.
SetUserMfaPreferenceRequest.Builder	emailMfaSettings(EmailMfaSettingsType emailMfaSettings)	User preferences for email message MFA.
SetUserMfaPreferenceRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
SetUserMfaPreferenceRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default SetUserMfaPreferenceRequest.Builder	smsMfaSettings(Consumer<SMSMfaSettingsType.Builder> smsMfaSettings)	User preferences for SMS message MFA.
SetUserMfaPreferenceRequest.Builder	smsMfaSettings(SMSMfaSettingsType smsMfaSettings)	User preferences for SMS message MFA.
default SetUserMfaPreferenceRequest.Builder	softwareTokenMfaSettings(Consumer<SoftwareTokenMfaSettingsType.Builder> softwareTokenMfaSettings)	User preferences for time-based one-time password (TOTP) MFA.
SetUserMfaPreferenceRequest.Builder	softwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings)	User preferences for time-based one-time password (TOTP) MFA.

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

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

SetUserMfaPreferenceRequest.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. Users must register a TOTP authenticator before they set this as their preferred MFA method.

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. Users must register a TOTP authenticator before they set this as their preferred MFA method.

Returns:

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

softwareTokenMfaSettings

default SetUserMfaPreferenceRequest.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. Users must register a TOTP authenticator before they set this as their preferred MFA method.

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

SetUserMfaPreferenceRequest.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 SetUserMfaPreferenceRequest.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)

accessToken

SetUserMfaPreferenceRequest.Builder accessToken(String accessToken)

A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

Parameters:

accessToken - A valid access token that Amazon Cognito issued to the currently signed-in user. Must include a scope claim for aws.cognito.signin.user.admin.

Returns:

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

overrideConfiguration

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

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