Package software.amazon.awscdk.services.cognito

Class UserPoolSESOptions.Builder

java.lang.Object

software.amazon.awscdk.services.cognito.UserPoolSESOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<UserPoolSESOptions>

Enclosing interface:

UserPoolSESOptions

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

A builder for UserPoolSESOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
UserPoolSESOptions	build()	Builds the configured instance.
UserPoolSESOptions.Builder	configurationSetName(String configurationSetName)	Sets the value of UserPoolSESOptions.getConfigurationSetName()
UserPoolSESOptions.Builder	fromEmail(String fromEmail)	Sets the value of UserPoolSESOptions.getFromEmail()
UserPoolSESOptions.Builder	fromName(String fromName)	Sets the value of UserPoolSESOptions.getFromName()
UserPoolSESOptions.Builder	replyTo(String replyTo)	Sets the value of UserPoolSESOptions.getReplyTo()
UserPoolSESOptions.Builder	sesRegion(String sesRegion)	Sets the value of UserPoolSESOptions.getSesRegion()
UserPoolSESOptions.Builder	sesVerifiedDomain(String sesVerifiedDomain)	Sets the value of UserPoolSESOptions.getSesVerifiedDomain()

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

fromEmail

@Stability(Stable)
public UserPoolSESOptions.Builder fromEmail(String fromEmail)

Sets the value of UserPoolSESOptions.getFromEmail()

Parameters:

fromEmail - The verified Amazon SES email address that Cognito should use to send emails. This parameter is required. The email address used must be a verified email address in Amazon SES and must be configured to allow Cognito to send emails.

Returns:

this

configurationSetName

@Stability(Stable)
public UserPoolSESOptions.Builder configurationSetName(String configurationSetName)

Sets the value of UserPoolSESOptions.getConfigurationSetName()

Parameters:

configurationSetName - The name of a configuration set in Amazon SES that should be applied to emails sent via Cognito.

Returns:

this

fromName

@Stability(Stable)
public UserPoolSESOptions.Builder fromName(String fromName)

Sets the value of UserPoolSESOptions.getFromName()

Parameters:

fromName - An optional name that should be used as the sender's name along with the email.

Returns:

this

replyTo

@Stability(Stable)
public UserPoolSESOptions.Builder replyTo(String replyTo)

Sets the value of UserPoolSESOptions.getReplyTo()

Parameters:

replyTo - The destination to which the receiver of the email should reploy to.

Returns:

this

sesRegion

@Stability(Stable)
public UserPoolSESOptions.Builder sesRegion(String sesRegion)

Sets the value of UserPoolSESOptions.getSesRegion()

Parameters:

sesRegion - Required if the UserPool region is different than the SES region. If sending emails with a Amazon SES verified email address, and the region that SES is configured is different than the region in which the UserPool is deployed, you must specify that region here.

Must be 'us-east-1', 'us-west-2', or 'eu-west-1'

Returns:

this

sesVerifiedDomain

@Stability(Stable)
public UserPoolSESOptions.Builder sesVerifiedDomain(String sesVerifiedDomain)

Sets the value of UserPoolSESOptions.getSesVerifiedDomain()

Parameters:

sesVerifiedDomain - SES Verified custom domain to be used to verify the identity.

Returns:

this

build

@Stability(Stable)
public UserPoolSESOptions build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of UserPoolSESOptions

Throws:

NullPointerException - if any required attribute was not provided