CCM-9689: Fix lambda descriptions for variables and outputs

Author: sidnhs

infrastructure/modules/amp_branch/outputs.tf

@@ -1,3 +1,4 @@
 output "name" {
+  description = "Name of the Amplify branch"
   value = aws_amplify_branch.main.branch_name
 }

infrastructure/modules/aws-backup-source/variables.tf

@@ -93,7 +93,7 @@ variable "backup_copy_vault_account_id" {
 }
 
 variable "backup_plan_config_s3" {
-  description = "Configuration for backup plans"
+  description = "Configuration for backup plans for s3"
   type = object({
     enable                    = bool
     selection_tag             = string

infrastructure/modules/eventpub/outputs.tf

@@ -1,11 +1,13 @@
 output "sns_topic" {
+  description = "SNS Topic ARN and Name"
   value = {
     arn  = aws_sns_topic.main.arn
     name = aws_sns_topic.main.name
   }
 }
 
 output "s3_bucket_event_cache" {
+  description = "S3 Bucket ARN and Name for event cache"
   value = var.enable_event_cache ? {
     arn    = module.s3bucket_event_cache[0].arn
     bucket = module.s3bucket_event_cache[0].bucket

infrastructure/modules/kms/outputs.tf

@@ -1,15 +1,19 @@
 output "key_arn" {
+  description = "ARN of the KMS key"
   value = aws_kms_key.main.arn
 }
 
 output "key_id" {
+  description = "ID of the KMS key"
   value = aws_kms_key.main.key_id
 }
 
 output "admin_policy_arn" {
+  description = "ARN of the admin IAM policy"
   value = aws_iam_policy.admin.arn
 }
 
 output "user_policy_arn" {
+  description = "ARN of the user IAM policy"
   value = aws_iam_policy.user.arn
 }

infrastructure/modules/lambda/outputs.tf

@@ -1,31 +1,39 @@
 output "function_name" {
+  description = "Name of the Lambda function"
   value = aws_lambda_function.main.function_name
 }
 
 output "function_arn" {
+  description = "ARN of the Lambda function"
   value = aws_lambda_function.main.arn
 }
 
 output "function_invoke_arn" {
+  description = "Invoke ARN of the Lambda function"
   value = aws_lambda_function.main.invoke_arn
 }
 
 output "function_qualified_arn" {
+  description = "Qualified ARN of the Lambda function, including version or alias"
   value = aws_lambda_function.main.qualified_arn
 }
 
 output "function_env_vars" {
+  description = "Environment variables for the Lambda function"
   value = length(var.lambda_env_vars) == 0 ? {} : aws_lambda_function.main.environment[0].variables
 }
 
 output "iam_role_name" {
+  description = "Name of the IAM role associated with the Lambda function"
   value = aws_iam_role.main.name
 }
 
 output "iam_role_arn" {
+  description = "ARN of the IAM role associated with the Lambda function"
   value = aws_iam_role.main.arn
 }
 
 output "cloudwatch_log_group_name" {
+  description = "Name of the CloudWatch Log Group for the Lambda function"
   value = aws_cloudwatch_log_group.main.name
 }

infrastructure/modules/lambda/variables.tf

@@ -115,13 +115,13 @@ variable "lambda_env_vars" {
 
 variable "function_code_base_path" {
   type        = string
-  description = "The path to the sourcecode directories needed for this lambda"
+  description = "The base path to the sourcecode directories needed for this lambda"
   default     = "./"
 }
 
 variable "function_code_dir" {
   type        = string
-  description = "The path to the sourcecode directories needed for this lambda"
+  description = "The directory for this lambda"
 }
 
 variable "function_s3_bucket" {
@@ -185,7 +185,7 @@ variable "sns_destination_kms_key" {
 
 variable "lambda_dlq_message_retention_seconds" {
   type        = number
-  description = "KMS Key ARN to be used for SNS Topic for on-failure Lambda invocation records"
+  description = "The number of seconds to retain messages in the Lambda DLQ SQS queue"
   default     = 86400
 }
 
@@ -209,7 +209,7 @@ variable "enable_lambda_insights" {
 
 variable "lambda_at_edge" {
   type        = bool
-  description = "Enable the lambda insights layer, this must be disabled for lambda@edge usage"
+  description = "Whether this Lambda is a Lambda@Edge function"
   default     = false
 }
 

infrastructure/modules/s3bucket/outputs.tf

@@ -1,35 +1,44 @@
 output "acl" {
+  description = "The ACL of the S3 bucket. If the object ownership is set to 'BucketOwnerEnforced', the ACL will be 'private'. Otherwise, it will reflect the ACL set in the aws_s3_bucket_acl resource."
   value = var.object_ownership == "BucketOwnerEnforced" ? "private" : aws_s3_bucket_acl.main[0].acl
 }
 
 output "arn" {
+  description = "The ARN of the S3 bucket"
   value = aws_s3_bucket.main.arn
 }
 
 output "bucket" {
+  description = "The name of the S3 bucket"
   value = aws_s3_bucket.main.bucket
 }
 
 output "bucket_domain_name" {
+  description = "The domain name of the S3 bucket"
   value = aws_s3_bucket.main.bucket_domain_name
 }
 
 output "bucket_regional_domain_name" {
+  description = "The regional domain name of the S3 bucket"
   value = aws_s3_bucket.main.bucket_regional_domain_name
 }
 
 output "hosted_zone_id" {
+  description = "The hosted zone ID of the S3 bucket"
   value = aws_s3_bucket.main.hosted_zone_id
 }
 
 output "id" {
+  description = "The ID of the S3 bucket"
   value = aws_s3_bucket.main.id
 }
 
 output "policy" {
+  description = "The policy of the S3 bucket"
   value = aws_s3_bucket_policy.main.policy
 }
 
 output "region" {
+  description = "The AWS region where the S3 bucket is located"
   value = aws_s3_bucket.main.region
 }

infrastructure/modules/sqs/outputs.tf

@@ -1,23 +1,29 @@
 output "sqs_queue_url" {
+  description = "The URL of the SQS queue"
   value = aws_sqs_queue.sqs_queue.id
 }
 
 output "sqs_queue_arn" {
+  description = "The ARN of the SQS queue"
   value = aws_sqs_queue.sqs_queue.arn
 }
 
 output "sqs_dlq_url" {
+  description = "The URL of the SQS dead-letter queue"
   value = var.create_dlq ? aws_sqs_queue.deadletter_queue[0].id : null
 }
 
 output "sqs_dlq_arn" {
+  description = "The ARN of the SQS dead-letter queue"
   value = var.create_dlq ? aws_sqs_queue.deadletter_queue[0].arn : null
 }
 
 output "sqs_queue_name" {
+  description = "The name of the SQS queue"
   value = "${local.csi}-queue"
 }
 
 output "sqs_dlq_name" {
+  description = "The name of the SQS dead-letter queue"
   value = var.create_dlq ? aws_sqs_queue.deadletter_queue[0].name : null
 }