interface EmailIdentityProps

Language	Type name
.NET	Amazon.CDK.AWS.SES.EmailIdentityProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsses#EmailIdentityProps
Java	software.amazon.awscdk.services.ses.EmailIdentityProps
Python	aws_cdk.aws_ses.EmailIdentityProps
TypeScript (source)	aws-cdk-lib » aws_ses » EmailIdentityProps

Properties for an email identity.

Example

import * as iam from 'aws-cdk-lib/aws-iam';
declare const user: iam.User;

const identity = new ses.EmailIdentity(this, 'Identity', {
  identity: ses.Identity.domain('cdk.dev'),
});

identity.grantSendEmail(user);

Properties

Name	Type	Description
identity	Identity	The email address or domain to verify.
configurationSet?	IConfigurationSet	The configuration set to associate with the email identity.
dkimIdentity?	DkimIdentity	The type of DKIM identity to use.
dkimSigning?	boolean	Whether the messages that are sent from the identity are signed using DKIM.
feedbackForwarding?	boolean	Whether to receive email notifications when bounce or complaint events occur.
mailFromBehaviorOnMxFailure?	MailFromBehaviorOnMxFailure	The action to take if the required MX record for the MAIL FROM domain isn't found when you send an email.
mailFromDomain?	string	The custom MAIL FROM domain that you want the verified identity to use.

---

identity

Type: Identity

The email address or domain to verify.

---

configurationSet?

Type: IConfigurationSet (optional, default: do not use a specific configuration set)

The configuration set to associate with the email identity.

---

dkimIdentity?

Type: DkimIdentity (optional, default: Easy DKIM with a key length of 2048-bit)

The type of DKIM identity to use.

---

dkimSigning?

Type: boolean (optional, default: true)

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

---

feedbackForwarding?

Type: boolean (optional, default: true)

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).

---

mailFromBehaviorOnMxFailure?

Type: MailFromBehaviorOnMxFailure (optional, default: MailFromBehaviorOnMxFailure.USE_DEFAULT_VALUE)

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

---

mailFromDomain?

Type: string (optional, default: use amazonses.com)

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