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

Class: Aws::CognitoIdentityProvider::Types::SmsMfaConfigType

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

{
  sms_authentication_message: "SmsVerificationMessageType",
  sms_configuration: {
    sns_caller_arn: "ArnType", # required
    external_id: "StringType",
  },
}

The SMS text message multi-factor authentication (MFA) configuration type.

Instance Attribute Summary collapse

Instance Attribute Details

#sms_authentication_messageString

The SMS authentication message that will be sent to users with the code they need to sign in. The message must contain the ‘{####\}’ placeholder, which will be replaced with the code. If the message is not included, and default message will be used.

Returns:

  • (String)


7653
7654
7655
7656
7657
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7653

class SmsMfaConfigType < Struct.new(
  :sms_authentication_message,
  :sms_configuration)
  include Aws::Structure
end

#sms_configurationTypes::SmsConfigurationType

The SMS configuration.



7653
7654
7655
7656
7657
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7653

class SmsMfaConfigType < Struct.new(
  :sms_authentication_message,
  :sms_configuration)
  include Aws::Structure
end