software.amazon.awscdk.services.cognito

Class UserInvitationConfig.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.UserInvitationConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UserInvitationConfig>

Enclosing interface:

UserInvitationConfig

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

A builder for UserInvitationConfig

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
UserInvitationConfig	build() Builds the configured instance.
UserInvitationConfig.Builder	emailBody(String emailBody) Sets the value of UserInvitationConfig.getEmailBody()
UserInvitationConfig.Builder	emailSubject(String emailSubject) Sets the value of UserInvitationConfig.getEmailSubject()
UserInvitationConfig.Builder	smsMessage(String smsMessage) Sets the value of UserInvitationConfig.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 UserInvitationConfig.Builder emailBody(String emailBody)

Sets the value of UserInvitationConfig.getEmailBody()

Parameters:

emailBody - The template to the email body that is sent to the user when an administrator signs them up to the user pool.

Returns:

this

emailSubject

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

Sets the value of UserInvitationConfig.getEmailSubject()

Parameters:

emailSubject - The template to the email subject that is sent to the user when an administrator signs them up to the user pool.

Returns:

this

smsMessage

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

Sets the value of UserInvitationConfig.getSmsMessage()

Parameters:

smsMessage - The template to the SMS message that is sent to the user when an administrator signs them up to the user pool.

Returns:

this

build

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of UserInvitationConfig

Throws:

NullPointerException - if any required attribute was not provided