software.amazon.awscdk.services.cognito

Interface UserPoolSESOptions

All Known Implementing Classes:

UserPoolSESOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.920Z")
public interface UserPoolSESOptions

Configuration for Cognito sending emails via Amazon SES.

Example:

 UserPool.Builder.create(this, "myuserpool")
         .email(UserPoolEmail.withSES(UserPoolSESOptions.builder()
                 .sesRegion("us-east-1")
                 .fromEmail("noreply@myawesomeapp.com")
                 .fromName("Awesome App")
                 .replyTo("support@myawesomeapp.com")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UserPoolSESOptions.Builder A builder for UserPoolSESOptions
static class	UserPoolSESOptions.Jsii$Proxy An implementation for UserPoolSESOptions

Method Summary

Modifier and Type	Method and Description
static UserPoolSESOptions.Builder	builder()
default java.lang.String	getConfigurationSetName() The name of a configuration set in Amazon SES that should be applied to emails sent via Cognito.
java.lang.String	getFromEmail() The verified Amazon SES email address that Cognito should use to send emails.
default java.lang.String	getFromName() An optional name that should be used as the sender's name along with the email.
default java.lang.String	getReplyTo() The destination to which the receiver of the email should reploy to.
default java.lang.String	getSesRegion() Required if the UserPool region is different than the SES region.
default java.lang.String	getSesVerifiedDomain() SES Verified custom domain to be used to verify the identity.

Method Detail

getFromEmail

java.lang.String getFromEmail()

The verified Amazon SES email address that Cognito should use to send emails.

The email address used must be a verified email address in Amazon SES and must be configured to allow Cognito to send emails.

See Also:

https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html

getConfigurationSetName

default java.lang.String getConfigurationSetName()

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

Default: - no configuration set

See Also:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-emailconfiguration.html#cfn-cognito-userpool-emailconfiguration-configurationset

getFromName

default java.lang.String getFromName()

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

Default: - no name

getReplyTo

default java.lang.String getReplyTo()

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

Default: - same as the fromEmail

getSesRegion

default java.lang.String getSesRegion()

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'

Default: - The same region as the Cognito UserPool

getSesVerifiedDomain

default java.lang.String getSesVerifiedDomain()

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

Default: - no domain

builder

static UserPoolSESOptions.Builder builder()

Returns:

a UserPoolSESOptions.Builder of UserPoolSESOptions