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

Interface SMSMfaSettingsType.Builder

All Superinterfaces:

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

Enclosing class:

SMSMfaSettingsType

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

Method Summary

Modifier and Type	Method	Description
SMSMfaSettingsType.Builder	enabled(Boolean enabled)	Specifies whether SMS message MFA is activated.
SMSMfaSettingsType.Builder	preferredMfa(Boolean preferredMfa)	Specifies whether SMS is the preferred MFA method.

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

enabled

SMSMfaSettingsType.Builder enabled(Boolean enabled)

Specifies whether SMS message MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.

Parameters:

enabled - Specifies whether SMS message MFA is activated. If an MFA type is activated for a user, the user will be prompted for MFA during all sign-in attempts, unless device tracking is turned on and the device has been trusted.

Returns:

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

preferredMfa

SMSMfaSettingsType.Builder preferredMfa(Boolean preferredMfa)

Specifies whether SMS is the preferred MFA method. If true, your user pool prompts the specified user for a code delivered by SMS message after username-password sign-in succeeds.

Parameters:

preferredMfa - Specifies whether SMS is the preferred MFA method. If true, your user pool prompts the specified user for a code delivered by SMS message after username-password sign-in succeeds.

Returns:

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