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

Inherits:

Struct

Object
Struct
Aws::CognitoIdentityProvider::Types::SmsMfaConfigType

show all

Includes:: Structure

Defined in:: lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Configures user pool SMS messages for multi-factor authentication (MFA). Sets the message template and the SMS message sending configuration for Amazon SNS.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#sms_authentication_message ⇒ String

The SMS message that your user pool sends to users with an MFA code.
#sms_configuration ⇒ Types::SmsConfigurationType

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service.

Instance Attribute Details

#sms_authentication_message ⇒ `String`

The SMS message that your user pool sends to users with an MFA code. The message must contain the ‘####` placeholder. In the message, Amazon Cognito replaces this placeholder with the code. If you don’t provide this parameter, Amazon Cognito sends messages in the default format.

Returns:

(String)

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

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

#sms_configuration ⇒ `Types::SmsConfigurationType`

The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To request Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role that you provide for your Amazon Web Services account.