class Aws::CognitoIdentityProvider::Types::SMSMfaSettingsType

The type used for enabling SMS MFA at the user level. Phone numbers don't need to be verified to be used for SMS MFA. If an MFA type is enabled 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. If you would like MFA to be applied selectively based on the assessed risk level of sign in attempts, disable MFA for users and turn on Adaptive Authentication for the user pool.

@note When making an API call, you may pass SMSMfaSettingsType

data as a hash:

    {
      enabled: false,
      preferred_mfa: false,
    }

@!attribute [rw] enabled

Specifies whether SMS text message MFA is enabled. If an MFA type is
enabled 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.
@return [Boolean]

@!attribute [rw] preferred_mfa

Specifies whether SMS is the preferred MFA method.
@return [Boolean]

@see docs.aws.amazon.com/goto/WebAPI/cognito-idp-2016-04-18/SMSMfaSettingsType AWS API Documentation

Constants

SENSITIVE