Interface CfnUserPool.IVerificationMessageTemplateProperty
The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface IVerificationMessageTemplateProperty
Syntax (vb)
Public Interface IVerificationMessageTemplateProperty
Remarks
This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Cognito;
var verificationMessageTemplateProperty = new VerificationMessageTemplateProperty {
DefaultEmailOption = "defaultEmailOption",
EmailMessage = "emailMessage",
EmailMessageByLink = "emailMessageByLink",
EmailSubject = "emailSubject",
EmailSubjectByLink = "emailSubjectByLink",
SmsMessage = "smsMessage"
};
Synopsis
Properties
DefaultEmailOption | The configuration of verification emails to contain a clickable link or a verification code. |
EmailMessage | The template for email messages that Amazon Cognito sends to your users. |
EmailMessageByLink | The email message template for sending a confirmation link to the user. |
EmailSubject | The subject line for the email message template. |
EmailSubjectByLink | The subject line for the email message template for sending a confirmation link to the user. |
SmsMessage | The template for SMS messages that Amazon Cognito sends to your users. |
Properties
DefaultEmailOption
The configuration of verification emails to contain a clickable link or a verification code.
virtual string DefaultEmailOption { get; }
Property Value
System.String
Remarks
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
The template for email messages that Amazon Cognito sends to your users.
virtual string EmailMessage { get; }
Property Value
System.String
Remarks
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
The email message template for sending a confirmation link to the user.
virtual string EmailMessageByLink { get; }
Property Value
System.String
Remarks
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
The subject line for the email message template.
virtual string EmailSubject { get; }
Property Value
System.String
Remarks
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
The subject line for the email message template for sending a confirmation link to the user.
virtual string EmailSubjectByLink { get; }
Property Value
System.String
Remarks
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
The template for SMS messages that Amazon Cognito sends to your users.
virtual string SmsMessage { get; }
Property Value
System.String