# UserPoolSESOptions

Configuration for Cognito sending emails via Amazon SES.

- Source: [`aws-cognito/lib/user-pool-email.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-cognito/lib/user-pool-email.ts#L10)
- Type last changed: v2.22.0 · 28 Apr 2022

## Example

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

## Properties

- `configurationSetName`: string — The name of a configuration set in Amazon SES that should be applied to emails sent via Cognito.

  **Default:** no configuration set

- `fromEmail`: string (required) — 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.

- `fromName`: string — An optional name that should be used as the sender's name along with the email.

  **Default:** no name

- `replyTo`: string — The destination to which the receiver of the email should reply to.

  **Default:** same as the fromEmail

- `sesRegion`: 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.

- `sesVerifiedDomain`: string — SES Verified custom domain to be used to verify the identity.

  **Default:** no domain