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 CfnUserPool.IVerificationMessageTemplateProperty

Syntax (vb)

Public Interface CfnUserPool.IVerificationMessageTemplateProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html

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.

string? DefaultEmailOption { get; }

Property Value

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

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-defaultemailoption

EmailMessage

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

string? EmailMessage { get; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-emailmessage

EmailMessageByLink

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

string? EmailMessageByLink { get; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-emailmessagebylink

EmailSubject

The subject line for the email message template.

string? EmailSubject { get; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-emailsubject

EmailSubjectByLink

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

string? EmailSubjectByLink { get; }

Property Value

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.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-emailsubjectbylink

SmsMessage

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

string? SmsMessage { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-verificationmessagetemplate.html#cfn-cognito-userpool-verificationmessagetemplate-smsmessage