public static final class UserPoolSESOptions.Builder
extends java.lang.Object
UserPoolSESOptions
Constructor and Description |
---|
Builder() |
Modifier and Type | Method and Description |
---|---|
UserPoolSESOptions |
build()
Builds the configured instance.
|
UserPoolSESOptions.Builder |
configurationSetName(java.lang.String configurationSetName)
Sets the value of
UserPoolSESOptions.getConfigurationSetName() |
UserPoolSESOptions.Builder |
fromEmail(java.lang.String fromEmail)
Sets the value of
UserPoolSESOptions.getFromEmail() |
UserPoolSESOptions.Builder |
fromName(java.lang.String fromName)
Sets the value of
UserPoolSESOptions.getFromName() |
UserPoolSESOptions.Builder |
replyTo(java.lang.String replyTo)
Sets the value of
UserPoolSESOptions.getReplyTo() |
UserPoolSESOptions.Builder |
sesRegion(java.lang.String sesRegion)
Sets the value of
UserPoolSESOptions.getSesRegion() |
UserPoolSESOptions.Builder |
sesVerifiedDomain(java.lang.String sesVerifiedDomain)
Sets the value of
UserPoolSESOptions.getSesVerifiedDomain() |
public UserPoolSESOptions.Builder fromEmail(java.lang.String fromEmail)
UserPoolSESOptions.getFromEmail()
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.this
public UserPoolSESOptions.Builder configurationSetName(java.lang.String configurationSetName)
UserPoolSESOptions.getConfigurationSetName()
configurationSetName
- The name of a configuration set in Amazon SES that should be applied to emails sent via Cognito.this
public UserPoolSESOptions.Builder fromName(java.lang.String fromName)
UserPoolSESOptions.getFromName()
fromName
- An optional name that should be used as the sender's name along with the email.this
public UserPoolSESOptions.Builder replyTo(java.lang.String replyTo)
UserPoolSESOptions.getReplyTo()
replyTo
- The destination to which the receiver of the email should reploy to.this
public UserPoolSESOptions.Builder sesRegion(java.lang.String sesRegion)
UserPoolSESOptions.getSesRegion()
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'
this
public UserPoolSESOptions.Builder sesVerifiedDomain(java.lang.String sesVerifiedDomain)
UserPoolSESOptions.getSesVerifiedDomain()
sesVerifiedDomain
- SES Verified custom domain to be used to verify the identity.this
public UserPoolSESOptions build()
UserPoolSESOptions
java.lang.NullPointerException
- if any required attribute was not provided