software.amazon.awscdk.services.cognito

Class UserVerificationConfig.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.UserVerificationConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UserVerificationConfig>

Enclosing interface:

UserVerificationConfig

@Stability(value=Stable)
public static final class UserVerificationConfig.Builder
extends Object
implements software.amazon.jsii.Builder<UserVerificationConfig>

A builder for UserVerificationConfig

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
UserVerificationConfig	build() Builds the configured instance.
UserVerificationConfig.Builder	emailBody(String emailBody) Sets the value of UserVerificationConfig.getEmailBody()
UserVerificationConfig.Builder	emailStyle(VerificationEmailStyle emailStyle) Sets the value of UserVerificationConfig.getEmailStyle()
UserVerificationConfig.Builder	emailSubject(String emailSubject) Sets the value of UserVerificationConfig.getEmailSubject()
UserVerificationConfig.Builder	smsMessage(String smsMessage) Sets the value of UserVerificationConfig.getSmsMessage()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

emailBody

@Stability(value=Stable)
public UserVerificationConfig.Builder emailBody(String emailBody)

Sets the value of UserVerificationConfig.getEmailBody()

Parameters:

emailBody - The email body template for the verification email sent to the user upon sign up. See https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-templates.html to learn more about message templates.

Returns:

this

emailStyle

@Stability(value=Stable)
public UserVerificationConfig.Builder emailStyle(VerificationEmailStyle emailStyle)

Sets the value of UserVerificationConfig.getEmailStyle()

Parameters:

emailStyle - Emails can be verified either using a code or a link. Learn more at https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-email-verification-message-customization.html

Returns:

this

emailSubject

@Stability(value=Stable)
public UserVerificationConfig.Builder emailSubject(String emailSubject)

Sets the value of UserVerificationConfig.getEmailSubject()

Parameters:

emailSubject - The email subject template for the verification email sent to the user upon sign up. See https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-templates.html to learn more about message templates.

Returns:

this

smsMessage

@Stability(value=Stable)
public UserVerificationConfig.Builder smsMessage(String smsMessage)

Sets the value of UserVerificationConfig.getSmsMessage()

Parameters:

smsMessage - The message template for the verification SMS sent to the user upon sign up. See https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-templates.html to learn more about message templates.

Returns:

this

build

@Stability(value=Stable)
public UserVerificationConfig build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<UserVerificationConfig>

Returns:

a new instance of UserVerificationConfig

Throws:

NullPointerException - if any required attribute was not provided