Class CfnUserPool.VerificationMessageTemplateProperty

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

The template for verification messages.

public class CfnUserPool.VerificationMessageTemplateProperty : CfnUserPool.IVerificationMessageTemplateProperty

Inheritance

object

CfnUserPool.VerificationMessageTemplateProperty

Implements

CfnUserPool.IVerificationMessageTemplateProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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"
             };

Remarks

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

ExampleMetadata: fixture=_generated

Constructors

VerificationMessageTemplateProperty()

public VerificationMessageTemplateProperty()

Properties

DefaultEmailOption

The default email option.

public string? DefaultEmailOption { get; set; }

Property Value

string

Remarks

Link: 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.

public string? EmailMessage { get; set; }

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.

Link: 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.

public string? EmailMessageByLink { get; set; }

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.

Link: 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.

public string? EmailSubject { get; set; }

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.

Link: 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.

public string? EmailSubjectByLink { get; set; }

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.

Link: 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.

public string? SmsMessage { get; set; }

Property Value

string

Remarks

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