Package software.amazon.awscdk.services.cognito

Interface UserPoolSESOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

UserPoolSESOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-21T06:34:05.653Z")
@Stability(Stable)
public interface UserPoolSESOptions
extends software.amazon.jsii.JsiiSerializable

Configuration for Cognito sending emails via Amazon SES.

Example:

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

Nested Class Summary

Nested Classes

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

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFromEmail

@Stability(Stable)
@NotNull
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

@Stability(Stable)
@Nullable
default 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

@Stability(Stable)
@Nullable
default String getFromName()

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

Default: - no name

getReplyTo

@Stability(Stable)
@Nullable
default String getReplyTo()

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

Default: - same as the fromEmail

getSesRegion

@Stability(Stable)
@Nullable
default 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.

Default: - The same region as the Cognito UserPool

getSesVerifiedDomain

@Stability(Stable)
@Nullable
default String getSesVerifiedDomain()

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

Default: - no domain

builder

@Stability(Stable)
static UserPoolSESOptions.Builder builder()

Returns:

a UserPoolSESOptions.Builder of UserPoolSESOptions