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

Inherits:

Struct

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

show all

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

Overview

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#sms_authentication_message ⇒ String
The SMS authentication message that will be sent to users with the code they must sign in.
#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 authentication message that will be sent to users with the code they must sign in. The message must contain the ‘{####\}’ placeholder, which is replaced with the code. If the message isn't included, and default message will be used.

Returns:

(String)

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

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.