feat: 🎸 usecase -> prefix

change usecase to prefix to be more generic BREAKING CHANGE: 🧨 usecase -> prefix
StateFarmIns · Mar 13, 2024 · 7da8b6c · 7da8b6c
1 parent 2d5333b
commit 7da8b6c
Show file tree

Hide file tree

Showing 9 changed files with 16 additions and 16 deletions.
diff --git a/README.md b/README.md
@@ -52,7 +52,7 @@ This includes a 24 hour cloudwatch alarm to trigger the lambda regularly in an e
 | <a name="input_permissions_boundary_arn"></a> [permissions\_boundary\_arn](#input\_permissions\_boundary\_arn)                     | The ARN of the policy that is used to set the permissions boundary for the IAM roles.                       | `string`       | `null`  |    no    |
 | <a name="input_subnet_ids"></a> [subnet\_ids](#input\_subnet\_ids)                                                                 | Subnets that Lambda will be created with in the VPC                                                         | `list(string)` | `[]`    |    no    |
 | <a name="input_timeout"></a> [timeout](#input\_timeout)                                                                            | Timeout value for the lambda                                                                                | `number`       | `300`   |    no    |
-| <a name="input_usecase"></a> [usecase](#input\_usecase)                                                                            | Usecase name, can be a team or product name. E.g., 'SRE'                                                    | `string`       | n/a     |   yes    |
+| <a name="input_prefix"></a> [prefix](#input\_prefix)                                                                               | prefix name, can be a team or product name. E.g., 'SRE'                                                     | `string`       | n/a     |   yes    |
 | <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id)                                                                             | VPC ID to attach the IP Address Release lambda to. Only necessary if there are multiple VPCs in an account. | `string`       | `null`  |    no    |
 
 ## Outputs
@@ -73,7 +73,7 @@ module "ip-address-release-primary" {
     aws = aws
   }
 
-  usecase                           = "SRE"
+  prefix                           = "SRE"
   account_name                      = var.account_name
   permissions_boundary_arn          = local.permissions_boundary
   internet_egress_security_group_id = data.aws_security_group.https-internet-egress.id
@@ -88,7 +88,7 @@ module "ip-address-release-secondary" {
     aws = aws.secondary
   }
 
-  usecase                           = "SRE"
+  prefix                           = "SRE"
   account_name                      = var.account_name
   permissions_boundary_arn          = local.permissions_boundary
   internet_egress_security_group_id = data.aws_security_group.https-internet-egress_secondary.id

diff --git a/cloudwatch.tf b/cloudwatch.tf
@@ -1,6 +1,6 @@
 # This file contains the Cloudwatch alarms that attach to the timer service alarm lambda.
 resource "aws_cloudwatch_event_rule" "ip_address_release_lambda_interval" {
-  name                = "${var.usecase}-ip-address-lambda-release-rule"
+  name                = "${var.prefix}-ip-address-lambda-release-rule"
   description         = "Fires every 24 hours"
   schedule_expression = "rate(24 hours)"
 }

diff --git a/iam/iam.tf b/iam/iam.tf
@@ -3,12 +3,12 @@ resource "random_string" "random" {
   length  = 5
 }
 resource "aws_iam_role" "lambda_role" {
-  name                 = "${var.usecase}-ip-address-release-lambda-role-${random_string.random.result}"
+  name                 = "${var.prefix}-ip-address-release-lambda-role-${random_string.random.result}"
   assume_role_policy   = data.aws_iam_policy_document.lambda_role_trust.json
   description          = "service role for ip address release lambda"
   permissions_boundary = var.permissions_boundary_arn
   tags = {
-    Name = "${var.usecase} lambda role"
+    Name = "${var.prefix} lambda role"
   }
 }
 
@@ -30,11 +30,11 @@ resource "aws_iam_role_policy_attachment" "lambda-policy-attachment" {
 }
 
 resource "aws_iam_policy" "lambda_policy" {
-  name        = "${var.usecase}-ip-address-release-lambda-policy-${random_string.random.result}"
+  name        = "${var.prefix}-ip-address-release-lambda-policy-${random_string.random.result}"
   description = "lambda policy for ip address release lambda"
   policy      = data.aws_iam_policy_document.lambda_policy_document.json
   tags = {
-    Name = "${var.usecase} IP Address Release Lambda Policy"
+    Name = "${var.prefix} IP Address Release Lambda Policy"
   }
 }
 

diff --git a/iam/outputs.tf b/iam/outputs.tf
@@ -1,3 +1,3 @@
 output "role_arn" {
   value = aws_iam_role.lambda_role.arn
-}
+}
diff --git a/iam/variables.tf b/iam/variables.tf
@@ -1,4 +1,4 @@
-variable "usecase" {}
+variable "prefix" {}
 variable "account_name" {}
 variable "permissions_boundary_arn" {
   type    = string

diff --git a/lambda.tf b/lambda.tf
@@ -1,6 +1,6 @@
 resource "aws_lambda_function" "ip_address_release_lambda" {
   filename         = data.archive_file.lambda_source.output_path
-  function_name    = "${var.usecase}-ip-address-release-lambda"
+  function_name    = "${var.prefix}-ip-address-release-lambda"
   role             = var.iam_role_arn == null ? module.iam[0].role_arn : var.iam_role_arn
   handler          = "lambda_function.lambda_handler"
   source_code_hash = filebase64sha256(data.archive_file.lambda_source.output_path)
@@ -10,7 +10,7 @@ resource "aws_lambda_function" "ip_address_release_lambda" {
 
   environment {
     variables = {
-      USECASE = var.usecase
+      prefix = var.prefix
     }
   }
 

diff --git a/main.tf b/main.tf
@@ -2,7 +2,7 @@ module "iam" {
   source = "./iam"
 
   count                    = var.iam_role_arn == null ? 1 : 0
-  usecase                  = var.usecase
+  prefix                   = var.prefix
   account_name             = var.account_name
   permissions_boundary_arn = var.permissions_boundary_arn
 }
diff --git a/outputs.tf b/outputs.tf
@@ -1,4 +1,4 @@
 output "iam_role_arn" {
   value       = var.iam_role_arn == null ? module.iam[0].role_arn : var.iam_role_arn
   description = "The IAM Role created, or the one passed in."
-}
+}
diff --git a/variables.tf b/variables.tf
@@ -3,9 +3,9 @@ variable "account_name" {
   description = "The account name for use in alarm description."
 }
 
-variable "usecase" {
+variable "prefix" {
   type        = string
-  description = "Usecase name, can be a team or product name. E.g., 'SRE'"
+  description = "prefix name, can be a team or product name. E.g., 'SRE'"
 }
 
 variable "timeout" {