Package software.amazon.awscdk.services.ses

package software.amazon.awscdk.services.ses

Amazon Simple Email Service Construct Library

This module is part of the AWS Cloud Development Kit project.

Email receiving

Create a receipt rule set with rules and actions (actions can be found in the aws-cdk-lib/aws-ses-actions package): 

 import software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.services.ses.actions.*;
 
 
 Bucket bucket = new Bucket(this, "Bucket");
 Topic topic = new Topic(this, "Topic");
 
 ReceiptRuleSet.Builder.create(this, "RuleSet")
         .rules(List.of(ReceiptRuleOptions.builder()
                 .recipients(List.of("hello@aws.com"))
                 .actions(List.of(
                     AddHeader.Builder.create()
                             .name("X-Special-Header")
                             .value("aws")
                             .build(),
                     S3.Builder.create()
                             .bucket(bucket)
                             .objectKeyPrefix("emails/")
                             .topic(topic)
                             .build()))
                 .build(), ReceiptRuleOptions.builder()
                 .recipients(List.of("aws.com"))
                 .actions(List.of(
                     Sns.Builder.create()
                             .topic(topic)
                             .build()))
                 .build()))
         .build();

Alternatively, rules can be added to a rule set: 

 ReceiptRuleSet ruleSet = new ReceiptRuleSet(this, "RuleSet");
 
 ReceiptRule awsRule = ruleSet.addRule("Aws", ReceiptRuleOptions.builder()
         .recipients(List.of("aws.com"))
         .build());

And actions to rules: 

 import software.amazon.awscdk.services.ses.actions.*;
 
 ReceiptRule awsRule;
 Topic topic;
 
 awsRule.addAction(Sns.Builder.create()
         .topic(topic)
         .build());

When using addRule, the new rule is added after the last added rule unless after is specified.

Drop spams

A rule to drop spam can be added by setting dropSpam to true: 

 ReceiptRuleSet.Builder.create(this, "RuleSet")
         .dropSpam(true)
         .build();

This will add a rule at the top of the rule set with a Lambda action that stops processing messages that have at least one spam indicator. See Lambda Function Examples.

Receipt filter

Create a receipt filter: 

 ReceiptFilter.Builder.create(this, "Filter")
         .ip("1.2.3.4/16")
         .build();

An allow list filter is also available: 

 AllowListReceiptFilter.Builder.create(this, "AllowList")
         .ips(List.of("10.0.0.0/16", "1.2.3.4/16"))
         .build();

This will first create a block all filter and then create allow filters for the listed ip addresses.

AWS Service Principal permissions

When adding an s3 action to a receipt rule, the CDK will automatically create a policy statement that allows the ses service principal to get write access to the bucket. This is done with the SourceAccount condition key, which is automatically added to the policy statement. Previously, the policy used the Referer condition key, which caused confused deputy problems when the bucket policy allowed access to the bucket for all principals. See more information in this github issue

Email sending

Dedicated IP pools

When you create a new Amazon SES account, your emails are sent from IP addresses that are shared with other Amazon SES users. For an additional monthly charge, you can lease dedicated IP addresses that are reserved for your exclusive use.

Use the DedicatedIpPool construct to create a pool of dedicated IP addresses. When specifying a name for your dedicated IP pool, ensure that it adheres to the following naming convention:

  • The name must include only lowercase letters (a-z), numbers (0-9), underscores (_), and hyphens (-).
  • The name must not exceed 64 characters in length.

 DedicatedIpPool.Builder.create(this, "Pool")
         .dedicatedIpPoolName("mypool")
         .scalingMode(ScalingMode.STANDARD)
         .build();

The pool can then be used in a configuration set. If the provided dedicatedIpPoolName does not follow the specified naming convention, an error will be thrown.

Configuration sets

Configuration sets are groups of rules that you can apply to your verified identities. A verified identity is a domain, subdomain, or email address you use to send email through Amazon SES. When you apply a configuration set to an email, all of the rules in that configuration set are applied to the email.

Use the ConfigurationSet construct to create a configuration set: 

 import software.amazon.awscdk.Duration;
 
 IDedicatedIpPool myPool;
 
 
 ConfigurationSet.Builder.create(this, "ConfigurationSet")
         .tlsPolicy(ConfigurationSetTlsPolicy.REQUIRE)
         .dedicatedIpPool(myPool)
         // Specify maximum delivery time
         // This configuration can be useful in such cases as time-sensitive emails (like those containing a one-time-password),
         // transactional emails, and email that you want to ensure isn't delivered during non-business hours.
         .maxDeliveryDuration(Duration.minutes(10))
         .build();

Use addEventDestination() to publish email sending events to Amazon SNS, Amazon CloudWatch, Amazon Data Firehose or Amazon EventBridge: 

 ConfigurationSet myConfigurationSet;
 Topic myTopic;
 
 
 myConfigurationSet.addEventDestination("ToSns", ConfigurationSetEventDestinationOptions.builder()
         .destination(EventDestination.snsTopic(myTopic))
         .build());

Note: For EventBridge, you must specify the default EventBus: 

 import software.amazon.awscdk.services.events.*;
 
 ConfigurationSet myConfigurationSet;
 
 
 IEventBus bus = EventBus.fromEventBusName(this, "EventBus", "default");
 
 myConfigurationSet.addEventDestination("ToEventBus", ConfigurationSetEventDestinationOptions.builder()
         .destination(EventDestination.eventBus(bus))
         .build());

For Firehose, if you don't specify IAM Role ARN for Amazon SES to send events. An IAM Role will be created automatically following https://docs.aws.amazon.com/ses/latest/dg/event-publishing-add-event-destination-firehose.html. 

 import software.amazon.awscdk.services.iam.*;
 import software.amazon.awscdk.services.kinesisfirehose.*;
 
 ConfigurationSet myConfigurationSet;
 IDeliveryStream firehoseDeliveryStream;
 IRole iamRole;
 
 
 // Create IAM Role automatically
 myConfigurationSet.addEventDestination("ToFirehose", ConfigurationSetEventDestinationOptions.builder()
         .destination(EventDestination.firehoseDeliveryStream(FirehoseDeliveryStreamDestination.builder()
                 .deliveryStream(firehoseDeliveryStream)
                 .build()))
         .build());
 
 // Specify your IAM Role
 myConfigurationSet.addEventDestination("ToFirehose", ConfigurationSetEventDestinationOptions.builder()
         .destination(EventDestination.firehoseDeliveryStream(FirehoseDeliveryStreamDestination.builder()
                 .deliveryStream(firehoseDeliveryStream)
                 .role(iamRole)
                 .build()))
         .build());

Tracking options

You can specify to use a custom redirect domain to handle open and click tracking for email sent with this configuration set by using customTrackingRedirectDomain and customTrackingHttpsPolicy. Detail can be found in Custom tracking domain. 

 ConfigurationSet.Builder.create(this, "ConfigurationSet")
         .customTrackingRedirectDomain("track.cdk.dev")
         .customTrackingHttpsPolicy(HttpsPolicy.REQUIRE)
         .build();

Note: The custom tracking redirect domain must be verified in Amazon SES. To create verified identities, you can use the EmailIdentity construct.

Override account-level suppression list settings

You can customize account-level suppression list separately for different configuration sets by overriding it with configuration set-level suppression.

For details, see Using configuration set-level suppression to override your account-level suppression list.

By default, the configuration set uses your account-level suppression list settings.

You can disable account-level suppression list by specifying disableSuppressionList to true. Email sent with this configuration set will not use any suppression settings at all. 

 ConfigurationSet.Builder.create(this, "ConfigurationSet")
         .disableSuppressionList(true)
         .build();

You can also override account level settings with configuration set-level suppression enabled. Email sent with this configuration set will only use the suppression conditions you enabled for it (bounces, complaints, or bounces and complaints) - regardless of what your account-level suppression list settings are, it will override them. 

 // Only bounces will be suppressed.
 // Only bounces will be suppressed.
 ConfigurationSet.Builder.create(this, "ConfigurationSet")
         .suppressionReasons(SuppressionReasons.BOUNCES_ONLY)
         .build();
 
 // Only complaints will be suppressed.
 // Only complaints will be suppressed.
 ConfigurationSet.Builder.create(this, "ConfigurationSet")
         .suppressionReasons(SuppressionReasons.COMPLAINTS_ONLY)
         .build();
 
 // Both bounces and complaints will be suppressed.
 // Both bounces and complaints will be suppressed.
 ConfigurationSet.Builder.create(this, "ConfigurationSet")
         .suppressionReasons(SuppressionReasons.BOUNCES_AND_COMPLAINTS)
         .build();

Email identity

In Amazon SES, a verified identity is a domain or email address that you use to send or receive email. Before you can send an email using Amazon SES, you must create and verify each identity that you're going to use as a From, Source, Sender, or Return-Path address. Verifying an identity with Amazon SES confirms that you own it and helps prevent unauthorized use.

To verify an identity for a hosted zone, you create an EmailIdentity: 

 IPublicHostedZone myHostedZone;
 
 
 EmailIdentity identity = EmailIdentity.Builder.create(this, "Identity")
         .identity(Identity.publicHostedZone(myHostedZone))
         .mailFromDomain("mail.cdk.dev")
         .build();

By default, Easy DKIM with a 2048-bit DKIM key is used.

You can instead configure DKIM authentication by using your own public-private key pair. This process is known as Bring Your Own DKIM (BYODKIM): 

 IPublicHostedZone myHostedZone;
 
 
 EmailIdentity.Builder.create(this, "Identity")
         .identity(Identity.publicHostedZone(myHostedZone))
         .dkimIdentity(DkimIdentity.byoDkim(ByoDkimOptions.builder()
                 .privateKey(SecretValue.secretsManager("dkim-private-key"))
                 .publicKey("...base64-encoded-public-key...")
                 .selector("selector")
                 .build()))
         .build();

When using publicHostedZone() for the identity, all necessary Amazon Route 53 records are created automatically:

  • CNAME records for Easy DKIM
  • TXT record for BYOD DKIM
  • MX and TXT records for the custom MAIL FROM

When working with domain(), records must be created manually: 

 EmailIdentity identity = EmailIdentity.Builder.create(this, "Identity")
         .identity(Identity.domain("cdk.dev"))
         .build();
 
 for (Object record : identity.getDkimRecords()) {
 }

Grants

To grant a specific action to a principal use the grant method. For sending emails, grantSendEmail can be used instead: 

 import software.amazon.awscdk.services.iam.*;
 User user;
 
 
 EmailIdentity identity = EmailIdentity.Builder.create(this, "Identity")
         .identity(Identity.domain("cdk.dev"))
         .build();
 
 identity.grantSendEmail(user);

You can also reference an existing email identity using its ARN and grant permissions to it: 

 import software.amazon.awscdk.services.iam.*;
 User user;
 
 
 // Imports an existing email identity using its ARN.
 // This is one way to reference an existing identity; another option is using its name via fromEmailIdentityName.
 IEmailIdentity importedIdentity = EmailIdentity.fromEmailIdentityArn(this, "ImportedIdentity", "arn:aws:ses:us-east-1:123456789012:identity/example.com");
 
 // Grant send email permission to the imported identity
 importedIdentity.grantSendEmail(user);

Virtual Deliverability Manager (VDM)

Virtual Deliverability Manager is an Amazon SES feature that helps you enhance email deliverability, like increasing inbox deliverability and email conversions, by providing insights into your sending and delivery data, and giving advice on how to fix the issues that are negatively affecting your delivery success rate and reputation.

Use the VdmAttributes construct to configure the Virtual Deliverability Manager for your account: 

 // Enables engagement tracking and optimized shared delivery by default
 // Enables engagement tracking and optimized shared delivery by default
 new VdmAttributes(this, "Vdm");

If you want to override the VDM settings in the specified configuration set, use vdmOptions in the ConfigurationSet construct.

Note: The configuration set level settings need to be used together with the account level settings. (To set the account level settings using CDK, use the VdmAttributes Construct.) If you enable only the configuration set level settings, VDM will not be enabled until the account level settings are configured. For more information, see Virtual Deliverability Manager settings. 

 ConfigurationSet.Builder.create(this, "ConfigurationSetWithVdmOptions")
         .vdmOptions(VdmOptions.builder()
                 .engagementMetrics(true)
                 .optimizedSharedDelivery(true)
                 .build())
         .build();