Skip to main content

The CDK Construct Library for AWS::SES

Project description

The CDK Construct Library for AWS Simple Email Service

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.

Import and export receipt rule set and receipt rules

Receipt rule sets and receipt rules can be exported:

const ruleSet = new ReceiptRuleSet(this, 'RuleSet');
const rule = ruleSet.addRule(this, 'Rule', {
  recipients: ['hello@mydomain.com']
});

const ruleSetRef = ruleSet.export();
const ruleRef = rule.export();

And imported:

const importedRuleSet = ses.ReceiptRuleSet.import(this, 'ImportedRuleSet', ruleSetRef);

const importedRule = ses.ReceiptRule.import(this, 'ImportedRule', ruleRef);

const otherRule = ses.ReceiptRule.import(this, 'OtherRule', {
  name: 'other-rule'
});

importedRuleSet.addRule('New', { // This rule is added after the imported rule
  after: importedRule,
  recipients: ['mydomain.com']
});

importedRuleSet.addRule('Extra', { // Added after the 'New' rule
  recipients: ['extra.com']
});

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


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
aws_cdk.aws_ses-0.28.0-py3-none-any.whl (95.5 kB) Copy SHA256 hash SHA256 Wheel py3
aws-cdk.aws-ses-0.28.0.tar.gz (97.5 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page