interface VerificationMessageTemplateProperty

Language	Type name
.NET	Amazon.CDK.AWS.Cognito.CfnUserPool.VerificationMessageTemplateProperty
Java	software.amazon.awscdk.services.cognito.CfnUserPool.VerificationMessageTemplateProperty
Python	aws_cdk.aws_cognito.CfnUserPool.VerificationMessageTemplateProperty
TypeScript	@aws-cdk/aws-cognito » CfnUserPool » VerificationMessageTemplateProperty

The template for verification messages.

Example

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

Properties

Name	Type	Description
defaultEmailOption?	string	The default email option.
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 default email option.

---

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.