Class CfnUserPool.VerificationMessageTemplateProperty
The template for verification messages.
Inheritance
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public class VerificationMessageTemplateProperty : Object, CfnUserPool.IVerificationMessageTemplateProperty
Syntax (vb)
Public Class VerificationMessageTemplateProperty
Inherits Object
Implements CfnUserPool.IVerificationMessageTemplateProperty
Remarks
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
Constructors
VerificationMessageTemplateProperty() |
Properties
DefaultEmailOption | The default email option. |
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. |
Constructors
VerificationMessageTemplateProperty()
public VerificationMessageTemplateProperty()
Properties
DefaultEmailOption
The default email option.
public string DefaultEmailOption { get; set; }
Property Value
System.String
Remarks
EmailMessage
The template for email messages that Amazon Cognito sends to your users.
public string EmailMessage { get; set; }
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.
public string EmailMessageByLink { get; set; }
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.
public string EmailSubject { get; set; }
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.
public string EmailSubjectByLink { get; set; }
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.
public string SmsMessage { get; set; }
Property Value
System.String