SesEmailIdentityConfig

Defined in: packages/core/src/config/types.ts:683

Extends

• SesIdentityBase

Properties

baseName

baseName: string

Defined in: packages/core/src/config/types.ts:671

Logical name for SSM keys + config-set naming.

Inherited from

SesIdentityBase.baseName

---

constructId

constructId: string

Defined in: packages/core/src/config/types.ts:669

CFN logical ID — NEVER change once deployed.

Inherited from

SesIdentityBase.constructId

---

dkimIdentity?

readonly optional dkimIdentity?: DkimIdentity

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-ses/lib/email-identity.d.ts:66

The type of DKIM identity to use

Default

- Easy DKIM with a key length of 2048-bit

Inherited from

SesIdentityBase.dkimIdentity

---

dkimSigning?

readonly optional dkimSigning?: boolean

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-ses/lib/email-identity.d.ts:60

Whether the messages that are sent from the identity are signed using DKIM

Default

true

Inherited from

SesIdentityBase.dkimSigning

---

emailAddress

emailAddress: string

Defined in: packages/core/src/config/types.ts:685

---

feedbackForwarding?

readonly optional feedbackForwarding?: boolean

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-ses/lib/email-identity.d.ts:79

Whether to receive email notifications when bounce or complaint events occur. These notifications are sent to the address that you specified in the Return-Path header of the original email.

You’re required to have a method of tracking bounces and complaints. If you haven’t set up another mechanism for receiving bounce or complaint notifications (for example, by setting up an event destination), you receive an email notification when these events occur (even if this setting is disabled).

Default

true

Inherited from

SesIdentityBase.feedbackForwarding

---

kind

kind: "email"

Defined in: packages/core/src/config/types.ts:684

---

mailFromBehaviorOnMxFailure?

readonly optional mailFromBehaviorOnMxFailure?: MailFromBehaviorOnMxFailure

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-ses/lib/email-identity.d.ts:97

The action to take if the required MX record for the MAIL FROM domain isn’t found when you send an email

Default

MailFromBehaviorOnMxFailure.USE_DEFAULT_VALUE

Inherited from

SesIdentityBase.mailFromBehaviorOnMxFailure

---

mailFromDomain?

readonly optional mailFromDomain?: string

Defined in: node_modules/.pnpm/aws-cdk-lib@2.261.0_constructs@10.7.0/node_modules/aws-cdk-lib/aws-ses/lib/email-identity.d.ts:90

The custom MAIL FROM domain that you want the verified identity to use. The MAIL FROM domain must meet the following criteria:

• It has to be a subdomain of the verified identity
• It can’t be used to receive email
• It can’t be used in a “From” address if the MAIL FROM domain is a destination for feedback forwarding emails

Default

- use amazonses.com

Inherited from

SesIdentityBase.mailFromDomain