From 94931cfc8dc6556328d326cab0c014d74b6c7ba0 Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Thu, 4 Jun 2026 08:01:01 +0100 Subject: [PATCH 01/13] initial files --- infrastructure/modules/acm/README.md | 1 + infrastructure/modules/acm/context.tf | 374 ++++++++++++++++++++++++ infrastructure/modules/acm/main.tf | 1 + infrastructure/modules/acm/outputs.tf | 1 + infrastructure/modules/acm/variables.tf | 1 + 5 files changed, 378 insertions(+) create mode 100644 infrastructure/modules/acm/README.md create mode 100644 infrastructure/modules/acm/context.tf create mode 100644 infrastructure/modules/acm/main.tf create mode 100644 infrastructure/modules/acm/outputs.tf create mode 100644 infrastructure/modules/acm/variables.tf diff --git a/infrastructure/modules/acm/README.md b/infrastructure/modules/acm/README.md new file mode 100644 index 0000000..c9fb524 --- /dev/null +++ b/infrastructure/modules/acm/README.md @@ -0,0 +1 @@ +# DAVEH diff --git a/infrastructure/modules/acm/context.tf b/infrastructure/modules/acm/context.tf new file mode 100644 index 0000000..4702770 --- /dev/null +++ b/infrastructure/modules/acm/context.tf @@ -0,0 +1,374 @@ +# +# ONLY EDIT THIS FILE IN github.com/NHSDigital/screening-terraform-modules-aws/infrastructure/modules/tags +# All other instances of this file should be a copy of that one +# +# +# Copy this file from https://github.com/NHSDigital/screening-terraform-modules-aws/blob/master/infrastructure/modules/tags/exports/context.tf +# and then place it in your Terraform module to automatically get +# tag module standard configuration inputs suitable for passing +# to other modules. +# +# curl -sL https://raw.githubusercontent.com/NHSDigital/screening-terraform-modules-aws/master/infrastructure/modules/tags/exports/context.tf -o context.tf +# +# Modules should access the whole context as `module.this.context` +# to get the input variables with nulls for defaults, +# for example `context = module.this.context`, +# and access individual variables as `module.this.`, +# with final values filled in. +# +# For example, when using defaults, `module.this.context.delimiter` +# will be null, and `module.this.delimiter` will be `-` (hyphen). +# + +module "this" { + source = "git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/tags?ref=v2.6.0" + + service = var.service + project = var.project + region = var.region + environment = var.environment + stack = var.stack + workspace = var.workspace + name = var.name + delimiter = var.delimiter + attributes = var.attributes + tags = var.tags + additional_tag_map = var.additional_tag_map + label_order = var.label_order + regex_replace_chars = var.regex_replace_chars + id_length_limit = var.id_length_limit + label_key_case = var.label_key_case + label_value_case = var.label_value_case + terraform_source = coalesce(var.terraform_source, path.module) + descriptor_formats = var.descriptor_formats + labels_as_tags = var.labels_as_tags + + context = var.context +} + +# Copy contents of screening-terraform-modules-aws/tags/variables.tf here +# tflint-ignore: terraform_unused_declarations +variable "aws_region" { + type = string + description = "The AWS region" + default = "eu-west-2" + validation { + condition = contains(["eu-west-1", "eu-west-2", "us-east-1"], var.aws_region) + error_message = "AWS Region must be one of eu-west-1, eu-west-2, us-east-1" + } +} + +variable "context" { + type = any + default = { + enabled = true + service = null + project = null + region = null + environment = null + stack = null + workspace = null + name = null + delimiter = null + attributes = [] + tags = {} + additional_tag_map = {} + regex_replace_chars = null + label_order = [] + id_length_limit = null + label_key_case = null + label_value_case = null + terraform_source = null + descriptor_formats = {} + # Note: we have to use [] instead of null for unset lists due to + # https://github.com/hashicorp/terraform/issues/28137 + # which was not fixed until Terraform 1.0.0, + # but we want the default to be all the labels in `label_order` + # and we want users to be able to prevent all tag generation + # by setting `labels_as_tags` to `[]`, so we need + # a different sentinel to indicate "default" + labels_as_tags = ["unset"] + } + description = <<-EOT + 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. + EOT + + validation { + condition = lookup(var.context, "label_key_case", null) == null ? true : contains(["lower", "title", "upper"], var.context["label_key_case"]) + error_message = "Allowed values: `lower`, `title`, `upper`." + } + + validation { + condition = lookup(var.context, "label_value_case", null) == null ? true : contains(["lower", "title", "upper", "none"], var.context["label_value_case"]) + error_message = "Allowed values: `lower`, `title`, `upper`, `none`." + } +} + +variable "terraform_source" { + type = string + default = null + description = "Source location to record in the Terraform_source tag. Defaults to the caller module path when not set." +} + +variable "enabled" { + type = bool + default = null + description = "Set to false to prevent the module from creating any resources" +} + +variable "service" { + type = string + default = null + description = "ID element. Usually an abbreviation of your service directorate name, e.g. 'bcss' or 'csms', to help ensure generated IDs are globally unique" +} + +variable "region" { + type = string + default = null + description = "ID element _(Rarely used, not included by default)_. Usually an abbreviation of the selected AWS region e.g. 'uw2', 'ew2' or 'gbl' for resources like IAM roles that have no region" +} + +variable "project" { + type = string + default = null + description = "ID element. A project identifier, indicating the name or role of the project the resource is for, such as `website` or `api`" +} +variable "stack" { + type = string + default = null + description = "ID element. The name of the stack/component, e.g. `database`, `web`, `waf`, `eks`" +} +variable "workspace" { + type = string + default = null + description = "ID element. The Terraform workspace, to help ensure generated IDs are unique across workspaces" +} +variable "environment" { + type = string + default = null + description = "ID element. Usually used to indicate role, e.g. 'prd', 'dev', 'test', 'preprod', 'prod', 'uat'" +} + +variable "name" { + type = string + default = null + description = <<-EOT + 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. + EOT +} + +variable "delimiter" { + type = string + default = null + description = <<-EOT + Delimiter to be used between ID elements. + Defaults to `-` (hyphen). Set to `""` to use no delimiter at all. + EOT +} + +variable "attributes" { + type = list(string) + default = [] + description = <<-EOT + 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. + EOT +} + +variable "labels_as_tags" { + type = set(string) + default = ["default"] + description = <<-EOT + 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. + EOT +} + +variable "tags" { + type = map(string) + default = {} + description = <<-EOT + Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`). + Neither the tag keys nor the tag values will be modified by this module. + EOT +} + +variable "additional_tag_map" { + type = map(string) + default = {} + description = <<-EOT + 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. + EOT +} + +variable "label_order" { + type = list(string) + default = null + description = <<-EOT + 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. + EOT +} + +variable "regex_replace_chars" { + type = string + default = null + description = <<-EOT + 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. + EOT +} + +variable "id_length_limit" { + type = number + default = null + description = <<-EOT + 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`. + EOT + validation { + condition = var.id_length_limit == null ? true : var.id_length_limit >= 6 || var.id_length_limit == 0 + error_message = "The id_length_limit must be >= 6 if supplied (not null), or 0 for unlimited length." + } +} + +variable "label_key_case" { + type = string + default = null + description = <<-EOT + 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`. + EOT + + validation { + condition = var.label_key_case == null ? true : contains(["lower", "title", "upper"], var.label_key_case) + error_message = "Allowed values: `lower`, `title`, `upper`." + } +} + +variable "label_value_case" { + type = string + default = null + description = <<-EOT + 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`. + EOT + + validation { + condition = var.label_value_case == null ? true : contains(["lower", "title", "upper", "none"], var.label_value_case) + error_message = "Allowed values: `lower`, `title`, `upper`, `none`." + } +} + +variable "descriptor_formats" { + type = any + default = {} + description = <<-EOT + 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). + EOT +} + +variable "owner" { + type = string + description = "The name and or NHS.net email address of the service owner" + default = "None" +} + +variable "tag_version" { + type = string + description = "Used to identify the tagging version in use" + default = "1.0" +} + +variable "data_classification" { + type = string + description = "Used to identify the data classification of the resource, e.g 1-5" + default = "n/a" + validation { + condition = contains(["n/a", "1", "2", "3", "4", "5"], var.data_classification) + error_message = "Data Classification must be \"n/a\" or between 1-5" + } +} + +variable "data_type" { + type = string + description = "The tag data_type" + default = "None" + validation { + condition = contains(["None", "PCD", "PID", "Anonymised", "UserAccount", "Audit"], var.data_type) + error_message = "Data Type must be one of None, PCD, PID, Anonymised, UserAccount, Audit" + } +} + + +variable "public_facing" { + type = bool + description = "Whether this resource is public facing" + default = false +} + +variable "service_category" { + type = string + description = "The tag service_category" + default = "n/a" + validation { + condition = contains(["n/a", "Bronze", "Silver", "Gold", "Platinum"], var.service_category) + error_message = "The Service Category must be one of n/a, Bronze, Silver, Gold, Platinum" + } +} +variable "on_off_pattern" { + type = string + description = "Used to turn resources on and off based on a time pattern" + default = "n/a" +} + +variable "application_role" { + type = string + description = "The role the application is performing" + default = "General" +} + +variable "tool" { + type = string + description = "The tool used to deploy the resource" + default = "Terraform" +} + +#### End of copy of screening-terraform-modules-aws/tags/variables.tf diff --git a/infrastructure/modules/acm/main.tf b/infrastructure/modules/acm/main.tf new file mode 100644 index 0000000..c9fb524 --- /dev/null +++ b/infrastructure/modules/acm/main.tf @@ -0,0 +1 @@ +# DAVEH diff --git a/infrastructure/modules/acm/outputs.tf b/infrastructure/modules/acm/outputs.tf new file mode 100644 index 0000000..c9fb524 --- /dev/null +++ b/infrastructure/modules/acm/outputs.tf @@ -0,0 +1 @@ +# DAVEH diff --git a/infrastructure/modules/acm/variables.tf b/infrastructure/modules/acm/variables.tf new file mode 100644 index 0000000..c9fb524 --- /dev/null +++ b/infrastructure/modules/acm/variables.tf @@ -0,0 +1 @@ +# DAVEH From a1adf33c44187351d9dc5335e5c7b398441421ff Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Thu, 4 Jun 2026 08:05:59 +0100 Subject: [PATCH 02/13] make .tool-versions sane --- .tool-versions | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.tool-versions b/.tool-versions index f7161f0..89dcfcb 100644 --- a/.tool-versions +++ b/.tool-versions @@ -8,7 +8,8 @@ vale 3.6.0 gitleaks 8.30.1 nodejs 24.16.0 - +# DAVEH: restore markdownlint directives if underlying problem not fixed + # ============================================================================== # The section below is reserved for Docker image versions. @@ -25,4 +26,3 @@ nodejs 24.16.0 # docker/koalaman/shellcheck latest@sha256:e40388688bae0fcffdddb7e4dea49b900c18933b452add0930654b2dea3e7d5c # SEE: https://hub.docker.com/r/koalaman/shellcheck/tags # docker/mstruebing/editorconfig-checker 2.7.1@sha256:dd3ca9ea50ef4518efe9be018d669ef9cf937f6bb5cfe2ef84ff2a620b5ddc24 # SEE: https://hub.docker.com/r/mstruebing/editorconfig-checker/tags # docker/sonarsource/sonar-scanner-cli 5.0.1@sha256:494ecc3b5b1ee1625bd377b3905c4284e4f0cc155cff397805a244dee1c7d575 # SEE: https://hub.docker.com/r/sonarsource/sonar-scanner-cli/tags - From 885d28d1946fb062adca4de42e69612ff3910bd4 Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Thu, 4 Jun 2026 08:21:14 +0100 Subject: [PATCH 03/13] initial acm instance --- infrastructure/modules/acm/main.tf | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/infrastructure/modules/acm/main.tf b/infrastructure/modules/acm/main.tf index c9fb524..44ca1da 100644 --- a/infrastructure/modules/acm/main.tf +++ b/infrastructure/modules/acm/main.tf @@ -1 +1,30 @@ # DAVEH + +module "acm" { + source = "terraform-aws-modules/acm/aws" + version = "~> 6.3.0" + + acm_certificate_domain_validation_options = DAVEH + certificate_transparency_logging_preference = DAVEH + create_certificate = DAVEH + create_route53_records = DAVEH + create_route53_records_only = DAVEH + distinct_domain_names = DAVEH + dns_ttl = DAVEH + domain_name = DAVEH + export = DAVEH + key_algorithm = DAVEH + private_authority_arn = DAVEH + region = DAVEH + subject_alternative_names = DAVEH + tags = module.this.tags + validate_certificate = DAVEH + validation_allow_overwrite_records = DAVEH + validation_method = DAVEH + validation_option = DAVEH + validation_record_fqdns = DAVEH + validation_timeout = DAVEH + wait_for_validation = DAVEH + zone_id = DAVEH + zones = DAVEH +} From a2028df508f586364f82870811eccf5070745434 Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Thu, 4 Jun 2026 08:43:38 +0100 Subject: [PATCH 04/13] initial list of outputs --- infrastructure/modules/acm/main.tf | 4 ++-- infrastructure/modules/acm/outputs.tf | 32 +++++++++++++++++++++++++++ 2 files changed, 34 insertions(+), 2 deletions(-) diff --git a/infrastructure/modules/acm/main.tf b/infrastructure/modules/acm/main.tf index 44ca1da..2e3a15e 100644 --- a/infrastructure/modules/acm/main.tf +++ b/infrastructure/modules/acm/main.tf @@ -6,7 +6,7 @@ module "acm" { acm_certificate_domain_validation_options = DAVEH certificate_transparency_logging_preference = DAVEH - create_certificate = DAVEH + create_certificate = module.this.enabled create_route53_records = DAVEH create_route53_records_only = DAVEH distinct_domain_names = DAVEH @@ -15,7 +15,7 @@ module "acm" { export = DAVEH key_algorithm = DAVEH private_authority_arn = DAVEH - region = DAVEH + region = module.this.region subject_alternative_names = DAVEH tags = module.this.tags validate_certificate = DAVEH diff --git a/infrastructure/modules/acm/outputs.tf b/infrastructure/modules/acm/outputs.tf index c9fb524..e043aea 100644 --- a/infrastructure/modules/acm/outputs.tf +++ b/infrastructure/modules/acm/outputs.tf @@ -1 +1,33 @@ # DAVEH + +output "acm_certificate_arn" { + description = "The ARN of the certificate." + value = module.acm.acm_certificate_arn +} + +output "acm_certificate_domain_validation_options" { + description = "A list of attributes to feed into other resources to complete certificate validation. Can have more than one element, e.g. if SANs are defined. Only set if DNS-validation was used." + value = module.acm.acm_certificate_domain_validation_options +} + +output "acm_certificate_status" { + description = "Status of the certificate." + value = module.acm.acm_certificate_status +} + +# DAVEH: don't want acm_certificate_validation_emails output? + +output "distinct_domain_names" { + description = "List of distinct domains names used for the validation." + value = module.acm.distinct_domain_names +} + +output "validation_domains" { + description = "List of distinct domain validation options. This is useful if subject alternative names contain wildcards." + value = module.acm.validation_domains +} + +output "validation_route53_record_fqdns" { + description = "List of FQDNs built using the zone domain and name." + value = module.acm.validation_route53_record_fqdns +} From 7b73f37bf9efe16a671fdfbf1b6dcc371301fc8a Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Thu, 4 Jun 2026 12:02:47 +0100 Subject: [PATCH 05/13] add header to main implementation file --- infrastructure/modules/acm/main.tf | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/infrastructure/modules/acm/main.tf b/infrastructure/modules/acm/main.tf index 2e3a15e..2f94f27 100644 --- a/infrastructure/modules/acm/main.tf +++ b/infrastructure/modules/acm/main.tf @@ -1,4 +1,13 @@ -# DAVEH +################################################################ +# AWS Certificate Manager (ACM) +# +# A thin wrapper around the terraform-aws-modules/acm/aws module, +# enforcing the following opinions: +# +# * new certificates are validated via DNS +# +# Tagging is derived from context.tf via module.this. +################################################################ module "acm" { source = "terraform-aws-modules/acm/aws" From 8d1d035ae2523c7d26f55eb723a4d23493a53900 Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Thu, 4 Jun 2026 15:43:21 +0100 Subject: [PATCH 06/13] validation parameters --- infrastructure/modules/acm/main.tf | 27 +++++++++++++---------- infrastructure/modules/acm/variables.tf | 29 +++++++++++++++++++++++++ 2 files changed, 45 insertions(+), 11 deletions(-) diff --git a/infrastructure/modules/acm/main.tf b/infrastructure/modules/acm/main.tf index 2f94f27..9e7e564 100644 --- a/infrastructure/modules/acm/main.tf +++ b/infrastructure/modules/acm/main.tf @@ -4,7 +4,7 @@ # A thin wrapper around the terraform-aws-modules/acm/aws module, # enforcing the following opinions: # -# * new certificates are validated via DNS +# * new certificates are validated via DNS, specifically via Route53 # # Tagging is derived from context.tf via module.this. ################################################################ @@ -13,11 +13,23 @@ module "acm" { source = "terraform-aws-modules/acm/aws" version = "~> 6.3.0" + create_certificate = module.this.enabled + validate_certificate = module.this.enabled + + create_route53_records = true + create_route53_records_only = false + + # ---------------------------------------------------------------- + # Validation: only DNS is supported, unless you have imported the certificate + # ---------------------------------------------------------------- + validation_method = var.validation_method + validation_allow_overwrite_records = var.validation_allow_overwrite_records + validation_timeout = var.validation_timeout + wait_for_validation = var.wait_for_validation + + # ---------------------------------------------------------------- acm_certificate_domain_validation_options = DAVEH certificate_transparency_logging_preference = DAVEH - create_certificate = module.this.enabled - create_route53_records = DAVEH - create_route53_records_only = DAVEH distinct_domain_names = DAVEH dns_ttl = DAVEH domain_name = DAVEH @@ -27,13 +39,6 @@ module "acm" { region = module.this.region subject_alternative_names = DAVEH tags = module.this.tags - validate_certificate = DAVEH - validation_allow_overwrite_records = DAVEH - validation_method = DAVEH - validation_option = DAVEH - validation_record_fqdns = DAVEH - validation_timeout = DAVEH - wait_for_validation = DAVEH zone_id = DAVEH zones = DAVEH } diff --git a/infrastructure/modules/acm/variables.tf b/infrastructure/modules/acm/variables.tf index c9fb524..5c95def 100644 --- a/infrastructure/modules/acm/variables.tf +++ b/infrastructure/modules/acm/variables.tf @@ -1 +1,30 @@ # DAVEH + +variable "validation_method" { + description = "Which method to use for validation. Only DNS is valid. This parameter must not be set for certificates that were imported into ACM and then into Terraform." + type = string + default = null + + validation { + condition = var.validation_method == null || var.validation_method == "DNS" + error_message = "validation_method must be null or \"DNS\"." + } +} + +variable "validation_allow_overwrite_records" { + description = "Whether to allow overwrite of Route53 records" + type = bool + default = true +} + +variable "validation_timeout" { + description = "Define maximum timeout to wait for the validation to complete" + type = string + default = null +} + +variable "wait_for_validation" { + description = "Whether to wait for the validation to complete" + type = bool + default = true +} From 2be04fa3961ab4782f2dfa8119b3f3dbacd87aab Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Thu, 4 Jun 2026 17:06:34 +0100 Subject: [PATCH 07/13] disable exporting certs --- infrastructure/modules/acm/main.tf | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/infrastructure/modules/acm/main.tf b/infrastructure/modules/acm/main.tf index 9e7e564..ea56158 100644 --- a/infrastructure/modules/acm/main.tf +++ b/infrastructure/modules/acm/main.tf @@ -5,6 +5,7 @@ # enforcing the following opinions: # # * new certificates are validated via DNS, specifically via Route53 +# * certificates cannot be exported # # Tagging is derived from context.tf via module.this. ################################################################ @@ -19,6 +20,9 @@ module "acm" { create_route53_records = true create_route53_records_only = false + certificate_transparency_logging_preference = true + export = "DISABLED" + # ---------------------------------------------------------------- # Validation: only DNS is supported, unless you have imported the certificate # ---------------------------------------------------------------- @@ -29,11 +33,8 @@ module "acm" { # ---------------------------------------------------------------- acm_certificate_domain_validation_options = DAVEH - certificate_transparency_logging_preference = DAVEH - distinct_domain_names = DAVEH dns_ttl = DAVEH domain_name = DAVEH - export = DAVEH key_algorithm = DAVEH private_authority_arn = DAVEH region = module.this.region From 6a7a0ded3e3a6b2c164c5ad0371e53ec53e27b43 Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Thu, 4 Jun 2026 17:17:21 +0100 Subject: [PATCH 08/13] actual domain names --- infrastructure/modules/acm/main.tf | 15 ++++++++------- infrastructure/modules/acm/variables.tf | 23 +++++++++++++++++++++++ 2 files changed, 31 insertions(+), 7 deletions(-) diff --git a/infrastructure/modules/acm/main.tf b/infrastructure/modules/acm/main.tf index ea56158..3603903 100644 --- a/infrastructure/modules/acm/main.tf +++ b/infrastructure/modules/acm/main.tf @@ -17,6 +17,9 @@ module "acm" { create_certificate = module.this.enabled validate_certificate = module.this.enabled + domain_name = var.domain_name + subject_alternative_names = var.subject_alternative_names + create_route53_records = true create_route53_records_only = false @@ -26,20 +29,18 @@ module "acm" { # ---------------------------------------------------------------- # Validation: only DNS is supported, unless you have imported the certificate # ---------------------------------------------------------------- - validation_method = var.validation_method + validation_method = var.validation_method validation_allow_overwrite_records = var.validation_allow_overwrite_records - validation_timeout = var.validation_timeout - wait_for_validation = var.wait_for_validation + validation_timeout = var.validation_timeout + wait_for_validation = var.wait_for_validation + zone_id = var.zone_id + zones = var.zones # ---------------------------------------------------------------- acm_certificate_domain_validation_options = DAVEH dns_ttl = DAVEH - domain_name = DAVEH key_algorithm = DAVEH private_authority_arn = DAVEH region = module.this.region - subject_alternative_names = DAVEH tags = module.this.tags - zone_id = DAVEH - zones = DAVEH } diff --git a/infrastructure/modules/acm/variables.tf b/infrastructure/modules/acm/variables.tf index 5c95def..e5b777b 100644 --- a/infrastructure/modules/acm/variables.tf +++ b/infrastructure/modules/acm/variables.tf @@ -28,3 +28,26 @@ variable "wait_for_validation" { type = bool default = true } + +variable "zone_id" { + description = "The ID of the hosted zone to contain this record, for validating via Route53." + type = string +} + +variable "zones" { + description = "Map containing the Route53 Zone IDs for additional domains." + type = map(string) + default = {} +} + +variable "domain_name" { + description = "A domain name for which the certificate should be issued" + type = string + default = "" +} + +variable "subject_alternative_names" { + description = "Additional domain names for which the certificate should be issued." + type = list(string) + default = [] +} From 53b9e55a3695d8491c8dda0d71b5257600593b2d Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Thu, 4 Jun 2026 17:24:38 +0100 Subject: [PATCH 09/13] probably finishes off the main bit of the module --- infrastructure/modules/acm/main.tf | 11 +++++------ infrastructure/modules/acm/variables.tf | 18 ++++++++++++++++++ 2 files changed, 23 insertions(+), 6 deletions(-) diff --git a/infrastructure/modules/acm/main.tf b/infrastructure/modules/acm/main.tf index 3603903..aa2ca8a 100644 --- a/infrastructure/modules/acm/main.tf +++ b/infrastructure/modules/acm/main.tf @@ -20,8 +20,8 @@ module "acm" { domain_name = var.domain_name subject_alternative_names = var.subject_alternative_names - create_route53_records = true - create_route53_records_only = false + key_algorithm = var.key_algorithm + private_authority_arn = var.private_authority_arn certificate_transparency_logging_preference = true export = "DISABLED" @@ -35,12 +35,11 @@ module "acm" { wait_for_validation = var.wait_for_validation zone_id = var.zone_id zones = var.zones + create_route53_records = true + create_route53_records_only = false + dns_ttl = var.dns_ttl # ---------------------------------------------------------------- - acm_certificate_domain_validation_options = DAVEH - dns_ttl = DAVEH - key_algorithm = DAVEH - private_authority_arn = DAVEH region = module.this.region tags = module.this.tags } diff --git a/infrastructure/modules/acm/variables.tf b/infrastructure/modules/acm/variables.tf index e5b777b..b58de38 100644 --- a/infrastructure/modules/acm/variables.tf +++ b/infrastructure/modules/acm/variables.tf @@ -51,3 +51,21 @@ variable "subject_alternative_names" { type = list(string) default = [] } + +variable "dns_ttl" { + description = "The TTL of DNS recursive resolvers to cache information about this record." + type = number + default = 60 +} + +variable "key_algorithm" { + description = "Specifies the algorithm of the public and private key pair that your Amazon issued certificate uses to encrypt data" + type = string + default = null +} + +variable "private_authority_arn" { + description = "Private Certificate Authority ARN for issuing private certificates" + type = string + default = null +} From 6d49d20482eadd3774737c10028f82209c636c9a Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Fri, 5 Jun 2026 08:09:31 +0100 Subject: [PATCH 10/13] autoformat --- infrastructure/modules/acm/main.tf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/infrastructure/modules/acm/main.tf b/infrastructure/modules/acm/main.tf index aa2ca8a..9707af1 100644 --- a/infrastructure/modules/acm/main.tf +++ b/infrastructure/modules/acm/main.tf @@ -41,5 +41,5 @@ module "acm" { # ---------------------------------------------------------------- region = module.this.region - tags = module.this.tags + tags = module.this.tags } From f3b14c632ec104f431cc279355aa8b4ca2be96dd Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Fri, 5 Jun 2026 08:13:35 +0100 Subject: [PATCH 11/13] rm obsolete todos --- .tool-versions | 2 -- infrastructure/modules/acm/outputs.tf | 4 ---- infrastructure/modules/acm/variables.tf | 2 -- 3 files changed, 8 deletions(-) diff --git a/.tool-versions b/.tool-versions index 89dcfcb..3cf3785 100644 --- a/.tool-versions +++ b/.tool-versions @@ -8,8 +8,6 @@ vale 3.6.0 gitleaks 8.30.1 nodejs 24.16.0 -# DAVEH: restore markdownlint directives if underlying problem not fixed - # ============================================================================== # The section below is reserved for Docker image versions. diff --git a/infrastructure/modules/acm/outputs.tf b/infrastructure/modules/acm/outputs.tf index e043aea..9a5d7de 100644 --- a/infrastructure/modules/acm/outputs.tf +++ b/infrastructure/modules/acm/outputs.tf @@ -1,5 +1,3 @@ -# DAVEH - output "acm_certificate_arn" { description = "The ARN of the certificate." value = module.acm.acm_certificate_arn @@ -15,8 +13,6 @@ output "acm_certificate_status" { value = module.acm.acm_certificate_status } -# DAVEH: don't want acm_certificate_validation_emails output? - output "distinct_domain_names" { description = "List of distinct domains names used for the validation." value = module.acm.distinct_domain_names diff --git a/infrastructure/modules/acm/variables.tf b/infrastructure/modules/acm/variables.tf index b58de38..a151f78 100644 --- a/infrastructure/modules/acm/variables.tf +++ b/infrastructure/modules/acm/variables.tf @@ -1,5 +1,3 @@ -# DAVEH - variable "validation_method" { description = "Which method to use for validation. Only DNS is valid. This parameter must not be set for certificates that were imported into ACM and then into Terraform." type = string From 994a5af0195a05c4515bb8eb5b487bd93f5b5461 Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Fri, 5 Jun 2026 08:24:12 +0100 Subject: [PATCH 12/13] sketch readme --- infrastructure/modules/acm/README.md | 34 +++++++++++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/infrastructure/modules/acm/README.md b/infrastructure/modules/acm/README.md index c9fb524..50ef511 100644 --- a/infrastructure/modules/acm/README.md +++ b/infrastructure/modules/acm/README.md @@ -1 +1,33 @@ -# DAVEH +# AWS Certificate Manager (ACM) + +NHS Screening wrapper around the community +[`terraform-aws-modules/acm/aws`](https://registry.terraform.io/modules/terraform-aws-modules/acm/aws/latest) +module that enforces the platform's baseline controls and consumes +the shared `context.tf` for naming and tagging. + +## What this module enforces + +| Control | How it is enforced | +| ------------------------ | --------------------------------------------------------------------------------- | + +DAVEH + +## Usage + +DAVEH + +## Conventions + +DAVEH + +## What this module does NOT do + +DAVEH + + + + +DAVEH + + + From 1e535589ba13d69f74a594fbdd04a81ba0518312 Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Fri, 5 Jun 2026 09:03:39 +0100 Subject: [PATCH 13/13] autogen docs --- infrastructure/modules/acm/README.md | 154 +++++++++++++++++++++++++-- 1 file changed, 148 insertions(+), 6 deletions(-) diff --git a/infrastructure/modules/acm/README.md b/infrastructure/modules/acm/README.md index 50ef511..de03c10 100644 --- a/infrastructure/modules/acm/README.md +++ b/infrastructure/modules/acm/README.md @@ -9,25 +9,167 @@ the shared `context.tf` for naming and tagging. | Control | How it is enforced | | ------------------------ | --------------------------------------------------------------------------------- | - -DAVEH +| Validation method | DNS validation via Route53 only (`create_route53_records = true`) | +| Export controls | Certificate export is disabled (`export = "DISABLED"`) | +| Certificate transparency | CT logging is always enabled (`certificate_transparency_logging_preference=true`) | +| Tagging and naming | Uses shared `context.tf` (`module.this`) for tags and region conventions | +| Resource enable/disable | Creation/validation gated by `module.this.enabled` | ## Usage -DAVEH +### Minimal public certificate (single hosted zone) + +```hcl +module "acm" { + source = "git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/acm?ref=main" + + service = "bcss" + project = "portal" + environment = "prod" + name = "frontend-cert" + + domain_name = "screening.example.nhs.uk" + zone_id = "Z0123456789ABCDEF" +} +``` + +### Certificate with SANs across multiple Route53 zones + +```hcl +module "acm" { + source = "git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/acm?ref=main" + + service = "bcss" + project = "platform" + environment = "prod" + name = "shared-cert" + + domain_name = "api.example.nhs.uk" + subject_alternative_names = [ + "*.example.nhs.uk", + "*.service.example.com" + ] + + zone_id = "Z0123456789ABCDEF" + zones = { + "service.example.com" = "Z0FEDCBA987654321" + } +} +``` + +### Private certificate signed by ACM PCA + +```hcl +module "acm_private" { + source = "git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/acm?ref=main" + + service = "bcss" + project = "internal" + environment = "prod" + name = "internal-cert" + + domain_name = "internal.screening.nhs.uk" + zone_id = "Z0123456789ABCDEF" + private_authority_arn = "arn:aws:acm-pca:eu-west-2:123456789012:certificate-authority/abcd-1234-efgh-5678" +} +``` ## Conventions -DAVEH +* `zone_id` is required because this wrapper always creates DNS validation + records in Route53. +* `validation_allow_overwrite_records` defaults to `true` so renewals and + re-issues can update existing validation records without manual cleanup. +* `wait_for_validation` defaults to `true`; set it to `false` only if your + delivery pipeline validates certificates asynchronously. +* `validation_method` is restricted to `DNS` (or `null` when not explicitly + set), aligning with platform policy. ## What this module does NOT do -DAVEH +* Support email validation. +* Allow exporting certificate private keys. +* Create or manage Route53 hosted zones; you must provide existing zone IDs. -DAVEH +## Requirements + +No requirements. + +## Providers + +No providers. + +## Modules + +| Name | Source | Version | +| ---- | ------ | ------- | +| [acm](#module\_acm) | terraform-aws-modules/acm/aws | ~> 6.3.0 | +| [this](#module\_this) | git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/tags | v2.6.0 | + +## Resources + +No resources. + +## 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 | +| [application\_role](#input\_application\_role) | The role the application is performing | `string` | `"General"` | 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 | +| [aws\_region](#input\_aws\_region) | The AWS region | `string` | `"eu-west-2"` | 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,
  "project": null,
  "regex_replace_chars": null,
  "region": null,
  "service": null,
  "stack": null,
  "tags": {},
  "terraform_source": null,
  "workspace": null
}
| no | +| [data\_classification](#input\_data\_classification) | Used to identify the data classification of the resource, e.g 1-5 | `string` | `"n/a"` | no | +| [data\_type](#input\_data\_type) | The tag data\_type | `string` | `"None"` | 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 | +| [dns\_ttl](#input\_dns\_ttl) | The TTL of DNS recursive resolvers to cache information about this record. | `number` | `60` | no | +| [domain\_name](#input\_domain\_name) | A domain name for which the certificate should be issued | `string` | `""` | no | +| [enabled](#input\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no | +| [environment](#input\_environment) | ID element. Usually used to indicate role, e.g. 'prd', 'dev', 'test', 'preprod', 'prod', 'uat' | `string` | `null` | 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 | +| [key\_algorithm](#input\_key\_algorithm) | Specifies the algorithm of the public and private key pair that your Amazon issued certificate uses to encrypt data | `string` | `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 | +| [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 | +| [on\_off\_pattern](#input\_on\_off\_pattern) | Used to turn resources on and off based on a time pattern | `string` | `"n/a"` | no | +| [owner](#input\_owner) | The name and or NHS.net email address of the service owner | `string` | `"None"` | no | +| [private\_authority\_arn](#input\_private\_authority\_arn) | Private Certificate Authority ARN for issuing private certificates | `string` | `null` | no | +| [project](#input\_project) | ID element. A project identifier, indicating the name or role of the project the resource is for, such as `website` or `api` | `string` | `null` | no | +| [public\_facing](#input\_public\_facing) | Whether this resource is public facing | `bool` | `false` | 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 | +| [region](#input\_region) | ID element \_(Rarely used, not included by default)\_. Usually an abbreviation of the selected AWS region e.g. 'uw2', 'ew2' or 'gbl' for resources like IAM roles that have no region | `string` | `null` | no | +| [service](#input\_service) | ID element. Usually an abbreviation of your service directorate name, e.g. 'bcss' or 'csms', to help ensure generated IDs are globally unique | `string` | `null` | no | +| [service\_category](#input\_service\_category) | The tag service\_category | `string` | `"n/a"` | no | +| [stack](#input\_stack) | ID element. The name of the stack/component, e.g. `database`, `web`, `waf`, `eks` | `string` | `null` | no | +| [subject\_alternative\_names](#input\_subject\_alternative\_names) | Additional domain names for which the certificate should be issued. | `list(string)` | `[]` | no | +| [tag\_version](#input\_tag\_version) | Used to identify the tagging version in use | `string` | `"1.0"` | 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 | +| [terraform\_source](#input\_terraform\_source) | Source location to record in the Terraform\_source tag. Defaults to the caller module path when not set. | `string` | `null` | no | +| [tool](#input\_tool) | The tool used to deploy the resource | `string` | `"Terraform"` | no | +| [validation\_allow\_overwrite\_records](#input\_validation\_allow\_overwrite\_records) | Whether to allow overwrite of Route53 records | `bool` | `true` | no | +| [validation\_method](#input\_validation\_method) | Which method to use for validation. Only DNS is valid. This parameter must not be set for certificates that were imported into ACM and then into Terraform. | `string` | `null` | no | +| [validation\_timeout](#input\_validation\_timeout) | Define maximum timeout to wait for the validation to complete | `string` | `null` | no | +| [wait\_for\_validation](#input\_wait\_for\_validation) | Whether to wait for the validation to complete | `bool` | `true` | no | +| [workspace](#input\_workspace) | ID element. The Terraform workspace, to help ensure generated IDs are unique across workspaces | `string` | `null` | no | +| [zone\_id](#input\_zone\_id) | The ID of the hosted zone to contain this record, for validating via Route53. | `string` | n/a | yes | +| [zones](#input\_zones) | Map containing the Route53 Zone IDs for additional domains. | `map(string)` | `{}` | no | + +## Outputs + +| Name | Description | +| ---- | ----------- | +| [acm\_certificate\_arn](#output\_acm\_certificate\_arn) | The ARN of the certificate. | +| [acm\_certificate\_domain\_validation\_options](#output\_acm\_certificate\_domain\_validation\_options) | A list of attributes to feed into other resources to complete certificate validation. Can have more than one element, e.g. if SANs are defined. Only set if DNS-validation was used. | +| [acm\_certificate\_status](#output\_acm\_certificate\_status) | Status of the certificate. | +| [distinct\_domain\_names](#output\_distinct\_domain\_names) | List of distinct domains names used for the validation. | +| [validation\_domains](#output\_validation\_domains) | List of distinct domain validation options. This is useful if subject alternative names contain wildcards. | +| [validation\_route53\_record\_fqdns](#output\_validation\_route53\_record\_fqdns) | List of FQDNs built using the zone domain and name. |