Package software.amazon.awscdk.services.cognito

Class UserPoolEmailConfig.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.UserPoolEmailConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UserPoolEmailConfig>

Enclosing interface:

UserPoolEmailConfig

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

A builder for UserPoolEmailConfig

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UserPoolEmailConfig	build()	Builds the configured instance.
UserPoolEmailConfig.Builder	configurationSet(String configurationSet)	Sets the value of UserPoolEmailConfig.getConfigurationSet()
UserPoolEmailConfig.Builder	emailSendingAccount(String emailSendingAccount)	Sets the value of UserPoolEmailConfig.getEmailSendingAccount()
UserPoolEmailConfig.Builder	from(String from)	Sets the value of UserPoolEmailConfig.getFrom()
UserPoolEmailConfig.Builder	replyToEmailAddress(String replyToEmailAddress)	Sets the value of UserPoolEmailConfig.getReplyToEmailAddress()
UserPoolEmailConfig.Builder	sourceArn(String sourceArn)	Sets the value of UserPoolEmailConfig.getSourceArn()

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

configurationSet

@Stability(Stable)
public UserPoolEmailConfig.Builder configurationSet(String configurationSet)

Sets the value of UserPoolEmailConfig.getConfigurationSet()

Parameters:

configurationSet - The name of the configuration set in SES.

Returns:

this

emailSendingAccount

@Stability(Stable)
public UserPoolEmailConfig.Builder emailSendingAccount(String emailSendingAccount)

Sets the value of UserPoolEmailConfig.getEmailSendingAccount()

Parameters:

emailSendingAccount - Specifies whether to use Cognito's built in email functionality or SES.

Returns:

this

from

@Stability(Stable)
public UserPoolEmailConfig.Builder from(String from)

Sets the value of UserPoolEmailConfig.getFrom()

Parameters:

from - Identifies either the sender's email address or the sender's name with their email address. If emailSendingAccount is DEVELOPER then this cannot be specified.

Returns:

this

replyToEmailAddress

@Stability(Stable)
public UserPoolEmailConfig.Builder replyToEmailAddress(String replyToEmailAddress)

Sets the value of UserPoolEmailConfig.getReplyToEmailAddress()

Parameters:

replyToEmailAddress - The destination to which the receiver of the email should reply to.

Returns:

this

sourceArn

@Stability(Stable)
public UserPoolEmailConfig.Builder sourceArn(String sourceArn)

Sets the value of UserPoolEmailConfig.getSourceArn()

Parameters:

sourceArn - The ARN of a verified email address in Amazon SES. required if emailSendingAccount is DEVELOPER or if 'from' is provided.

Returns:

this

build

@Stability(Stable)
public UserPoolEmailConfig build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of UserPoolEmailConfig

Throws:

NullPointerException - if any required attribute was not provided