aws-cdk-lib.aws_cognito.CfnUserPool.VerificationMessageTemplateProperty

VerificationMessageTemplateProperty Struct

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const verificationMessageTemplateProperty: cognito.CfnUserPool.VerificationMessageTemplateProperty = {
  defaultEmailOption: 'defaultEmailOption',
  emailMessage: 'emailMessage',
  emailMessageByLink: 'emailMessageByLink',
  emailSubject: 'emailSubject',
  emailSubjectByLink: 'emailSubjectByLink',
  smsMessage: 'smsMessage',
};

Properties

defaultEmailOptionstringdefault_email_optionstrdefaultEmailOptionStringDefaultEmailOptionstringDefaultEmailOption*string#

The configuration of verification emails to contain a clickable link or a verification code.

For link, your template body must contain link text in the format {##Click here##} . "Click here" in the example is a customizable string. For code, your template body must contain a code placeholder in the format {####} .

emailMessagestringemail_messagestremailMessageStringEmailMessagestringEmailMessage*string#

The template for email messages that Amazon Cognito sends to your users.

notes

You can set an EmailMessage template only if the value of EmailSendingAccount is DEVELOPER . When your EmailSendingAccount is DEVELOPER , your user pool sends email messages with your own Amazon SES configuration.

emailMessageByLinkstringemail_message_by_linkstremailMessageByLinkStringEmailMessageByLinkstringEmailMessageByLink*string#

The email message template for sending a confirmation link to the user.

notes

You can set an EmailMessageByLink template only if the value of EmailSendingAccount is DEVELOPER . When your EmailSendingAccount is DEVELOPER , your user pool sends email messages with your own Amazon SES configuration.

emailSubjectstringemail_subjectstremailSubjectStringEmailSubjectstringEmailSubject*string#

The subject line for the email message template.

notes

You can set an EmailSubject template only if the value of EmailSendingAccount is DEVELOPER . When your EmailSendingAccount is DEVELOPER , your user pool sends email messages with your own Amazon SES configuration.

emailSubjectByLinkstringemail_subject_by_linkstremailSubjectByLinkStringEmailSubjectByLinkstringEmailSubjectByLink*string#

The subject line for the email message template for sending a confirmation link to the user.

notes

You can set an EmailSubjectByLink template only if the value of EmailSendingAccount is DEVELOPER . When your EmailSendingAccount is DEVELOPER , your user pool sends email messages with your own Amazon SES configuration.

smsMessagestringsms_messagestrsmsMessageStringSmsMessagestringSmsMessage*string#

The template for SMS messages that Amazon Cognito sends to your users.