You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::MFAOptionType

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 MFAOptionType data as a hash:

{
  delivery_medium: "SMS", # accepts SMS, EMAIL
  attribute_name: "AttributeNameType",
}

This data type is no longer supported. You can use it only for SMS MFA configurations. You can't use it for TOTP software token MFA configurations.

To set either type of MFA configuration, use the AdminSetUserMFAPreference or SetUserMFAPreference actions.

To look up information about either type of MFA configuration, use the AdminGetUserResponse$UserMFASettingList or GetUserResponse$UserMFASettingList responses.

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_nameString

The attribute name of the MFA option type. The only valid value is phone_number.

Returns:

  • (String)


6416
6417
6418
6419
6420
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6416

class MFAOptionType < Struct.new(
  :delivery_medium,
  :attribute_name)
  include Aws::Structure
end

#delivery_mediumString

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

Returns:

  • (String)


6416
6417
6418
6419
6420
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 6416

class MFAOptionType < Struct.new(
  :delivery_medium,
  :attribute_name)
  include Aws::Structure
end