From a8cb20fea5a68c637989b7c2838856b4542f613b Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Wed, 10 Jun 2026 08:14:55 +0100 Subject: [PATCH 01/11] rm markdownlint tags from .tool-versions --- .tool-versions | 2 -- 1 file changed, 2 deletions(-) diff --git a/.tool-versions b/.tool-versions index f7161f0..3cf3785 100644 --- a/.tool-versions +++ b/.tool-versions @@ -8,7 +8,6 @@ vale 3.6.0 gitleaks 8.30.1 nodejs 24.16.0 - # ============================================================================== # The section below is reserved for Docker image versions. @@ -25,4 +24,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 2fc5aece43b79ee1bbbf597efc3d227eed69ca8b Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Wed, 10 Jun 2026 08:34:02 +0100 Subject: [PATCH 02/11] initial skeleton --- .../modules/security-group/README.md | 1 + .../modules/security-group/context.tf | 374 ++++++++++++++++++ infrastructure/modules/security-group/main.tf | 14 + 3 files changed, 389 insertions(+) create mode 100644 infrastructure/modules/security-group/README.md create mode 100644 infrastructure/modules/security-group/context.tf create mode 100644 infrastructure/modules/security-group/main.tf diff --git a/infrastructure/modules/security-group/README.md b/infrastructure/modules/security-group/README.md new file mode 100644 index 0000000..c9fb524 --- /dev/null +++ b/infrastructure/modules/security-group/README.md @@ -0,0 +1 @@ +# DAVEH diff --git a/infrastructure/modules/security-group/context.tf b/infrastructure/modules/security-group/context.tf new file mode 100644 index 0000000..e1afea7 --- /dev/null +++ b/infrastructure/modules/security-group/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 = "../tags" + + 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/security-group/main.tf b/infrastructure/modules/security-group/main.tf new file mode 100644 index 0000000..7414649 --- /dev/null +++ b/infrastructure/modules/security-group/main.tf @@ -0,0 +1,14 @@ +module "security_group" { + source = "terraform-aws-modules/security-group/aws" + + create = module.this.enabled + name = module.this.id + tags = module.this.tags + + description = null # DAVEH + + vpc_id = null # DAVEH + + egress_rules = {} # DAVEH + ingress_rules = {} # DAVEH +} From fb2ea49953dbf01549d5960d193e39f356ebcbf5 Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Wed, 10 Jun 2026 08:48:47 +0100 Subject: [PATCH 03/11] input variables --- infrastructure/modules/security-group/main.tf | 12 ++--- .../modules/security-group/variables.tf | 52 +++++++++++++++++++ 2 files changed, 58 insertions(+), 6 deletions(-) create mode 100644 infrastructure/modules/security-group/variables.tf diff --git a/infrastructure/modules/security-group/main.tf b/infrastructure/modules/security-group/main.tf index 7414649..9c1de78 100644 --- a/infrastructure/modules/security-group/main.tf +++ b/infrastructure/modules/security-group/main.tf @@ -2,13 +2,13 @@ module "security_group" { source = "terraform-aws-modules/security-group/aws" create = module.this.enabled - name = module.this.id - tags = module.this.tags + name = module.this.id + tags = module.this.tags - description = null # DAVEH + description = var.description - vpc_id = null # DAVEH + vpc_id = var.vpc_id - egress_rules = {} # DAVEH - ingress_rules = {} # DAVEH + egress_rules = var.egress_rules + ingress_rules = var.ingress_rules } diff --git a/infrastructure/modules/security-group/variables.tf b/infrastructure/modules/security-group/variables.tf new file mode 100644 index 0000000..900333c --- /dev/null +++ b/infrastructure/modules/security-group/variables.tf @@ -0,0 +1,52 @@ +################################################################ +# Security group-specific inputs. +# +# Naming, tagging and the master `enabled` switch come from +# context.tf via `module.this`. +################################################################ + +variable "description" { + description = "Description for the security group" + type = string + default = null +} + +variable "vpc_id" { + description = "ID of the VPC where the security group is created" + type = string + default = null +} + +variable "egress_rules" { + description = "Map of egress rules to add to the security group" + type = map(object({ + name = optional(string) + cidr_ipv4 = optional(string) + cidr_ipv6 = optional(string) + description = optional(string) + from_port = optional(number) + ip_protocol = optional(string, "tcp") + prefix_list_id = optional(string) + referenced_security_group_id = optional(string) + tags = optional(map(string), {}) + to_port = optional(number) + })) + default = {} +} + +variable "ingress_rules" { + description = "Map of ingress rules to add to the security group" + type = map(object({ + name = optional(string) + cidr_ipv4 = optional(string) + cidr_ipv6 = optional(string) + description = optional(string) + from_port = optional(number) + ip_protocol = optional(string, "tcp") + prefix_list_id = optional(string) + referenced_security_group_id = optional(string) + tags = optional(map(string), {}) + to_port = optional(number) + })) + default = {} +} From 7916ac6a1e9efdd8b12898ecea00aa948bb57b11 Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Wed, 10 Jun 2026 08:57:25 +0100 Subject: [PATCH 04/11] outputs --- .../modules/security-group/outputs.tf | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 infrastructure/modules/security-group/outputs.tf diff --git a/infrastructure/modules/security-group/outputs.tf b/infrastructure/modules/security-group/outputs.tf new file mode 100644 index 0000000..4367112 --- /dev/null +++ b/infrastructure/modules/security-group/outputs.tf @@ -0,0 +1,24 @@ +output "security_group_arn" { + description = "The ARN of the security group" + value = module.security_group.arn +} + +output "security_group_id" { + description = "The ID of the security group" + value = module.security_group.id +} + +output "security_group_name" { + description = "The name of the security group" + value = module.security_group.name +} + +output "security_group_owner_id" { + description = "The owner ID" + value = module.security_group.owner_id +} + +output "security_group_vpc_id" { + description = "The ID of the VPC used by the security group" + value = module.security_group.vpc_id +} From 111c39507c2869f9f021c2c2627f39c6d8c6d662 Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Wed, 10 Jun 2026 09:09:38 +0100 Subject: [PATCH 05/11] autogen docs --- .../modules/security-group/README.md | 75 +++++++++++++++++++ 1 file changed, 75 insertions(+) diff --git a/infrastructure/modules/security-group/README.md b/infrastructure/modules/security-group/README.md index c9fb524..344d9b3 100644 --- a/infrastructure/modules/security-group/README.md +++ b/infrastructure/modules/security-group/README.md @@ -1 +1,76 @@ # DAVEH + + + + +## Requirements + +No requirements. + +## Providers + +No providers. + +## Modules + +| Name | Source | Version | +| ---- | ------ | ------- | +| [security\_group](#module\_security\_group) | terraform-aws-modules/security-group/aws | n/a | +| [this](#module\_this) | ../tags | n/a | + +## 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 | +| [description](#input\_description) | Description for the security group | `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 | +| [egress\_rules](#input\_egress\_rules) | Map of egress rules to add to the security group | 
map(object({
    name                         = optional(string)
    cidr_ipv4                    = optional(string)
    cidr_ipv6                    = optional(string)
    description                  = optional(string)
    from_port                    = optional(number)
    ip_protocol                  = optional(string, "tcp")
    prefix_list_id               = optional(string)
    referenced_security_group_id = optional(string)
    tags                         = optional(map(string), {})
    to_port                      = optional(number)
  }))
| `{}` | 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 | +| [ingress\_rules](#input\_ingress\_rules) | Map of ingress rules to add to the security group | 
map(object({
    name                         = optional(string)
    cidr_ipv4                    = optional(string)
    cidr_ipv6                    = optional(string)
    description                  = optional(string)
    from_port                    = optional(number)
    ip_protocol                  = optional(string, "tcp")
    prefix_list_id               = optional(string)
    referenced_security_group_id = optional(string)
    tags                         = optional(map(string), {})
    to_port                      = optional(number)
  }))
| `{}` | 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 | +| [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 | +| [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 | +| [vpc\_id](#input\_vpc\_id) | ID of the VPC where the security group is created | `string` | `null` | no | +| [workspace](#input\_workspace) | ID element. The Terraform workspace, to help ensure generated IDs are unique across workspaces | `string` | `null` | no | + +## Outputs + +| Name | Description | +| ---- | ----------- | +| [security\_group\_arn](#output\_security\_group\_arn) | The ARN of the security group | +| [security\_group\_id](#output\_security\_group\_id) | The ID of the security group | +| [security\_group\_name](#output\_security\_group\_name) | The name of the security group | +| [security\_group\_owner\_id](#output\_security\_group\_owner\_id) | The owner ID | +| [security\_group\_vpc\_id](#output\_security\_group\_vpc\_id) | The ID of the VPC used by the security group | + + + From a0e82f4eccbb1c69a2d8838dc873b0217bda460d Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Wed, 10 Jun 2026 11:08:00 +0100 Subject: [PATCH 06/11] draft remaining docs --- .../modules/security-group/README.md | 109 +++++++++++++++++- 1 file changed, 108 insertions(+), 1 deletion(-) diff --git a/infrastructure/modules/security-group/README.md b/infrastructure/modules/security-group/README.md index 344d9b3..0fe868a 100644 --- a/infrastructure/modules/security-group/README.md +++ b/infrastructure/modules/security-group/README.md @@ -1,4 +1,111 @@ -# DAVEH +# Security-Group + +NHS Screening wrapper around the community +[`terraform-aws-modules/security-group/aws`][1] +module that consumes the shared `context.tf` for naming and tagging. + +[1]: https://registry.terraform.io/modules/terraform-aws-modules/security-group/aws/latest + +DAVEH: check docs for accuracy + +## What this module enforces + +| Control | How it is enforced | +| ---------------------------------- | ---------------------------------------------------------------------- | +| Consistent naming and tagging | `name = module.this.id` and `tags = module.this.tags` | +| Central `enabled` switch | `create = module.this.enabled` | +| VPC scoping | `vpc_id` is explicitly forwarded to the upstream module | +| Caller-defined traffic policy only | `ingress_rules` and `egress_rules` are passed through without mutation | + +## Usage + +### Minimal: create a security group in a VPC + +```hcl +module "app_sg" { + source = "git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/security-group?ref=main" + + service = "bcss" + project = "api" + environment = "prod" + name = "app" + + description = "Security group for the screening API" + vpc_id = module.vpc.vpc_id +} +``` + +### Ingress from a load balancer security group + +```hcl +module "app_sg" { + source = "git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/security-group?ref=main" + + service = "bcss" + project = "api" + environment = "prod" + name = "app" + + description = "Only allow HTTPS from the ALB" + vpc_id = module.vpc.vpc_id + + ingress_rules = { + alb_https = { + ip_protocol = "tcp" + from_port = 443 + to_port = 443 + referenced_security_group_id = module.alb_sg.security_group_id + description = "HTTPS from ALB" + } + } +} +``` + +### Restrict egress to HTTPS only + +```hcl +module "app_sg" { + source = "git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/security-group?ref=main" + + service = "bcss" + project = "api" + environment = "prod" + name = "app" + + description = "Limit outbound traffic to HTTPS" + vpc_id = module.vpc.vpc_id + + egress_rules = { + https_out = { + ip_protocol = "tcp" + from_port = 443 + to_port = 443 + cidr_ipv4 = "0.0.0.0/0" + description = "HTTPS egress only" + } + } +} +``` + +## Conventions + +* Keep `ingress_rules` and `egress_rules` keys stable (for example `alb_https`, + `db_5432`) so Terraform can track rule resources predictably over time. +* Prefer `referenced_security_group_id` over broad CIDR ranges when traffic is + between AWS-managed components. +* Set `description` to explain intent, not just protocol/port, so operators can + understand why a rule exists from the AWS console. +* Use `context.enabled = false` to disable creation in environments where the + security group is not required. + +## What this module does NOT do + +* Create or manage the VPC itself. Pass an existing VPC ID via `vpc_id`. +* Infer or inject platform-standard ingress/egress rules. All traffic policy is + caller-defined. +* Attach network ACLs, route tables, WAFs, or firewall policies. +* Manage references from compute resources (ECS services, Lambdas, RDS, etc.) + to this security group. Consumers must wire those associations directly. From 27a19758b6fe0942c05d6b89eaf3581fb42f328b Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Wed, 10 Jun 2026 13:10:31 +0100 Subject: [PATCH 07/11] clarify what a missing vpc_id means --- infrastructure/modules/security-group/README.md | 3 ++- infrastructure/modules/security-group/variables.tf | 2 +- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/infrastructure/modules/security-group/README.md b/infrastructure/modules/security-group/README.md index 0fe868a..77146a1 100644 --- a/infrastructure/modules/security-group/README.md +++ b/infrastructure/modules/security-group/README.md @@ -100,7 +100,8 @@ module "app_sg" { ## What this module does NOT do -* Create or manage the VPC itself. Pass an existing VPC ID via `vpc_id`. +* Create or manage the VPC itself. Pass an existing VPC ID via `vpc_id`, or + leave as the default `null` to use the region's default VPC. * Infer or inject platform-standard ingress/egress rules. All traffic policy is caller-defined. * Attach network ACLs, route tables, WAFs, or firewall policies. diff --git a/infrastructure/modules/security-group/variables.tf b/infrastructure/modules/security-group/variables.tf index 900333c..30c48b5 100644 --- a/infrastructure/modules/security-group/variables.tf +++ b/infrastructure/modules/security-group/variables.tf @@ -12,7 +12,7 @@ variable "description" { } variable "vpc_id" { - description = "ID of the VPC where the security group is created" + description = "ID of the VPC where the security group is created; defaults to the region's default VPC" type = string default = null } From 9d5a2c7fdb4d8938d9f98b919e768348fdc33cdf Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Wed, 10 Jun 2026 13:23:52 +0100 Subject: [PATCH 08/11] set version --- infrastructure/modules/security-group/README.md | 1 - infrastructure/modules/security-group/main.tf | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/infrastructure/modules/security-group/README.md b/infrastructure/modules/security-group/README.md index 77146a1..6e87fcb 100644 --- a/infrastructure/modules/security-group/README.md +++ b/infrastructure/modules/security-group/README.md @@ -14,7 +14,6 @@ DAVEH: check docs for accuracy | ---------------------------------- | ---------------------------------------------------------------------- | | Consistent naming and tagging | `name = module.this.id` and `tags = module.this.tags` | | Central `enabled` switch | `create = module.this.enabled` | -| VPC scoping | `vpc_id` is explicitly forwarded to the upstream module | | Caller-defined traffic policy only | `ingress_rules` and `egress_rules` are passed through without mutation | ## Usage diff --git a/infrastructure/modules/security-group/main.tf b/infrastructure/modules/security-group/main.tf index 9c1de78..ccec1e5 100644 --- a/infrastructure/modules/security-group/main.tf +++ b/infrastructure/modules/security-group/main.tf @@ -1,5 +1,6 @@ module "security_group" { source = "terraform-aws-modules/security-group/aws" + version = "6.0.0" create = module.this.enabled name = module.this.id From dfbae74ceda41220e946ffc3e79e923d31fef131 Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Wed, 10 Jun 2026 13:29:54 +0100 Subject: [PATCH 09/11] add example for `referenced_security_group_id = "self"` --- .../modules/security-group/README.md | 23 +++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/infrastructure/modules/security-group/README.md b/infrastructure/modules/security-group/README.md index 6e87fcb..da162d9 100644 --- a/infrastructure/modules/security-group/README.md +++ b/infrastructure/modules/security-group/README.md @@ -34,6 +34,29 @@ module "app_sg" { } ``` +### Allow traffic between members of the security group + +```hcl +module "app_sg" { + source = "git::https://github.com/NHSDigital/screening-terraform-modules-aws.git//infrastructure/modules/security-group?ref=main" + + service = "bcss" + project = "api" + environment = "prod" + name = "app" + + description = "Security group for the screening API" + vpc_id = module.vpc.vpc_id + + ingress_rules = { + self-all = { + ip_protocol = "-1" + referenced_security_group_id = "self" # rewritten to the security group's own id at apply time + description = "All traffic from members of this SG" + } + } +``` + ### Ingress from a load balancer security group ```hcl From 6631fc601d8ed5081d9e5851336f5c96433b8d69 Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Wed, 10 Jun 2026 13:32:41 +0100 Subject: [PATCH 10/11] note on name suffix --- infrastructure/modules/security-group/README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/infrastructure/modules/security-group/README.md b/infrastructure/modules/security-group/README.md index da162d9..b892b74 100644 --- a/infrastructure/modules/security-group/README.md +++ b/infrastructure/modules/security-group/README.md @@ -6,7 +6,9 @@ module that consumes the shared `context.tf` for naming and tagging. [1]: https://registry.terraform.io/modules/terraform-aws-modules/security-group/aws/latest -DAVEH: check docs for accuracy +The name of the security group will have a random suffix. This enables +replacements to happen without dropping traffic, as terraform can create +the replacement before destroying the original. ## What this module enforces From d51109ef08dfefabe089a0dedfb07d2fac048971 Mon Sep 17 00:00:00 2001 From: Dave Hinton Date: Wed, 10 Jun 2026 14:23:34 +0100 Subject: [PATCH 11/11] autoformat --- infrastructure/modules/security-group/main.tf | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/infrastructure/modules/security-group/main.tf b/infrastructure/modules/security-group/main.tf index ccec1e5..8704d82 100644 --- a/infrastructure/modules/security-group/main.tf +++ b/infrastructure/modules/security-group/main.tf @@ -1,5 +1,5 @@ module "security_group" { - source = "terraform-aws-modules/security-group/aws" + source = "terraform-aws-modules/security-group/aws" version = "6.0.0" create = module.this.enabled