Module: `ses`

Terraform module to provision Simple Email Service on AWS.

Usage

This module creates a SES domain with IAM user that is able to send emails with it. If module is provided with Route53 Zone ID it can also create verification DNS records for domain and DKIM.

For a complete example, see examples/complete.

For automated tests of the complete example using bats and Terratest (which tests and deploys the example on AWS), see test.

What's worth to note is that every AWS SES starts in Sandbox. Sending emails via it (emails not verified in AWS SES) is only allowed after support request.

SES availability in regions can be checked in latest AWS General Reference

Variables

Required Variables

domain (string) required: The domain to create the SES identity for.

Optional Variables

create_spf_record (bool) optional

If provided the module will create an SPF record for domain.

Default value: false

custom_from_behavior_on_mx_failure (string) optional

The behaviour of the custom_from_subdomain when the MX record is not found. Defaults to UseDefaultValue.

Default value: "UseDefaultValue"

custom_from_dns_record_enabled (bool) optional

If enabled the module will create a Route53 DNS record for the From address subdomain.

Default value: true

custom_from_subdomain (list(string)) optional

If provided the module will create a custom subdomain for the From address.

Default value: [ ]

iam_access_key_max_age (number) optional

Maximum age of IAM access key (seconds). Defaults to 30 days. Set to 0 to disable expiration.

Default value: 2592000

iam_allowed_resources (list(string)) optional

Specifies resource ARNs that are enabled for var.iam_permissions. Wildcards are acceptable.

Default value: [ ]

iam_permissions (list(string)) optional

Specifies permissions for the IAM user.

Default value:

[
  "ses:SendRawEmail"
]

ses_group_enabled (bool) optional

Creates a group with permission to send emails from SES domain

Default value: true

ses_group_name (string) optional

The name of the IAM group to create. If empty the module will calculate name from a context (recommended).

Default value: ""

ses_group_path (string) optional

The IAM Path of the group to create

Default value: "/"

ses_user_enabled (bool) optional

Creates user with permission to send emails from SES domain

Default value: true

verify_dkim (bool) optional

If provided the module will create Route53 DNS records used for DKIM verification.

Default value: false

verify_domain (bool) optional

If provided the module will create Route53 DNS records used for domain verification.

Default value: false

zone_id (string) optional

Route53 parent zone ID. If provided (not empty), the module will create Route53 DNS records used for verification

Default value: ""

Context Variables

The following variables are defined in the context.tf file of this module and part of the terraform-null-label pattern.

additional_tag_map (map(string)) optional

Additional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.
This is for some rare cases where resources want additional configuration of tags
and therefore take a list of maps with tag key, value, and additional configuration.

Required: No

Default value: { }

attributes (list(string)) optional

ID element. Additional attributes (e.g. workers or cluster) to add to id,
in the order they appear in the list. New attributes are appended to the
end of the list. The elements of the list are joined by the delimiter
and treated as a single ID element.

Required: No

Default value: [ ]

context (any) optional

Single object for setting entire context at once.
See description of individual variables for details.
Leave string and numeric variables as null to use default value.
Individual variable settings (non-null) override settings in context object,
except for attributes, tags, and additional_tag_map, which are merged.

Required: No

Default value:

{
  "additional_tag_map": {},
  "attributes": [],
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "environment": null,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "name": null,
  "namespace": null,
  "regex_replace_chars": null,
  "stage": null,
  "tags": {},
  "tenant": null
}

delimiter (string) optional

Delimiter to be used between ID elements.
Defaults to - (hyphen). Set to "" to use no delimiter at all.

Required: No

Default value: null

descriptor_formats (any) optional

Describe additional descriptors to be output in the descriptors output map.
Map of maps. Keys are names of descriptors. Values are maps of the form
\{<br/> format = string<br/> labels = list(string)<br/> \}
(Type is any so the map values can later be enhanced to provide additional options.)
format is a Terraform format string to be passed to the format() function.
labels is a list of labels, in order, to pass to format() function.
Label values will be normalized before being passed to format() so they will be
identical to how they appear in id.
Default is {} (descriptors output will be empty).

Required: No

Default value: { }

enabled (bool) optional

Set to false to prevent the module from creating any resources
Required: No

Default value: null

environment (string) optional

ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'
Required: No

Default value: null

id_length_limit (number) optional

Limit id to this many characters (minimum 6).
Set to 0 for unlimited length.
Set to null for keep the existing setting, which defaults to 0.
Does not affect id_full.

Required: No

Default value: null

label_key_case (string) optional

Controls the letter case of the tags keys (label names) for tags generated by this module.
Does not affect keys of tags passed in via the tags input.
Possible values: lower, title, upper.
Default value: title.

Required: No

Default value: null

label_order (list(string)) optional

The order in which the labels (ID elements) appear in the id.
Defaults to ["namespace", "environment", "stage", "name", "attributes"].
You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.

Required: No

Default value: null

label_value_case (string) optional

Controls the letter case of ID elements (labels) as included in id,
set as tag values, and output by this module individually.
Does not affect values of tags passed in via the tags input.
Possible values: lower, title, upper and none (no transformation).
Set this to title and set delimiter to "" to yield Pascal Case IDs.
Default value: lower.

Required: No

Default value: null

labels_as_tags (set(string)) optional

Set of labels (ID elements) to include as tags in the tags output.
Default is to include all labels.
Tags with empty values will not be included in the tags output.
Set to [] to suppress all generated tags.
Notes:
The value of the name tag, if included, will be the id, not the name.
Unlike other null-label inputs, the initial setting of labels_as_tags cannot be
changed in later chained modules. Attempts to change it will be silently ignored.

Required: No

Default value:

[
  "default"
]

name (string) optional

ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.
This is the only ID element not also included as a tag.
The "name" tag is set to the full id string. There is no tag with the value of the name input.

Required: No

Default value: null

namespace (string) optional

ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique
Required: No

Default value: null

regex_replace_chars (string) optional

Terraform regular expression (regex) string.
Characters matching the regex will be removed from the ID elements.
If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.

Required: No

Default value: null

stage (string) optional

ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'
Required: No

Default value: null

tags (map(string)) optional

Additional tags (e.g. {'BusinessUnit': 'XYZ'}).
Neither the tag keys nor the tag values will be modified by this module.

Required: No

Default value: { }

tenant (string) optional

ID element (Rarely used, not included by default). A customer identifier, indicating who this instance of a resource is for
Required: No

Default value: null

Outputs

access_key_id: The SMTP user which is access key ID.
custom_from_domain: The custom mail FROM domain
secret_access_key: The IAM secret for usage with SES API. This will be written to the state file in plain text.
ses_dkim_tokens: A list of DKIM Tokens which, when added to the DNS Domain as CNAME records, allows for receivers to verify that emails were indeed authorized by the domain owner.
ses_domain_identity_arn: The ARN of the SES domain identity
ses_domain_identity_verification_token: A code which when added to the domain as a TXT record will signal to SES that the owner of the domain has authorised SES to act on their behalf. The domain identity will be in state 'verification pending' until this is done. See below for an example of how this might be achieved when the domain is hosted in Route 53 and managed by Terraform. Find out more about verifying domains in Amazon SES in the AWS SES docs.
ses_group_name: The IAM group name
ses_smtp_password: The SMTP password. This will be written to the state file in plain text.
spf_record: The SPF record for the domain. This is a TXT record that should be added to the domain's DNS settings to allow SES to send emails on behalf of the domain.
user_arn: The ARN assigned by AWS for this user.
user_name: Normalized IAM user name.
user_unique_id: The unique ID assigned by AWS.

Dependencies

Requirements

terraform, version: >= 1.1.0
aws, version: >= 2.0
awsutils, version: >= 0.11.0

Providers

aws, version: >= 2.0

Modules

Name	Version	Source	Description
`ses_user`	0.23.2	`cloudposse/iam-system-user/aws`	n/a
`this`	0.25.0	`cloudposse/label/null`	n/a

Resources

The following resources are used by this module:

aws_iam_group.ses_users (resource)
aws_iam_group_policy.ses_group_policy (resource)
aws_iam_user_group_membership.ses_user (resource)
aws_iam_user_policy.sending_emails (resource)
aws_route53_record.amazonses_dkim_record (resource)
aws_route53_record.amazonses_spf_record (resource)
aws_route53_record.amazonses_verification_record (resource)
aws_route53_record.custom_mail_from_mx (resource)
aws_ses_domain_dkim.ses_domain_dkim (resource)
aws_ses_domain_identity.ses_domain (resource)
aws_ses_domain_mail_from.custom_mail_from (resource)

Data Sources

The following data sources are used by this module:

aws_iam_policy_document.ses_policy (data source)
aws_region.current (data source)

Module: ses

Usage​

Variables​

Required Variables​

Optional Variables​

Context Variables​

Outputs​

Dependencies​

Requirements​

Providers​

Modules​

Resources​

Data Sources​

Module: `ses`

Usage

Variables

Required Variables

Optional Variables

Context Variables

Outputs

Dependencies

Requirements

Providers

Modules

Resources

Data Sources