EmailMfaConfigType
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.
Contents
- Message
-
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.Type: String
Length Constraints: Minimum length of 6. Maximum length of 20000.
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*\{####\}[\p{L}\p{M}\p{S}\p{N}\p{P}\s*]*Required: No
- Subject
-
The subject of the email message that your user pool sends to users with an MFA code.
Type: String
Pattern:
[\p{L}\p{M}\p{S}\p{N}\p{P}\s]+Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
