CCM-9648: sandbox resource naming - use module (#402)

Author: alexnuttall

infrastructure/terraform/components/app/module_backend_api.tf

@@ -5,6 +5,7 @@ module "backend_api" {
 
   project               = var.project
   environment           = var.environment
+  component             = var.component
   aws_account_id        = var.aws_account_id
   region                = var.region
   group                 = var.group

infrastructure/terraform/components/sandbox/README.md

@@ -10,7 +10,7 @@ No requirements.
 | Name | Description | Type | Default | Required |
 |------|-------------|------|---------|:--------:|
 | <a name="input_aws_account_id"></a> [aws\_account\_id](#input\_aws\_account\_id) | The AWS Account ID (numeric) | `string` | n/a | yes |
-| <a name="input_component"></a> [component](#input\_component) | The variable encapsulating the name of this component | `string` | `"sandbox"` | no |
+| <a name="input_component"></a> [component](#input\_component) | The variable encapsulating the name of this component | `string` | `"sbx"` | no |
 | <a name="input_default_tags"></a> [default\_tags](#input\_default\_tags) | A map of default tags to apply to all taggable resources within the component | `map(string)` | `{}` | no |
 | <a name="input_environment"></a> [environment](#input\_environment) | The name of the tfscaffold environment | `string` | n/a | yes |
 | <a name="input_group"></a> [group](#input\_group) | The group variables are being inherited from (often synonymous with account short-name) | `string` | n/a | yes |

infrastructure/terraform/components/sandbox/module_backend_api.tf

@@ -3,6 +3,7 @@ module "backend_api" {
 
   project               = var.project
   environment           = var.environment
+  component             = var.component
   aws_account_id        = var.aws_account_id
   region                = var.region
   group                 = var.group

infrastructure/terraform/components/sandbox/variables.tf

@@ -38,7 +38,7 @@ variable "group" {
 variable "component" {
   type        = string
   description = "The variable encapsulating the name of this component"
-  default     = "sandbox"
+  default     = "sbx"
 }
 
 variable "default_tags" {

infrastructure/terraform/modules/backend-api/README.md

@@ -11,7 +11,7 @@ No requirements.
 |------|-------------|------|---------|:--------:|
 | <a name="input_aws_account_id"></a> [aws\_account\_id](#input\_aws\_account\_id) | The AWS Account ID (numeric) | `string` | n/a | yes |
 | <a name="input_cognito_config"></a> [cognito\_config](#input\_cognito\_config) | Cognito config | <pre>object({<br/>    USER_POOL_ID : string,<br/>    USER_POOL_CLIENT_ID : string<br/>  })</pre> | n/a | yes |
-| <a name="input_component"></a> [component](#input\_component) | The variable encapsulating the name of this component | `string` | `"api"` | no |
+| <a name="input_component"></a> [component](#input\_component) | The variable encapsulating the name of this component | `string` | n/a | yes |
 | <a name="input_csi"></a> [csi](#input\_csi) | CSI from the parent component | `string` | n/a | yes |
 | <a name="input_dynamodb_kms_key_arn"></a> [dynamodb\_kms\_key\_arn](#input\_dynamodb\_kms\_key\_arn) | KMS Key ARN for encrypting DynamoDB data. If not given, a key will be created. | `string` | `""` | no |
 | <a name="input_enable_backup"></a> [enable\_backup](#input\_enable\_backup) | Enable Backups for the DynamoDB table? | `bool` | `true` | no |
@@ -20,6 +20,7 @@ No requirements.
 | <a name="input_group"></a> [group](#input\_group) | The group variables are being inherited from (often synonmous with account short-name) | `string` | n/a | yes |
 | <a name="input_kms_key_arn"></a> [kms\_key\_arn](#input\_kms\_key\_arn) | KMS Key ARN | `string` | n/a | yes |
 | <a name="input_log_retention_in_days"></a> [log\_retention\_in\_days](#input\_log\_retention\_in\_days) | The retention period in days for the Cloudwatch Logs events to be retained, default of 0 is indefinite | `number` | `0` | no |
+| <a name="input_module"></a> [module](#input\_module) | The variable encapsulating the name of this module | `string` | `"api"` | no |
 | <a name="input_project"></a> [project](#input\_project) | The name of the tfscaffold project | `string` | n/a | yes |
 | <a name="input_region"></a> [region](#input\_region) | The AWS Region | `string` | n/a | yes |
 ## Modules

infrastructure/terraform/modules/backend-api/locals.tf

@@ -1,5 +1,5 @@
 locals {
-  csi = "${var.csi}-${var.component}"
+  csi = "${var.csi}-${var.module}"
 
   lambdas_source_code_dir = abspath("${path.module}/../../../../lambdas")
 

infrastructure/terraform/modules/backend-api/variables.tf

@@ -12,6 +12,11 @@ variable "environment" {
   description = "The name of the tfscaffold environment"
 }
 
+variable "component" {
+  type        = string
+  description = "The variable encapsulating the name of this component"
+}
+
 variable "aws_account_id" {
   type        = string
   description = "The AWS Account ID (numeric)"
@@ -32,9 +37,9 @@ variable "group" {
 # tfscaffold variables specific to this component
 ##
 
-variable "component" {
+variable "module" {
   type        = string
-  description = "The variable encapsulating the name of this component"
+  description = "The variable encapsulating the name of this module"
   default     = "api"
 }