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

The configuration of multi-factor authentication (MFA) with SMS messages in a user pool.

This data type is a request parameter of [SetUserPoolMfaConfig] and a response parameter of [GetUserPoolMfaConfig].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_GetUserPoolMfaConfig.html

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 with.
#sms_configuration ⇒ Types::SmsConfigurationType

User pool configuration for delivery of SMS messages with 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 with. The message must contain the ‘####` placeholder. Your user pool replaces the placeholder with the MFA code. If this parameter isn’t provided, your user pool sends a default message.

Returns:

(String)

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

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

#sms_configuration ⇒ `Types::SmsConfigurationType`

User pool configuration for delivery of SMS messages with Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account.

You can set ‘SmsConfiguration` in `CreateUserPool` and ` UpdateUserPool`, or in `SetUserPoolMfaConfig`.