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

Requirements

Name	Version
terraform	>= 1.1.0
aws	>= 2.0
awsutils	>= 0.11.0

Providers

Name	Version
aws	>= 2.0

Modules

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

Resources

Name	Type
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
aws_iam_policy_document.ses_policy	data source
aws_region.current	data source

Inputs

Name	Description	Type	Default	Required
additional_tag_map	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.	map(string)	{}	no
attributes	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.	list(string)	[]	no
context	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.	any	{ "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 }	no
create_spf_record	If provided the module will create an SPF record for domain.	bool	false	no
custom_from_behavior_on_mx_failure	The behaviour of the custom_from_subdomain when the MX record is not found. Defaults to UseDefaultValue.	string	"UseDefaultValue"	no
custom_from_subdomain	If provided the module will create a custom subdomain for the From address.	list(string)	[]	no
delimiter	Delimiter to be used between ID elements. Defaults to - (hyphen). Set to "" to use no delimiter at all.	string	null	no
descriptor_formats	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).	any	{}	no
domain	The domain to create the SES identity for.	string	n/a	yes
enabled	Set to false to prevent the module from creating any resources	bool	null	no
environment	ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'	string	null	no
iam_access_key_max_age	Maximum age of IAM access key (seconds). Defaults to 30 days. Set to 0 to disable expiration.	number	2592000	no
iam_allowed_resources	Specifies resource ARNs that are enabled for var.iam_permissions. Wildcards are acceptable.	list(string)	[]	no
iam_permissions	Specifies permissions for the IAM user.	list(string)	[ "ses:SendRawEmail" ]	no
id_length_limit	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.	number	null	no
label_key_case	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.	string	null	no
label_order	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.	list(string)	null	no
label_value_case	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.	string	null	no
labels_as_tags	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.	set(string)	[ "default" ]	no
name	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.	string	null	no
namespace	ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique	string	null	no
regex_replace_chars	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.	string	null	no
ses_group_enabled	Creates a group with permission to send emails from SES domain	bool	true	no
ses_group_name	The name of the IAM group to create. If empty the module will calculate name from a context (recommended).	string	""	no
ses_group_path	The IAM Path of the group to create	string	"/"	no
ses_user_enabled	Creates user with permission to send emails from SES domain	bool	true	no
stage	ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'	string	null	no
tags	Additional tags (e.g. {'BusinessUnit': 'XYZ'}). Neither the tag keys nor the tag values will be modified by this module.	map(string)	{}	no
tenant	ID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is for	string	null	no
verify_dkim	If provided the module will create Route53 DNS records used for DKIM verification.	bool	false	no
verify_domain	If provided the module will create Route53 DNS records used for domain verification.	bool	false	no
zone_id	Route53 parent zone ID. If provided (not empty), the module will create Route53 DNS records used for verification	string	""	no

Outputs

Name	Description
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.