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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass SMSMfaSettingsType data as a hash:

{
  enabled: false,
  preferred_mfa: false,
}

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

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.

Returns:

  • (Boolean)


7761
7762
7763
7764
7765
7766
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7761

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

#preferred_mfaBoolean

Specifies whether SMS is the preferred MFA method.

Returns:

  • (Boolean)


7761
7762
7763
7764
7765
7766
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7761

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