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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#enabledBoolean

Specifies whether SMS text message MFA is enabled.

Returns:

  • (Boolean)


7522
7523
7524
7525
7526
7527
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7522

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

#preferred_mfaBoolean

Specifies whether SMS is the preferred MFA method.

Returns:

  • (Boolean)


7522
7523
7524
7525
7526
7527
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7522

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