refa: renamed VPC ID variable

Author: creed-braton

README.md

@@ -29,7 +29,7 @@ This module provides a PostgreSQL RDS instance, an optional RDS proxy and a Secr
 | instance_class      | The instance class of the RDS instance. Must be one of the [supported RDS instance classes](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Concepts.DBInstanceClass.html).                                                                  | `string`       | "db.t3.micro"              |    no    |
 | engine_version      | The PostgreSQL engine version for the RDS instance. Must be one of the [supported RDS postgres engine versions](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/CHAP_PostgreSQL.html#PostgreSQL.Concepts.General.FeatureSupport.Extensions). | `string`       | "16.1"                     |    no    |
 | allocated_storage   | Storage capacity of the RDS instance in GigiBytes.                                                                                                                                                                                                  | `number`       | 20                         |    no    |
-| vpc_id              | ID of the subnets' VPC.                                                                                                                                                                                                                             | `string`       | n/a                        |   yes    |
+| vpc                 | ID of the subnets' VPC.                                                                                                                                                                                                                             | `string`       | n/a                        |   yes    |
 | subnets             | A list of IDs of subnets for the subnet group and potentially the RDS proxy.                                                                                                                                                                        | `list(string)` | n/a                        |   yes    |
 | skip_final_snapshot | A flag for wether or not skipping the creation of a final snapshot befor deletion of the RDS instance.                                                                                                                                              | `bool`         | true                       |    no    |
 | db_name             | Name of the database initially created in the RDS instance.                                                                                                                                                                                         | `string`       | "postgres"                 |    no    |
@@ -65,7 +65,7 @@ module "database" {
   instance_class      = "db.t3.micro"
   engine_version      = "16.1"
   allocated_storage   = 20
-  vpc_id              = "vpc-01234567890abcdef"
+  vpc                 = "vpc-01234567890abcdef"
   subnets             = ["subnet-1242421", "subnet-2344898"]
   skip_final_snapshot = true
   db_name             = "postgres"

main.tf

@@ -20,23 +20,23 @@ resource "aws_security_group" "proxy" {
   count       = var.proxy != null ? 1 : 0
   name        = "${var.identifier}-rds-proxy"
   description = "Allows RDS proxy to access the RDS instance and other services to access the RDS proxy"
-  vpc_id      = var.vpc_id
+  vpc_id      = var.vpc
 
   tags = var.tags
 }
 
 resource "aws_security_group" "rds" {
   name        = "${var.identifier}-rds"
   description = var.proxy != null ? "Allows RDS instance to be accessed by RDS proxy" : "Allows RDS instance to be accessed by services"
-  vpc_id      = var.vpc_id
+  vpc_id      = var.vpc
 
   tags = var.tags
 }
 
 resource "aws_security_group" "external" {
   name        = "${var.identifier}-external"
   description = var.proxy != null ? "Allows services to access the RDS proxy" : "Allows services to access the RDS instance"
-  vpc_id      = var.vpc_id
+  vpc_id      = var.vpc
 
   tags = var.tags
 }

tests/proxy.tftest.hcl

@@ -12,7 +12,7 @@ run "valid_proxy" {
 
   variables {
     identifier = "test"
-    vpc_id     = "vpc-01234567890abcdef"
+    vpc        = "vpc-01234567890abcdef"
     subnets    = ["subnet-1242421", "subnet-2344898"]
 
     proxy = {
@@ -75,7 +75,7 @@ run "no_proxy" {
 
   variables {
     identifier = "test"
-    vpc_id     = "vpc-01234567890abcdef"
+    vpc        = "vpc-01234567890abcdef"
     subnets    = ["subnet-1242421", "subnet-2344898"]
 
     proxy = null

tests/rds.tftest.hcl

@@ -12,19 +12,19 @@ run "invalid_vpc_id" {
 
   variables {
     identifier = "test"
-    vpc_id     = "abc-01234567890abcdef"
+    vpc        = "abc-01234567890abcdef"
     subnets    = ["subnet-1242421", "subnet-2344898"]
   }
 
-  expect_failures = [var.vpc_id]
+  expect_failures = [var.vpc]
 }
 
 run "invalid_subnets_length" {
   command = plan
 
   variables {
     identifier = "test"
-    vpc_id     = "vpc-01234567890abcdef"
+    vpc        = "vpc-01234567890abcdef"
     subnets    = ["subnet-2344898"]
   }
 
@@ -36,7 +36,7 @@ run "invalid_subnets" {
 
   variables {
     identifier = "test"
-    vpc_id     = "vpc-01234567890abcdef"
+    vpc        = "vpc-01234567890abcdef"
     subnets    = ["subnet-2344898", "foobar-2344898"]
   }
 
@@ -48,7 +48,7 @@ run "invalid_db_name" {
 
   variables {
     identifier = "test"
-    vpc_id     = "vpc-01234567890abcdef"
+    vpc        = "vpc-01234567890abcdef"
     subnets    = ["subnet-2344898", "subnet-2344898"]
     db_name    = "ab"
   }
@@ -61,7 +61,7 @@ run "invalid_db_username" {
 
   variables {
     identifier  = "test"
-    vpc_id      = "vpc-01234567890abcdef"
+    vpc         = "vpc-01234567890abcdef"
     subnets     = ["subnet-2344898", "subnet-2344898"]
     db_username = "ab"
   }
@@ -74,7 +74,7 @@ run "invalid_db_password" {
 
   variables {
     identifier  = "test"
-    vpc_id      = "vpc-01234567890abcdef"
+    vpc         = "vpc-01234567890abcdef"
     subnets     = ["subnet-2344898", "subnet-2344898"]
     db_password = "passwor"
   }

variables.tf

@@ -21,11 +21,11 @@ variable "allocated_storage" {
   default     = 20
 }
 
-variable "vpc_id" {
+variable "vpc" {
   description = "ID of the subnets' VPC."
   type        = string
   validation {
-    condition     = startswith(var.vpc_id, "vpc-")
+    condition     = startswith(var.vpc, "vpc-")
     error_message = "Must be valid VPC ID"
   }
 }