Package software.amazon.awscdk.services.cognito

Class CfnUserPool.VerificationMessageTemplateProperty.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.CfnUserPool.VerificationMessageTemplateProperty.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnUserPool.VerificationMessageTemplateProperty>

Enclosing interface:

CfnUserPool.VerificationMessageTemplateProperty

@Stability(Stable)
public static final class CfnUserPool.VerificationMessageTemplateProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUserPool.VerificationMessageTemplateProperty>

A builder for CfnUserPool.VerificationMessageTemplateProperty

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnUserPool.VerificationMessageTemplateProperty	build()	Builds the configured instance.
CfnUserPool.VerificationMessageTemplateProperty.Builder	defaultEmailOption(String defaultEmailOption)	Sets the value of CfnUserPool.VerificationMessageTemplateProperty.getDefaultEmailOption()
CfnUserPool.VerificationMessageTemplateProperty.Builder	emailMessage(String emailMessage)	Sets the value of CfnUserPool.VerificationMessageTemplateProperty.getEmailMessage()
CfnUserPool.VerificationMessageTemplateProperty.Builder	emailMessageByLink(String emailMessageByLink)	Sets the value of CfnUserPool.VerificationMessageTemplateProperty.getEmailMessageByLink()
CfnUserPool.VerificationMessageTemplateProperty.Builder	emailSubject(String emailSubject)	Sets the value of CfnUserPool.VerificationMessageTemplateProperty.getEmailSubject()
CfnUserPool.VerificationMessageTemplateProperty.Builder	emailSubjectByLink(String emailSubjectByLink)	Sets the value of CfnUserPool.VerificationMessageTemplateProperty.getEmailSubjectByLink()
CfnUserPool.VerificationMessageTemplateProperty.Builder	smsMessage(String smsMessage)	Sets the value of CfnUserPool.VerificationMessageTemplateProperty.getSmsMessage()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

defaultEmailOption

@Stability(Stable)
public CfnUserPool.VerificationMessageTemplateProperty.Builder defaultEmailOption(String defaultEmailOption)

Sets the value of CfnUserPool.VerificationMessageTemplateProperty.getDefaultEmailOption()

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 CfnUserPool.VerificationMessageTemplateProperty.Builder emailMessage(String emailMessage)

Sets the value of CfnUserPool.VerificationMessageTemplateProperty.getEmailMessage()

Parameters:

emailMessage - 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.

Returns:

this

emailMessageByLink

@Stability(Stable)
public CfnUserPool.VerificationMessageTemplateProperty.Builder emailMessageByLink(String emailMessageByLink)

Sets the value of CfnUserPool.VerificationMessageTemplateProperty.getEmailMessageByLink()

Parameters:

emailMessageByLink - 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.

Returns:

this

emailSubject

@Stability(Stable)
public CfnUserPool.VerificationMessageTemplateProperty.Builder emailSubject(String emailSubject)

Sets the value of CfnUserPool.VerificationMessageTemplateProperty.getEmailSubject()

Parameters:

emailSubject - 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.

Returns:

this

emailSubjectByLink

@Stability(Stable)
public CfnUserPool.VerificationMessageTemplateProperty.Builder emailSubjectByLink(String emailSubjectByLink)

Sets the value of CfnUserPool.VerificationMessageTemplateProperty.getEmailSubjectByLink()

Parameters:

emailSubjectByLink - 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.

Returns:

this

smsMessage

@Stability(Stable)
public CfnUserPool.VerificationMessageTemplateProperty.Builder smsMessage(String smsMessage)

Sets the value of CfnUserPool.VerificationMessageTemplateProperty.getSmsMessage()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnUserPool.VerificationMessageTemplateProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnUserPool.VerificationMessageTemplateProperty>

Returns:

a new instance of CfnUserPool.VerificationMessageTemplateProperty

Throws:

NullPointerException - if any required attribute was not provided