UserPoolSESOptions Struct
Configuration for Cognito sending emails via Amazon SES.
Example
ts
new cognito.UserPool(this, 'myuserpool', {
email: cognito.UserPoolEmail.withSES({
fromEmail: 'noreply@myawesomeapp.com',
fromName: 'Awesome App',
replyTo: 'support@myawesomeapp.com',
}),
});
Properties
configurationSetNameoptionalstringconfiguration_set_nameoptionalstrconfigurationSetNameoptionalStringConfigurationSetNameoptionalstringConfigurationSetNameoptional*string#The name of a configuration set in Amazon SES that should be applied to emails sent via Cognito.
Default: no configuration set
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.
fromNameoptionalstringfrom_nameoptionalstrfromNameoptionalStringFromNameoptionalstringFromNameoptional*string#An optional name that should be used as the sender's name along with the email.
Default: no name
replyTooptionalstringreply_tooptionalstrreplyTooptionalStringReplyTooptionalstringReplyTooptional*string#The destination to which the receiver of the email should reply to.
Default: same as the fromEmail
sesRegionoptionalstringses_regionoptionalstrsesRegionoptionalStringSesRegionoptionalstringSesRegionoptional*string#Required if the UserPool region is different than the SES region.
Default: The same region as the Cognito UserPool
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.
sesVerifiedDomainoptionalstringses_verified_domainoptionalstrsesVerifiedDomainoptionalStringSesVerifiedDomainoptionalstringSesVerifiedDomainoptional*string#SES Verified custom domain to be used to verify the identity.
Default: no domain