Interface UserPoolSESOptions
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
UserPoolSESOptions.Jsii$Proxy
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-25T14:21:12.576Z")
@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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forUserPoolSESOptions
static final class
An implementation forUserPoolSESOptions
-
Method Summary
Modifier and TypeMethodDescriptionstatic UserPoolSESOptions.Builder
builder()
default String
The name of a configuration set in Amazon SES that should be applied to emails sent via Cognito.The verified Amazon SES email address that Cognito should use to send emails.default String
An optional name that should be used as the sender's name along with the email.default String
The destination to which the receiver of the email should reply to.default String
Required if the UserPool region is different than the SES region.default String
SES Verified custom domain to be used to verify the identity.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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:
-
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:
-
getFromName
An optional name that should be used as the sender's name along with the email.Default: - no name
-
getReplyTo
The destination to which the receiver of the email should reply to.Default: - same as the fromEmail
-
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
SES Verified custom domain to be used to verify the identity.Default: - no domain
-
builder
- Returns:
- a
UserPoolSESOptions.Builder
ofUserPoolSESOptions
-