Skip to content

Latest commit

 

History

History
65 lines (54 loc) · 9.06 KB

README.md

File metadata and controls

65 lines (54 loc) · 9.06 KB
Raw

viget.aws-canary-heartbeat

Terraform module to set up an AWS SES sending domain.

Requirements

Name Version
terraform >= 1.0
aws >= 4.44.0

Providers

Name Version
aws >= 4.44.0

Resources

Name Type
aws_iam_group.ses_users resource
aws_iam_group_policy_attachment.ses_sending_policy resource
aws_iam_policy.ses_sending_policy resource
aws_sesv2_configuration_set.this resource
aws_sesv2_dedicated_ip_pool.this resource
aws_sesv2_email_identity.this resource
aws_iam_policy_document.ses_group_sending_policy 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
component ID element. Usually the component or solution name, e.g. 'eks', 'rds', 'app'. string null 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": [],
  "component": null,
  "delimiter": null,
  "descriptor_formats": {},
  "enabled": true,
  "id_length_limit": null,
  "label_key_case": null,
  "label_order": [],
  "label_value_case": null,
  "labels_as_tags": [
    "unset"
  ],
  "namespace": null,
  "regex_replace_chars": null,
  "tags": {},
  "tenant": null
}
 no
create_sending_pool Whether to create a sending pool for the domain. bool false 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 for the SES identity. string n/a yes
enabled Set to false to prevent the module from creating any resources bool null no
group_path The IAM Path of the group and policy to create string "/" 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", "stage", "component", "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.
Unlike other context 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
namespace ID element. Usually an abbreviation of the 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
sending_pool_name Override the default sending pool name. If not provided, the sending pool name will use the context module id.
Note: If you are using an existing sending pool, create_sending_pool must be set to false.		 string "" no
stage ID element. 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

Outputs

Name Description
dkim_records The DNS records required for Amazon SES validation and DKIM setup.
email_identity The email identity.
iam_sending_group_name The IAM group name.
sending_pool_name The name of the SES sending pool to associate the domain with.