EmailIdentityProps Struct
Properties for an email identity.
Example
ts
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
configurationSetIConfigurationSetRefconfiguration_setIConfigurationSetRefconfigurationSetIConfigurationSetRefConfigurationSetIConfigurationSetRefConfigurationSetIConfigurationSetRef= do not use a specific configurat…#The configuration set to associate with the email identity.
default
Default: do not use a specific configuration set
dkimIdentityDkimIdentitydkim_identityDkimIdentitydkimIdentityDkimIdentityDkimIdentityDkimIdentityDkimIdentityDkimIdentity= Easy DKIM with a key length of 2…#The type of DKIM identity to use.
default
Default: Easy DKIM with a key length of 2048-bit
Whether the messages that are sent from the identity are signed using DKIM.
feedbackForwardingbooleanfeedback_forwardingboolfeedbackForwardingBooleanFeedbackForwardingboolFeedbackForwarding*bool= true#Whether to receive email notifications when bounce or complaint events occur.
notes
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).
The email address or domain to verify.
mailFromBehaviorOnMxFailureMailFromBehaviorOnMxFailuremail_from_behavior_on_mx_failureMailFromBehaviorOnMxFailuremailFromBehaviorOnMxFailureMailFromBehaviorOnMxFailureMailFromBehaviorOnMxFailureMailFromBehaviorOnMxFailureMailFromBehaviorOnMxFailureMailFromBehaviorOnMxFailure= MailFromBehaviorOnMxFailure.USE_…#The action to take if the required MX record for the MAIL FROM domain isn't found when you send an email.
default
Default: MailFromBehaviorOnMxFailure.USE_DEFAULT_VALUE
mailFromDomainstringmail_from_domainstrmailFromDomainStringMailFromDomainstringMailFromDomain*string= use amazonses.com#The custom MAIL FROM domain that you want the verified identity to use.
notes
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