interface UserPoolSESOptions

Language	Type name
.NET	Amazon.CDK.AWS.Cognito.UserPoolSESOptions
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscognito#UserPoolSESOptions
Java	software.amazon.awscdk.services.cognito.UserPoolSESOptions
Python	aws_cdk.aws_cognito.UserPoolSESOptions
TypeScript (source)	aws-cdk-lib » aws_cognito » UserPoolSESOptions

Configuration for Cognito sending emails via Amazon SES.

Example

new cognito.UserPool(this, 'myuserpool', {
  email: cognito.UserPoolEmail.withSES({
    fromEmail: 'noreply@myawesomeapp.com',
    fromName: 'Awesome App',
    replyTo: 'support@myawesomeapp.com',
  }),
});

Properties

Name	Type	Description
fromEmail	string	The verified Amazon SES email address that Cognito should use to send emails.
configurationSetName?	string	The name of a configuration set in Amazon SES that should be applied to emails sent via Cognito.
fromName?	string	An optional name that should be used as the sender's name along with the email.
replyTo?	string	The destination to which the receiver of the email should reply to.
sesRegion?	string	Required if the UserPool region is different than the SES region.
sesVerifiedDomain?	string	SES Verified custom domain to be used to verify the identity.

---

fromEmail

Type: string

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

---

configurationSetName?

Type: string (optional, default: no configuration set)

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

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

---

fromName?

Type: string (optional, default: no name)

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

---

replyTo?

Type: string (optional, default: same as the fromEmail)

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

---

sesRegion?

Type: string (optional, default: The same region as the Cognito UserPool)

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.

---

sesVerifiedDomain?

Type: string (optional, default: no domain)

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