Class: Aws::CognitoIdentityProvider::Types::SMSMfaSettingsType

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::SMSMfaSettingsType

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #enabled ⇒ Boolean

  Specifies whether SMS message MFA is activated.

• #preferred_mfa ⇒ Boolean

  Specifies whether SMS is the preferred MFA method.

Instance Attribute Details

#enabled ⇒ Boolean

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:

• (Boolean)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7675

class SMSMfaSettingsType < Struct.new(
  :enabled,
  :preferred_mfa)
  SENSITIVE = []
  include Aws::Structure
end

#preferred_mfa ⇒ Boolean

Specifies whether SMS is the preferred MFA method.

Returns:

• (Boolean)

# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 7675

class SMSMfaSettingsType < Struct.new(
  :enabled,
  :preferred_mfa)
  SENSITIVE = []
  include Aws::Structure
end