AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

EmailIdentity

An email identity.

Import

import { EmailIdentity } from 'aws-cdk-lib/aws-ses';

Or use the module namespace:

import * as ses from 'aws-cdk-lib/aws-ses';
// ses.EmailIdentity

Properties

Configuration passed to the constructor as EmailIdentityProps.

identityRequired
Identity

The email address or domain to verify.

configurationSetOptional
IConfigurationSetRef

The configuration set to associate with the email identity.

Default: - do not use a specific configuration set

dkimIdentityOptional
DkimIdentity

The type of DKIM identity to use.

Default: - Easy DKIM with a key length of 2048-bit

dkimSigningOptional
boolean

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

Default: true

feedbackForwardingOptional
boolean

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

mailFromBehaviorOnMxFailureOptional
MailFromBehaviorOnMxFailure

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

mailFromDomainOptional
string

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

Get the Amazon SES Cheat Sheet

Everything you need to know about Amazon SES on one page. HD quality, print-friendly.

Download Free Infographic