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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing MFAOptionType as input to an Aws::Client method, you can use a vanilla 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.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#attribute_name ⇒ String

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

Returns:

  • (String) —

    The attribute name of the MFA option type.

#delivery_medium ⇒ String

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

Possible values:

  • SMS
  • EMAIL

Returns:

  • (String) —

    The delivery medium to send the MFA code.