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(value=Stable)
public static interface CfnUserPool.VerificationMessageTemplateProperty
extends software.amazon.jsii.JsiiSerializable

The template for verification messages.

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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnUserPool.VerificationMessageTemplateProperty.Builder	builder()
default String	getDefaultEmailOption() The default email option.
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 Detail

getDefaultEmailOption

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

The default email option.

getEmailMessage

@Stability(value=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.

getEmailMessageByLink

@Stability(value=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.

getEmailSubject

@Stability(value=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.

getEmailSubjectByLink

@Stability(value=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.

getSmsMessage

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

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

builder

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

Returns:

a CfnUserPool.VerificationMessageTemplateProperty.Builder of CfnUserPool.VerificationMessageTemplateProperty