Class CfnUserPoolPropsMixin.VerificationMessageTemplateProperty.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.cognito.CfnUserPoolPropsMixin.VerificationMessageTemplateProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnUserPoolPropsMixin.VerificationMessageTemplateProperty>
- Enclosing interface:
CfnUserPoolPropsMixin.VerificationMessageTemplateProperty
@Stability(Stable)
public static final class CfnUserPoolPropsMixin.VerificationMessageTemplateProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUserPoolPropsMixin.VerificationMessageTemplateProperty>
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()Builds the configured instance.defaultEmailOption(String defaultEmailOption) emailMessage(String emailMessage) emailMessageByLink(String emailMessageByLink) emailSubject(String emailSubject) emailSubjectByLink(String emailSubjectByLink) smsMessage(String smsMessage)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
defaultEmailOption
@Stability(Stable) public CfnUserPoolPropsMixin.VerificationMessageTemplateProperty.Builder defaultEmailOption(String defaultEmailOption) - Parameters:
defaultEmailOption- 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{####}.- Returns:
this
-
emailMessage
@Stability(Stable) public CfnUserPoolPropsMixin.VerificationMessageTemplateProperty.Builder emailMessage(String emailMessage) - Parameters:
emailMessage- The template for email messages that Amazon Cognito sends to your users. You can set anEmailMessagetemplate only if the value of EmailSendingAccount isDEVELOPER. When your EmailSendingAccount isDEVELOPER, your user pool sends email messages with your own Amazon SES configuration.- Returns:
this
-
emailMessageByLink
@Stability(Stable) public CfnUserPoolPropsMixin.VerificationMessageTemplateProperty.Builder emailMessageByLink(String emailMessageByLink) - Parameters:
emailMessageByLink- The email message template for sending a confirmation link to the user. You can set anEmailMessageByLinktemplate only if the value of EmailSendingAccount isDEVELOPER. When your EmailSendingAccount isDEVELOPER, your user pool sends email messages with your own Amazon SES configuration.- Returns:
this
-
emailSubject
@Stability(Stable) public CfnUserPoolPropsMixin.VerificationMessageTemplateProperty.Builder emailSubject(String emailSubject) - Parameters:
emailSubject- The subject line for the email message template. You can set anEmailSubjecttemplate only if the value of EmailSendingAccount isDEVELOPER. When your EmailSendingAccount isDEVELOPER, your user pool sends email messages with your own Amazon SES configuration.- Returns:
this
-
emailSubjectByLink
@Stability(Stable) public CfnUserPoolPropsMixin.VerificationMessageTemplateProperty.Builder emailSubjectByLink(String emailSubjectByLink) - Parameters:
emailSubjectByLink- The subject line for the email message template for sending a confirmation link to the user. You can set anEmailSubjectByLinktemplate only if the value of EmailSendingAccount isDEVELOPER. When your EmailSendingAccount isDEVELOPER, your user pool sends email messages with your own Amazon SES configuration.- Returns:
this
-
smsMessage
@Stability(Stable) public CfnUserPoolPropsMixin.VerificationMessageTemplateProperty.Builder smsMessage(String smsMessage) - Parameters:
smsMessage- The template for SMS messages that Amazon Cognito sends to your users.- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnUserPoolPropsMixin.VerificationMessageTemplateProperty>- Returns:
- a new instance of
CfnUserPoolPropsMixin.VerificationMessageTemplateProperty - Throws:
NullPointerException- if any required attribute was not provided
-