Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/nventive/terraform-aws-ses

Terraform module to provision Simple Email Service (SES) on AWS.
https://github.com/nventive/terraform-aws-ses

Last synced: 26 days ago
JSON representation

Terraform module to provision Simple Email Service (SES) on AWS.

Awesome Lists containing this project

README 

          

![nventive](https://nventive-public-assets.s3.amazonaws.com/nventive_logo_github.svg?v=2)



# terraform-aws-ses



[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=flat-square)](LICENSE) [![Latest Release](https://img.shields.io/github/release/nventive/terraform-aws-ses.svg?style=flat-square)](https://github.com/nventive/terraform-aws-ses/releases/latest)



Terraform module to provision Simple Email Service (SES) on AWS.



---



## Examples



**IMPORTANT:** We do not pin modules to versions in our examples because of the difficulty of keeping the versions in

the documentation in sync with the latest released versions. We highly recommend that in your code you pin the version

to the exact version you are using so that your infrastructure remains stable, and update versions in a systematic way

so that they do not catch you by surprise.



```hcl

module "skeleton" {

  source = "nventive/ses/aws"

  # We recommend pinning every module to a specific version

  # version = "x.x.x"



  namespace = "eg"

  stage     = "test"

  name      = "app"



  domain           = "example.com"

  mail_from_domain = "bounce"

  verify_dkim      = true

  verify_domain    = true

  zone_id          = "XXXXXXXXXXXXXX"

}

```



## Requirements



| Name | Version |

|------|---------|

|  [terraform](#requirement\_terraform) | >= 0.13.0 |

|  [aws](#requirement\_aws) | >= 2.0 |

|  [null](#requirement\_null) | >= 2.0 |

|  [template](#requirement\_template) | >= 2.0 |



## Providers



| Name | Version |

|------|---------|

|  [aws](#provider\_aws) | >= 2.0 |



## Modules



| Name | Source | Version |

|------|--------|---------|

|  [ses](#module\_ses) | cloudposse/ses/aws | 0.24.0 |

|  [this](#module\_this) | cloudposse/label/null | 0.25.0 |



## Resources



| Name | Type |

|------|------|

| [aws_route53_record.ses_domain_mail_from_mx](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource |

| [aws_route53_record.ses_domain_mail_from_txt](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/route53_record) | resource |

| [aws_ses_domain_mail_from.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/ses_domain_mail_from) | resource |

| [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source |



## Inputs



| Name | Description | Type | Default | Required |

|------|-------------|------|---------|:--------:|

|  [additional\_tag\_map](#input\_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](#input\_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 |

|  [behavior\_on\_mx\_failure](#input\_behavior\_on\_mx\_failure) | The action that you want Amazon SES to take if it cannot successfully read the required MX record when you send an email.
Valid values are: `UseDefaultValue` and `RejectMessage`. | `string` | `"UseDefaultValue"` | no |

|  [context](#input\_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 |

|  [custom\_mx\_enabled](#input\_custom\_mx\_enabled) | Creates a Route53 MX entry for the custom MAIL FROM domain. | `bool` | `true` | no |

|  [custom\_spf\_enabled](#input\_custom\_spf\_enabled) | Creates a Route53 SPF TXT entry for the custom MAIL FROM domain. | `bool` | `true` | no |

|  [delimiter](#input\_delimiter) | Delimiter to be used between ID elements.
Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. | `string` | `null` | no |

|  [descriptor\_formats](#input\_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
`{
   format = string
   labels = list(string)
}`
(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](#input\_domain) | The domain to create the SES identity for. | `string` | n/a | yes |

|  [enabled](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no |

|  [environment](#input\_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](#input\_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](#input\_iam\_allowed\_resources) | Specifies resource ARNs that are enabled for `var.iam_permissions`. Wildcards are acceptable. | `list(string)` | `[]` | no |

|  [iam\_permissions](#input\_iam\_permissions) | Specifies permissions for the IAM user. | `list(string)` | 
[
  "ses:SendRawEmail"
]
 | no |

|  [id\_length\_limit](#input\_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](#input\_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](#input\_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](#input\_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](#input\_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 |

|  [mail\_from\_domain](#input\_mail\_from\_domain) | Subdomain (of the `domain`) which is to be used as MAIL FROM address (Required for DMARC validation).
Specify only the subdomain part as the FQDN is inferred from the `domain` variable. | `string` | `""` | no |

|  [name](#input\_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](#input\_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](#input\_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](#input\_ses\_group\_enabled) | Creates a group with permission to send emails from SES domain. | `bool` | `true` | no |

|  [ses\_group\_name](#input\_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](#input\_ses\_group\_path) | The IAM Path of the group to create. | `string` | `"/"` | no |

|  [ses\_user\_enabled](#input\_ses\_user\_enabled) | Creates user with permission to send emails from SES domain. | `bool` | `true` | no |

|  [stage](#input\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |

|  [tags](#input\_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](#input\_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](#input\_verify\_dkim) | If provided the module will create Route53 DNS records used for DKIM verification. | `bool` | `false` | no |

|  [verify\_domain](#input\_verify\_domain) | If provided the module will create Route53 DNS records used for domain verification. | `bool` | `false` | no |

|  [zone\_id](#input\_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](#output\_access\_key\_id) | The SMTP user which is access key ID. |

|  [secret\_access\_key](#output\_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](#output\_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](#output\_ses\_domain\_identity\_arn) | The ARN of the SES domain identity |

|  [ses\_domain\_identity\_verification\_token](#output\_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](#output\_ses\_group\_name) | The IAM group name |

|  [ses\_smtp\_password](#output\_ses\_smtp\_password) | The SMTP password. This will be written to the state file in plain text. |

|  [user\_arn](#output\_user\_arn) | The ARN assigned by AWS for this user. |

|  [user\_name](#output\_user\_name) | Normalized IAM user name. |

|  [user\_unique\_id](#output\_user\_unique\_id) | The unique ID assigned by AWS. |



## Breaking Changes



Please consult [BREAKING\_CHANGES.md](BREAKING\_CHANGES.md) for more information about version

history and compatibility.



## Contributing



Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on the process for

contributing to this project.



Be mindful of our [Code of Conduct](CODE\_OF\_CONDUCT.md).



## We're hiring



Look for current openings on BambooHR https://nventive.bamboohr.com/careers/



## Stay in touch



[nventive.com](https://nventive.com/) | [Linkedin](https://www.linkedin.com/company/nventive/) | [Instagram](https://www.instagram.com/hellonventive/) | [YouTube](https://www.youtube.com/channel/UCFQyvGEKMO10hEyvCqprp5w) | [Spotify](https://open.spotify.com/show/0lsxfIb6Ttm76jB4wgutob)