Package software.amazon.awscdk.services.cognito

Interface CfnUserPool.VerificationMessageTemplateProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPool.VerificationMessageTemplateProperty.Jsii$Proxy

Enclosing class:

CfnUserPool

@Stability(Stable)
public static interface CfnUserPool.VerificationMessageTemplateProperty
extends software.amazon.jsii.JsiiSerializable

The template for the verification message that your user pool delivers to users who set an email address or phone number attribute.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cognito.*;
 VerificationMessageTemplateProperty verificationMessageTemplateProperty = VerificationMessageTemplateProperty.builder()
         .defaultEmailOption("defaultEmailOption")
         .emailMessage("emailMessage")
         .emailMessageByLink("emailMessageByLink")
         .emailSubject("emailSubject")
         .emailSubjectByLink("emailSubjectByLink")
         .smsMessage("smsMessage")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserPool.VerificationMessageTemplateProperty.Builder	A builder for CfnUserPool.VerificationMessageTemplateProperty
static final class	CfnUserPool.VerificationMessageTemplateProperty.Jsii$Proxy	An implementation for CfnUserPool.VerificationMessageTemplateProperty

Method Summary

Modifier and Type	Method	Description
static CfnUserPool.VerificationMessageTemplateProperty.Builder	builder()
default String	getDefaultEmailOption()	The configuration of verification emails to contain a clickable link or a verification code.
default String	getEmailMessage()	The template for email messages that Amazon Cognito sends to your users.
default String	getEmailMessageByLink()	The email message template for sending a confirmation link to the user.
default String	getEmailSubject()	The subject line for the email message template.
default String	getEmailSubjectByLink()	The subject line for the email message template for sending a confirmation link to the user.
default String	getSmsMessage()	The template for SMS messages that Amazon Cognito sends to your users.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDefaultEmailOption

@Stability(Stable)
@Nullable
default String getDefaultEmailOption()

The configuration of verification emails to contain a clickable link or a verification code.

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 Also:

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

getEmailMessage

@Stability(Stable)
@Nullable
default String getEmailMessage()

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.

See Also:

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

getEmailMessageByLink

@Stability(Stable)
@Nullable
default String getEmailMessageByLink()

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.

See Also:

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

getEmailSubject

@Stability(Stable)
@Nullable
default String getEmailSubject()

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.

See Also:

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

getEmailSubjectByLink

@Stability(Stable)
@Nullable
default String getEmailSubjectByLink()

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.

See Also:

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

getSmsMessage

@Stability(Stable)
@Nullable
default String getSmsMessage()

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

See Also:

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

builder

@Stability(Stable)
static CfnUserPool.VerificationMessageTemplateProperty.Builder builder()

Returns:

a CfnUserPool.VerificationMessageTemplateProperty.Builder of CfnUserPool.VerificationMessageTemplateProperty