interface VerificationMessageTemplateProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Cognito.CfnUserPool.VerificationMessageTemplateProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscognito#CfnUserPool_VerificationMessageTemplateProperty`
Java	`software.amazon.awscdk.services.cognito.CfnUserPool.VerificationMessageTemplateProperty`
Python	`aws_cdk.aws_cognito.CfnUserPool.VerificationMessageTemplateProperty`
TypeScript	`aws-cdk-lib` » `aws_cognito` » `CfnUserPool` » `VerificationMessageTemplateProperty`

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

This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .

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

Name	Type	Description
defaultEmailOption?	`string`	The configuration of verification emails to contain a clickable link or a verification code.
emailMessage?	`string`	The template for email messages that Amazon Cognito sends to your users.
emailMessageByLink?	`string`	The email message template for sending a confirmation link to the user.
emailSubject?	`string`	The subject line for the email message template.
emailSubjectByLink?	`string`	The subject line for the email message template for sending a confirmation link to the user.
smsMessage?	`string`	The template for SMS messages that Amazon Cognito sends to your users.

defaultEmailOption?

Type: string (optional)

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 {####} .

emailMessage?

Type: string (optional)

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

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.

emailMessageByLink?

Type: string (optional)

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

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.

emailSubject?

Type: string (optional)

The subject line for the email message template.

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.

emailSubjectByLink?

Type: string (optional)

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

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.

smsMessage?

Type: string (optional)

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