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

Inherits:

Struct

Object
Struct
Aws::CognitoIdentityProvider::Types::MFAOptionType

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. Applies only to SMS multi-factor authentication (MFA) configurations. Does not apply to time-based one-time password (TOTP) software token MFA configurations.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#attribute_name ⇒ String
The attribute name of the MFA option type.
#delivery_medium ⇒ String
The delivery medium to send the MFA code.

Instance Attribute Details

#attribute_name ⇒ `String`

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

Returns:

(String)

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

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

#delivery_medium ⇒ `String`

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