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 user pool email message configuration for MFA. Includes the subject and body of the email message template for MFA messages. To activate this setting, advanced security features must be active in your user pool.

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

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

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

Instance Attribute Details

#message ⇒ `String`

The template for the email message that your user pool sends to users with a code for MFA and sign-in with an email OTP. 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 5745

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

#subject ⇒ `String`

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