ses

This component provisions Amazon Simple Email Service (SES) to act as an SMTP gateway.

By default, the component sets up SES domain identity with DKIM and domain verification via Route53, suitable for use with IAM roles (e.g., ECS task roles).

Optionally, an IAM user and group can be created for SMTP authentication by setting ses_user_enabled and ses_group_enabled to true. When enabled, credentials are stored in SSM Parameter Store and encrypted with a dedicated KMS key.

Usage

Stack Level: Regional

important

This release changes the default of ses_user_enabled from true to false. Existing stacks that still need SMTP credentials must set ses_user_enabled: true (and ses_group_enabled: true if they need the IAM group) before applying this version, or Terraform will destroy the IAM/KMS/SSM resources created by earlier releases.

Here's an example snippet for how to use this component with IAM roles (the default, recommended for ECS/Lambda workloads):

components:
  terraform:
    ses:
      settings:
        spacelift:
          workspace_enabled: true
      vars:
        enabled: true
        name: ses
        # format(domain_template, tenant, environment, stage)
        # produces: dev.use1.platform.acme.org
        domain_template: "%[2]s.%[3]s.%[1]s.acme.org"
        tags:
          Team: sre
          Service: ses

To create an IAM user with SMTP credentials stored in SSM Parameter Store (for legacy or third-party integrations):

components:
  terraform:
    ses:
      vars:
        enabled: true
        name: ses
        domain_template: "%[2]s.%[3]s.%[1]s.acme.org"
        ses_user_enabled: true
        ses_group_enabled: true
        ssm_prefix: "/ses"
        tags:
          Team: sre
          Service: ses

If you want to provide the Route53 zone ID directly instead of looking it up via the dns-delegated remote state:

components:
  terraform:
    ses:
      vars:
        enabled: true
        name: ses
        domain_template: "%[2]s.%[3]s.%[1]s.acme.org"
        zone_id: "Z1234567890"
        tags:
          Team: sre
          Service: ses

Variables

Required Variables

domain_template (string) required

The format() string to use to generate the base domain name for sending and receiving email with Amazon SES, `format(var.domain_template, var.tenant, var.environment, var.stage)

region (string) required

AWS Region

Optional Variables

account_map optional

INFO: Temporary variable required for account-map deprecation plan. Please do not change the value

Type:

object({
full_account_map              = map(string)
audit_account_account_name    = optional(string, "")
root_account_account_name     = optional(string, "")
identity_account_account_name = optional(string, "")
aws_partition                 = optional(string, "aws")
iam_role_arn_templates        = optional(map(string), {})
})

Default value:

{
  "audit_account_account_name": "",
  "aws_partition": "aws",
  "full_account_map": {},
  "iam_role_arn_templates": {},
  "identity_account_account_name": "",
  "root_account_account_name": ""
}

account_map_enabled (bool) optional

INFO: Temporary variable required for account-map deprecation plan. Please do not change the value

Default value: true

dns_delegated_environment_name (string) optional

dns-delegated component environment name

Default value: null

ses_group_enabled (bool) optional

Creates a group with permission to send emails from SES domain

Default value: false

ses_user_enabled (bool) optional

Creates user with permission to send emails from SES domain

Default value: false

ses_verify_dkim (bool) optional

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

Default value: true

ses_verify_domain (bool) optional

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

Default value: true

ssm_prefix (string) optional

The prefix to use for the SSM parameters

Default value: "/ses"

zone_id (string) optional

Route53 hosted zone ID. If provided, bypasses the dns-delegated remote state lookup.

Default value: null

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

domain

The SES domain name

ses_domain_identity_arn

The ARN of the SES domain identity

smtp_password

The SMTP password. Only available when ses_user_enabled is true. This value is stored in Terraform state, so protect the state backend with encryption and access controls.

smtp_user

Access key ID of the IAM user. Only available when ses_user_enabled is true

user_arn

The ARN of the IAM user. Only available when ses_user_enabled is true

user_name

Normalized name of the IAM user. Only available when ses_user_enabled is true

user_unique_id

The unique ID of the IAM user. Only available when ses_user_enabled is true

Dependencies

Requirements

• terraform, version: >= 1.0.0
• aws, version: >= 4.0, < 6.0.0
• awsutils, version: >= 0.11.0, < 6.0.0

Providers

• aws, version: >= 4.0, < 6.0.0

Modules

Name	Version	Source	Description
dns_gbl_delegated	1.8.0	cloudposse/stack-config/yaml//modules/remote-state	n/a
iam_roles	latest	../account-map/modules/iam-roles	n/a
kms_key_ses	0.12.2	cloudposse/kms-key/aws	n/a
ses	0.25.1	cloudposse/ses/aws	n/a
ssm_parameter_store	0.13.0	cloudposse/ssm-parameter-store/aws	n/a
this	0.25.0	cloudposse/label/null	n/a

Resources

The following resources are used by this module:

Data Sources

The following data sources are used by this module:

• aws_caller_identity.current (data source)
• aws_iam_policy_document.kms_key_ses (data source)
• aws_partition.current (data source)