Skip to main content

The CDK Construct Library for AWS::SES

Project description

Amazon Simple Email Service Construct Library


Stability: Experimental

This is a developer preview (public beta) module. Releases might lack important features and might have future breaking changes.

This API is still under active development and subject to non-backward compatible changes or removal in any future version. Use of the API is not recommended in production environments. Experimental APIs are not subject to the Semantic Versioning model.


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

Email receiving

Create a receipt rule set with rules and actions:

const bucket = new s3.Bucket(stack, 'Bucket');
const topic = new sns.Topic(stack, 'Topic');

new ses.ReceiptRuleSet(stack, 'RuleSet', {
  rules: [
    {
      recipients: ['hello@aws.com'],
      actions: [
        new ses.ReceiptRuleAddHeaderAction({
          name: 'X-Special-Header',
          value: 'aws'
        }),
        new ses.ReceiptRuleS3Action({
          bucket,
          objectKeyPrefix: 'emails/',
          topic
        })
      ],
    },
    {
      recipients: ['aws.com'],
      actions: [
        new ses.ReceiptRuleSnsAction({
          topic
        })
      ]
    }
  ]
});

Alternatively, rules can be added to a rule set:

const ruleSet = new ses.ReceiptRuleSet(this, 'RuleSet'):

const awsRule = ruleSet.addRule('Aws', {
  recipients: ['aws.com']
});

And actions to rules:

awsRule.addAction(
  new ses.ReceiptRuleSnsAction({
    topic
  });
);

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

More actions

Drop spams

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

new ses.ReceiptRuleSet(this, 'RuleSet', {
  dropSpam: true
});

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:

new ses.ReceiptFilter(this, 'Filter', {
  ip: '1.2.3.4/16' // Will be blocked
})

A white list filter is also available:

new ses.WhiteListReceiptFilter(this, 'WhiteList', {
  ips: [
    '10.0.0.0/16',
    '1.2.3.4/16',
  ]
});

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aws-cdk.aws-ses-1.6.0.tar.gz (99.8 kB view hashes)

Uploaded Source

Built Distribution

aws_cdk.aws_ses-1.6.0-py3-none-any.whl (96.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page