AWS CloudFormation resources for Amazon SES domain and email identities

UPDATE: AWS added the AWS::SES::EmailIdentity CloudFormation resource in mid-2022, so this custom resource is (finally!) no longer necessary. This repository remains here for reference, but you should switch to AWS::SES::EmailIdentity

Earlier readme…

AWS CloudFormation provides several built-in Amazon SES resource types, but is oddly missing the ones most needed to get going with SES: domain and email verification.

This package implements those missing types as CloudFormation custom resources: Custom::SES_Domain and Custom::SES_EmailIdentity.

You can use Custom::SES_Domain to verify domains for sending and/or receiving email through Amazon SES. It handles the SES domain verification calls and outputs SES's required DNS entries, so you can feed them directly into a standard AWS::Route53::RecordSetGroup resource (or to another DNS provider if you're not using Route 53).

Similarly, you can use Custom::SES_EmailIdentity to verify individual email addresses for sending through Amazon SES.

The custom resource implementations will properly create, update, and delete Amazon SES identities as you modify your CloudFormation stack.

Documentation

Installation
Usage
Development
Alternatives
Future

Installation

The custom SES resources are implemented as AWS Lambda Functions. To use them from your CloudFormation templates, you'll need to set up the functions along with IAM roles giving them permission to manage your Amazon SES domain/email identities.

The easiest way to do this is with a CloudFormation nested stack:

Copy the aws-cfn-ses-domain-VERSION.lambda.zip Lambda package and aws-cfn-ses-domain-VERSION.cf.yaml CloudFormation template from this repository's releases page into an S3 bucket in the region where you'll be running your CloudFormation stack. This bucket needs to be readable from CloudFormation, but need not be public.
Then in your CloudFormation template, use a nested stack to create the Lambda Functions and IAM roles for the custom SES resource types:

  CfnSESResources:
    Type: AWS::CloudFormation::Stack
    Properties:
      TemplateURL: https://s3.amazonaws.com/YOUR_BUCKET/aws-cfn-ses-domain-VERSION.cf.yaml
      Parameters:
        LambdaCodeS3Bucket: YOUR_BUCKET
        LambdaCodeS3Key: aws-cfn-ses-domain-VERSION.lambda.zip

The Custom::SES_Domain and Custom::SES_EmailIdentity resource types are now available to use like this (see Usage below for the full list of properties and return values):

  MySESDomain:
    Type: Custom::SES_Domain
    Properties:
      ServiceToken: !GetAtt CfnSESResources.Outputs.CustomDomainIdentityArn
      Domain: "example.com"
      # ...

  MySESEmailIdentity:
    Type: Custom::SES_EmailIdentity
    Properties:
      ServiceToken: !GetAtt CfnSESResources.Outputs.CustomEmailIdentityArn
      EmailAddress: "[email protected]"
      # ...

If you'd prefer to build and upload the custom resource code from source, see the Development section.

Usage

`Custom::SES_Domain`

To work with a Custom::SES_Domain resource in your CloudFormation template, you'll typically:

Define the AWS Lambda Function that implements the Custom::SES_Domain CloudFormation custom resource type, as shown in Installation above.
Declare a Custom::SES_Domain resource for your Amazon SES domain, specifying whatever SES options you need.
Declare an AWS::Route53::RecordSetGroup resource to manage SES's required DNS entries, passing it the Route53RecordSets attribute of your Custom::SES_Domain. (Or if you're not using Route 53, use the other Custom::SES_Domain return values to create the appropriate records with your DNS provider.)

Here's how that looks in a cloudformation.yaml template…

Resources:
  # 1. Define the Custom::SES_Domain's Lambda Function via a nested stack. 
  CfnSESResources:
    Type: AWS::CloudFormation::Stack
    Properties:
      TemplateURL: https://s3.amazonaws.com/YOUR_BUCKET/aws-cfn-ses-domain-VERSION.cf.yaml
      Parameters:
        LambdaCodeS3Bucket: YOUR_BUCKET
        LambdaCodeS3Key: aws-cfn-ses-domain-VERSION.lambda.zip

  # 2. Declare a Custom::SES_Domain resource for your SES domain.
  MySESDomain:
    Type: Custom::SES_Domain
    Properties:
      # ServiceToken is the Arn of a Lambda Function from the nested stack:
      ServiceToken: !GetAtt CfnSESResources.Outputs.CustomDomainIdentityArn
      # Remaining Properties are options for provisioning for your SES domain identity:
      # (Domain is required; all others are optional and shown with their defaults)
      Domain: "example.com"
      EnableSend: true
      EnableReceive: false
      MailFromSubdomain: "mail"
      TTL: "1800"
      CustomDMARC: '"v=DMARC1; p=none; pct=100; sp=none; aspf=r;"'
      Region: !Ref "AWS::Region"

  # 3. Declare a Route 53 RecordSetGroup to manage SES's required DNS entries.
  #    (This assumes you already have a Route 53 hosted zone for your domain;
  #    if not, you'll also want an AWS::Route53::HostedZone resource for it.
  #    Or if you don't use Route 53, see "Return Values" for other DNS options.)
  MyRoute53RecordsForSES:
    Type: AWS::Route53::RecordSetGroup
    Properties:
      HostedZoneName: "example.com."
      # The Route53RecordSets attribute specifies all DNS records needed:
      RecordSets: !GetAtt MySESDomain.Route53RecordSets

Properties

A Custom::SES_Domain resource supports the following Properties:

`ServiceToken`

The ARN of the Lambda Function that implements the Custom::SES_Domain type. (This is a standard property of all CloudFormation AWS::CloudFormation::CustomResource types.)

If you are using a nested stack as recommended in Installation above, the ServiceToken should be set to the nested stack's Outputs.CustomDomainIdentityArn.

Note that Custom::SES_Domain and Custom::SES_EmailIdentity use different ServiceToken ARNs, even though both are provided from the same nested stack.

Required: Yes

Type: String

Update requires: Updates are not supported

`Domain`

The domain name you want to provision for sending and/or receiving email via Amazon SES, such as example.com. (A trailing period is not required, but is allowed to simplify working with Route 53 HostedZone names that do require it.)

For more information, see Verifying Domains in Amazon SES in the Amazon SES Developer Guide.

Required: Yes

Type: String

Update requires: Replacement

`EnableSend`

Whether to enable outbound Amazon SES email from the domain. If true (the default), the resulting DNS records will include SES's required verification token and DKIM entries.

Required: No

Type: Boolean

Default: true

Update requires: No interruption

`EnableReceive`

Whether to enable inbound Amazon SES email to the domain. If true, the resulting DNS records will include SES's required verification token and inbound MX entry.

Required: No

Type: Boolean

Default: false

Update requires: No interruption

`MailFromSubdomain`

The subdomain of Domain to use as a custom MAIL FROM domain when sending through Amazon SES. The default is mail (so if your Custom::SES_Domain resource has Domain: example.com, it will by default be provisioned in SES with the custom MAIL FROM domain mail.example.com). The resulting DNS records will include SES's required SPF and feedback MX entries for the MAIL FROM domain.

To disable using a custom MAIL FROM domain (and instead use SES's default amazonses.com), set to an empty string: MailFromSubdomain: ''.

This property is only meaningful when EnableSend is true.

For more information, see Using a Custom MAIL FROM Domain in the Amazon SES Developer Guide.

Required: No

Type: String

Default: 'mail'

Update requires: No interruption

`CustomDMARC`

A custom DMARC value to include in the resulting DNS entries. The default will enable DMARC for your outbound email in "report only" mode. Note that you must include the double quotes around the entire string (which requires escaping in JSON or wrapping in single quotes in YAML). Example:

    CustomDMARC: '"v=DMARC1; p=reject; pct=100; rua=mailto:[email protected]"'

To disable generating a DMARC record, set to an empty string: CustomDMARC: ''.

This property is only meaningful when EnableSend is true.

For more information, see the DMARC.org Overview.

Required: No

Type: String

Default: '"v=DMARC1; p=none; pct=100; sp=none; aspf=r;"'

Update requires: No interruption

`TTL`

The time-to-live value to include in resulting DNS records (in seconds).

Required: No

Type: String

Default: '1800'

Update requires: No interruption

`Region`

The AWS Region where your Amazon SES domain will be provisioned, e.g., "us-east-1". This must be a region where Amazon SES is supported. The default is the region where your CloudFormation stack is running (or technically, where the Custom::SES_Domain lambda function is running.)

Required: No

Type: String

Default: ${AWS::Region}

Update requires: Replacement

Return Values

Ref

When a Custom::SES_Domain resource is provided to the Ref intrinsic function, Ref returns the Amazon Resource Name (ARN) of the Amazon SES domain identity (e.g., arn:aws:ses:us-east-1:111111111111:identity/example.com).

Changed in v0.3: Earlier versions returned the domain (which is still available as !GetAtt MySESDomain.Domain).

Fn::GetAtt

A Custom::SES_Domain resource returns several Fn::GetAtt attributes that can be used with other CloudFormation resources to maintain the required DNS records for your Amazon SES domain.

`Route53RecordSets`

A List of AWS::Route53::RecordSet objects specifying the DNS records required for the Custom::SES_Domain identity.

This is suitable for use as the RecordSets property of an AWS::Route53::RecordSetGroup resource. E.g.:

  MyRoute53RecordsForSES:
    Type: AWS::Route53::RecordSetGroup
    Properties:
      # HostedZone or HostedZoneName: ...
      RecordSets: !GetAtt MySESDomain.Route53RecordSets

If you update a Custom::SES_Domain resource, the Route53RecordSets attribute will change accordingly, and CloudFormation will figure out the precise updates needed to the Route 53 records.

`ZoneFileEntries`

A List of String lines that can be used in a standard Zone File to specify the DNS records required for the Custom::SES_Domain identity. The name field in each entry is a fully qualified hostname (ends in a period).

Example:

[
  '_amazonses.example.com.         1800  IN  TXT    "abcde12345"',
  'abcde1._domainkey.example.com.  1800  IN  CNAME  abcde1.dkim.amazonses.com.',
  'fghij2._domainkey.example.com.  1800  IN  CNAME  fghij2.dkim.amazonses.com.',
  'klmno3._domainkey.example.com.  1800  IN  CNAME  klmno3.dkim.amazonses.com.',
  'mail.example.com.               1800  IN  MX     10 feedback-smtp.us-west-1.amazonses.com.',
  'mail.example.com.               1800  IN  TXT    "v=spf1 include:amazonses.com -all"',
  '_dmarc.example.com.             1800  IN  TXT    "v=DMARC1; p=none; pct=100; sp=none; aspf=r;"',
  'example.com.                    1800  IN  MX     10 inbound-smtp.us-west-1.amazonaws.com.'
]

This can be useful if you are working with a DNS provider other than Route 53. For example, to include the zone file entries in your stack's output, use something like:

Outputs:
  ZoneFileEntries:
    Description: Add these lines to the zone file at your DNS provider.
    Value: !Join ["\n", !GetAtt MySESDomain.ZoneFileEntries]

Other attributes

A Custom::SES_Domain resource provides several other SES-related attributes which may be helpful for generating custom DNS records or other purposes:

Domain (String): The Domain, without any trailing period.
VerificationToken (String): The VerificationToken returned from SES:VerifyDomainIdentity
DkimTokens (List of String): The list of DkimTokens returned from SES:VerifyDomainDkim (not available if EnableSend is false)
MailFromDomain (String): the custom MAIL FROM domain, e.g., mail.example.com (not available if EnableSend is false or if MailFromSubdomain is empty)
MailFromMX (String): the feedback MX host to use with a custom MAIL FROM domain, e.g., feedback-smtp.us-east-1.amazonses.com (not available if EnableSend is false or if MailFromSubdomain is empty)
MailFromSPF (String): the SPF record value to use with a custom MAIL FROM domain (including the double quotes), e.g., "v=spf1 include:amazonses.com -all" (not available if EnableSend is false or if MailFromSubdomain is empty)
DMARC (String): the DMARC record value to use for outbound mail (including the double quotes), e.g., "v=DMARC1; p=none; pct=100; sp=none; aspf=r;" (not available if EnableSend is false or if CustomDMARC is empty)
ReceiveMX (String): the inbound MX host to use for receiving email, e.g., inbound-smtp.us-east-1.amazonaws.com (not available if EnableReceive is false)
Arn (String): the Amazon Resource Name (ARN) of the provisioned Amazon SES domain identity (useful for delegating sending authorization; this is the same value returned by !Ref MySESDomain)
Region (String): the resolved Region where the Amazon SES domain was provisioned

`Custom::SES_EmailIdentity`

To work with a Custom::SES_EmailIdentity resource in your CloudFormation template, you'll typically:

Define the AWS Lambda Function that implements the Custom::SES_EmailIdentity CloudFormation custom resource type, as shown in Installation above.
Declare one or more Custom::SES_EmailIdentity resource for your the email addresses you need to verify.

Here's how that looks in a cloudformation.yaml template…

Resources:
  # 1. Define the Custom::SES_EmailIdentity's Lambda Function via a nested stack. 
  CfnSESResources:
    Type: AWS::CloudFormation::Stack
    Properties:
      TemplateURL: https://s3.amazonaws.com/YOUR_BUCKET/aws-cfn-ses-domain-VERSION.cf.yaml
      Parameters:
        LambdaCodeS3Bucket: YOUR_BUCKET
        LambdaCodeS3Key: aws-cfn-ses-domain-VERSION.lambda.zip

  # 2. Declare Custom::SES_EmailIdentity resources for each address to verify.
  MySESSender:
    Type: Custom::SES_EmailIdentity
    Properties:
      # ServiceToken is the Arn of a Lambda Function from the nested stack:
      ServiceToken: !GetAtt CfnSESResources.Outputs.CustomEmailIdentityArn
      # Remaining Properties are options for verifying the email address:
      # (EmailAddress is required; all others are optional and shown with their defaults)
      EmailAddress: "[email protected]"
      Region: !Ref "AWS::Region"

  MySESReplyTo:
    Type: Custom::SES_EmailIdentity
    Properties:
      ServiceToken: !GetAtt CfnSESResources.Outputs.CustomEmailIdentityArn
      EmailAddress: "[email protected]"

Properties

`ServiceToken`

The ARN of the Lambda Function that implements the Custom::SES_EmailIdentity type. (This is a standard property of all CloudFormation AWS::CloudFormation::CustomResource types.)

If you are using a nested stack as recommended in Installation above, the ServiceToken should be set to the nested stack's Outputs.CustomEmailIdentityArn.

Note that Custom::SES_EmailIdentity and Custom::SES_Domain use different ServiceToken ARNs, even though both are provided from the same nested stack.

Required: Yes

Type: String

Update requires: Updates are not supported

`EmailAddress`

The email address you want to verify for sending through Amazon SES, such as [email protected]. This cannot include any "display name", and must be a single email address. (If you need to verify multiple addresses, simply create as many Custom::SES_EmailAddress resources as needed.)

AWS will send a verification email to this address the first time the stack containing the Custom::SES_EmailAddress resource is deployed, and again on any stack updates that alter the resource (such as changing its Region).

For more information, see Verifying Email Addresses in Amazon SES in the Amazon SES Developer Guide.

Required: Yes

Type: String

Update requires: Replacement

`Region`

The AWS Region where the email address will be verified, e.g., "us-east-1". This must be a region where Amazon SES is supported. The default is the region where your CloudFormation stack is running (or technically, where the Custom::SES_EmailIdentity lambda function is running.)

Required: No

Type: String

Default: ${AWS::Region}

Update requires: Replacement

Return Values

Ref

When a Custom::SES_EmailIdentity resource is provided to the Ref intrinsic function, Ref returns the Amazon Resource Name (ARN) of the Amazon SES email identity (e.g., arn:aws:ses:us-east-1:111111111111:identity/[email protected]).

Fn::GetAtt

A Custom::SES_EmailIdentity resource returns a few Fn::GetAtt attributes that may be helpful for working with it elsewhere in your template.

Arn (String): the Amazon Resource Name (ARN) of the Amazon SES email identity (this is the same value returned by !Ref MySESEmailAddress)
EmailAddress (String): the EmailAddress that was verified
Region (String): the resolved Region where the email identity was verified

Validating Your Templates

If you use cfn-lint (recommended!) to check your CloudFormation templates, you can include an "override spec" so your Custom::SES_Domain and Custom::SES_EmailIdentity properties and attributes will be validated. Download a copy of CustomSESDomainSpecification.json and then:

cfn-lint --override-spec CustomSESDomainSpecification.json YOUR-TEMPLATE.cf.yaml

(Without the override-spec, cfn-lint will allow any properties and values for Custom::SES_Domain and Custom::SES_EmailIdentity resources.)

Development

Development requires GNU Make (standard on most Linux-like systems) and Python 3. Ideally—particularly if you are changing code and running tests—you'll use the same version of Python that the Lambda Functions run (check the Runtime directives in [aws-cfn-ses-domain.cf.yaml][./aws-cfn-ses-domain.cf.yaml]), but any Python 3 should be fine.

To set up your development environment:

Clone the repository.
(Recommended) create and activate a Python venv for development. (pyenv and pyenv-virtualenv are very helpful for this.)
Run make init. (This just runs pip3 install -r requirements-dev.txt.)

To see a list of available make targets, run make help.

To package and upload your own version of the Lambda zip package and the CloudFormation templates, run make S3_BUCKET=your_bucket_name upload. If you just want to build locally without uploading to S3, run make S3_BUCKET=your_bucket_name all. You can also include S3_PREFIX=your/s3/prefix or S3_PREFIX= in either of these commands, if desired.

If you are changing code, you will want to run tests (make test) and static code checks (make check) before uploading.

Additional development customization variables are documented near the top of the Makefile.

Alternatives

These packages offer similar functionality (and provided some helpful background for Custom::SES_Domain):

Both of these manage your Route 53 records directly from the Lambda Function (rather than leaving that to other CloudFormation resources), and they may support fewer Amazon SES domain identity options than this package.

Future

The Custom::SES_Domain implementation is currently missing these Amazon SES domain identity features:

Control over SNS feedback notifications and forwarding options (SES:SetIdentityNotificationTopic and SES:SetIdentityFeedbackForwardingEnabled)
Control over Easy DKIM enabling (SES:SetIdentityDkimEnabled—currently, Custom::SES_Domain assumes if you are enabling sending, you also want Easy DKIM)

And the Custom::SES_EmailIdentity implementation is currently missing this Amazon SES email identity feature:

Ability to use a custom verification email template (SES:SendCustomVerificationEmail) and configuration set when verifying an email address.

Adding them is likely straightforward; contributions are welcome.

Are you from Amazon? It'd be great to have the SES domain and email identity resources standard in CloudFormation. Please consider adopting or obsoleting this package. (Just reach out if you'd like me to assign or transfer it.)

Name		Name	Last commit message	Last commit date
Latest commit History 42 Commits
.github		.github
aws_cfn_ses_domain		aws_cfn_ses_domain
tests		tests
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
CustomSESDomainSpecification.json		CustomSESDomainSpecification.json
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
aws-cfn-ses-domain.cf.yaml		aws-cfn-ses-domain.cf.yaml
example-usage.cf.yaml		example-usage.cf.yaml
index.py		index.py
release-github.py		release-github.py
requirements-dev.txt		requirements-dev.txt
setup.py		setup.py

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

AWS CloudFormation resources for Amazon SES domain and email identities

Installation

Usage

`Custom::SES_Domain`

Properties

`ServiceToken`

`Domain`

`EnableSend`

`EnableReceive`

`MailFromSubdomain`

`CustomDMARC`

`TTL`

`Region`

Return Values

Ref

Fn::GetAtt

`Route53RecordSets`

`ZoneFileEntries`

Other attributes

`Custom::SES_EmailIdentity`

Properties

`ServiceToken`

`EmailAddress`

`Region`

Return Values

Ref

Fn::GetAtt

Validating Your Templates

Development

Alternatives

Future

About

Releases 4

Packages

Contributors 2

Languages

License

medmunds/aws-cfn-ses-domain

Folders and files

Latest commit

History

Repository files navigation

AWS CloudFormation resources for Amazon SES domain and email identities

Installation

Usage

Custom::SES_Domain

Properties

ServiceToken

Domain

EnableSend

EnableReceive

MailFromSubdomain

CustomDMARC

TTL

Region

Return Values

Ref

Fn::GetAtt

Route53RecordSets

ZoneFileEntries

Other attributes

Custom::SES_EmailIdentity

Properties

ServiceToken

EmailAddress

Region

Return Values

Ref

Fn::GetAtt

Validating Your Templates

Development

Alternatives

Future

About

Topics

Resources

License

Stars

Watchers

Forks

Releases 4

Packages 0

Contributors 2

Languages

`Custom::SES_Domain`

`ServiceToken`

`Domain`

`EnableSend`

`EnableReceive`

`MailFromSubdomain`

`CustomDMARC`

`TTL`

`Region`

`Route53RecordSets`

`ZoneFileEntries`

`Custom::SES_EmailIdentity`

`ServiceToken`

`EmailAddress`

`Region`

Packages