Class: Aws::CognitoIdentityProvider::Types::EmailMfaConfigType

Inherits:

Struct

Object
Struct
Aws::CognitoIdentityProvider::Types::EmailMfaConfigType

show all

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

Overview

Sets or shows configuration for user pool email message MFA and sign-in with one-time passwords (OTPs). Includes the subject and body of the email message template for sign-in and MFA messages. To activate this setting, your user pool must be in the Essentials tier or higher.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#message ⇒ String
The template for the email messages that your user pool sends to users with codes for MFA and sign-in with email OTPs.
#subject ⇒ String
The subject of the email messages that your user pool sends to users with codes for MFA and email OTP sign-in.

Instance Attribute Details

#message ⇒ `String`

The template for the email messages that your user pool sends to users with codes for MFA and sign-in with email OTPs. 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 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5616

class EmailMfaConfigType < Struct.new(
  :message,
  :subject)
  SENSITIVE = []
  include Aws::Structure
end

#subject ⇒ `String`

The subject of the email messages that your user pool sends to users with codes for MFA and email OTP sign-in.