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

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

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

Overview

Note:

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#sms_authentication_message ⇒ String

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) —

    The SMS authentication message that will be sent to users with the code they need to sign in.

#sms_configuration ⇒ Types::SmsConfigurationType

The SMS configuration.

Returns: