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

Inherits:

Struct

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

Includes:

Structure

Defined in:

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.

[1]: docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #message ⇒ String

  The template for the email message that your user pool sends to users with an MFA code.

• #subject ⇒ String

  The subject of the email message that your user pool sends to users with an MFA code.

Instance Attribute Details

#message ⇒ String

The template for the email 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 4561

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 an MFA code.

Returns:

• (String)

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

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