feat/main: Refactor Terraform configurations: Update variables, outputs, and examples

.github/workflows/changelog.yml

@@ -1,9 +1,9 @@
 name: changelog
 permissions: write-all
 on:
-  push:
-    tags:
-      - "*"
+  # push:
+  #   tags:
+  #     - "*"
   workflow_dispatch:
 jobs:
   changelog:

examples/complete/example.tf

@@ -90,56 +90,57 @@ module "mq_broker" {
   source = "../.." # Reference the path of the root module where the MQ broker is defined
 
   # Pass in the values to configure the MQ broker
-  aws_region              = var.aws_region
-  mq_broker_name          = var.mq_broker_name
-  engine_type             = var.engine_type
-  engine_version          = var.engine_version
-  host_instance_type      = var.host_instance_type
-  broker_name             = var.broker_name
+  # aws_region         = var.aws_region
+  broker_name        = var.mq_broker_name
+  engine_type        = var.engine_type
+  engine_version     = var.engine_version
+  host_instance_type = var.host_instance_type
+  # broker_name             = var.broker_name
   deployment_mode         = var.deployment_mode
   maintenance_day_of_week = var.maintenance_day_of_week
-  maintenance_time        = var.maintenance_time
+  maintenance_time_of_day = var.maintenance_time_of_day
+  maintenance_time_zone   = var.maintenance_time_zone
   tags                    = var.tags
 
   # Pass in the VPC and Subnet created by the VPC and Subnet modules
-  vpc_id                  = module.vpc.vpc_id # Pass VPC ID
-  subnet_ids              = [module.public_subnet.public_subnet_id[0]] # Pass subnet IDs
-  security_group_id       = [module.security_group.security_group_id]
+  vpc_id            = module.vpc.vpc_id                          # Pass VPC ID
+  subnet_ids        = [module.public_subnet.public_subnet_id[0]] # Pass subnet IDs
+  security_group_id = [module.security_group.security_group_id]
 
   # MQ broker-specific settings
-  apply_immediately       = var.apply_immediately
-  auto_minor_version_upgrade = var.auto_minor_version_upgrade
-  publicly_accessible     = var.publicly_accessible
-  general_log_enabled     = var.general_log_enabled
-  audit_log_enabled       = var.audit_log_enabled
-  kms_mq_key_arn          = var.kms_mq_key_arn
-  use_aws_owned_key       = var.use_aws_owned_key
-  ssm_path                = var.ssm_path
-  encryption_enabled      = var.encryption_enabled
-  kms_ssm_key_arn         = var.kms_ssm_key_arn
-  allowed_ingress_ports   = var.allowed_ingress_ports
+  apply_immediately             = var.apply_immediately
+  auto_minor_version_upgrade    = var.auto_minor_version_upgrade
+  publicly_accessible           = var.publicly_accessible
+  general_log_enabled           = var.general_log_enabled
+  audit_log_enabled             = var.audit_log_enabled
+  kms_mq_key_arn                = var.kms_mq_key_arn
+  use_aws_owned_key             = var.use_aws_owned_key
+  ssm_path                      = var.ssm_path
+  encryption_enabled            = var.encryption_enabled
+  kms_ssm_key_arn               = var.kms_ssm_key_arn
+  allowed_ingress_ports         = var.allowed_ingress_ports
   additional_security_group_ids = var.additional_security_group_ids
 
   # Admin and Application user credentials
-  mq_admin_user           = var.mq_admin_user
-  mq_admin_password       = var.mq_admin_password
-  mq_application_user     = var.mq_application_username
-  mq_application_password = var.mq_application_password
-  alias = format(
-    "alias/%s",
-    replace(var.alias, "[^a-zA-Z0-9_-]", "_")
-  )
+  mq_admin_user     = var.mq_admin_user
+  mq_admin_password = var.mq_admin_password
+  # mq_application_user     = var.mq_application_username
+  # mq_application_password = var.mq_application_password
+  # # alias = format(
+  #   "alias/%s",
+  #   replace(var.alias, "[^a-zA-Z0-9_-]", "_")
+  # )
 
   # CloudWatch Log Settings
-  enable_cloudwatch_logs  = var.enable_cloudwatch_logs
-  cloudwatch_log_group_name = var.cloudwatch_log_group_name
-  cloudwatch_log_retention_days = var.cloudwatch_log_retention_days
+  #   enable_cloudwatch_logs  = var.enable_cloudwatch_logs
+  #   cloudwatch_log_group_name = var.cloudwatch_log_group_name
+  #   cloudwatch_log_retention_days = var.cloudwatch_log_retention_days
 
-  # Secrets Manager settings (if enabled)
-  use_secrets_manager = var.use_secrets_manager
-  secret_manager_key_prefix = var.secret_manager_key_prefix
+  #   # Secrets Manager settings (if enabled)
+  #   use_secrets_manager = var.use_secrets_manager
+  #   secret_manager_key_prefix = var.secret_manager_key_prefix
+  # }
 }
-
 output "security_group_id" {
   value       = module.security_group.security_group_id
   description = "The Security Group ID"

examples/complete/outputs.tf

@@ -0,0 +1,109 @@
+# output "public_subnet_cidrs" {
+#   value       = module.subnets.public_subnet_cidrs
+#   description = "Public subnet CIDR blocks"
+# }
+
+# output "private_subnet_cidrs" {
+#   value       = module.subnets.private_subnet_cidrs
+#   description = "Private subnet CIDR blocks"
+# }
+
+# output "vpc_cidr" {
+#   value       = module.vpc.vpc_cidr_block
+#   description = "VPC CIDR"
+# }
+
+# output "broker_id" {
+#   value       = module.mq_broker.broker_id
+#   description = "AmazonMQ broker ID"
+# }
+
+# output "broker_arn" {
+#   value       = module.mq_broker.broker_arn
+#   description = "AmazonMQ broker ARN"
+# }
+
+# output "primary_console_url" {
+#   value       = module.mq_broker.primary_console_url
+#   description = "AmazonMQ active web console URL"
+# }
+
+# output "primary_ssl_endpoint" {
+#   value       = module.mq_broker.primary_ssl_endpoint
+#   description = "AmazonMQ primary SSL endpoint"
+# }
+
+# output "primary_amqp_ssl_endpoint" {
+#   value       = module.mq_broker.primary_amqp_ssl_endpoint
+#   description = "AmazonMQ primary AMQP+SSL endpoint"
+# }
+
+# output "primary_stomp_ssl_endpoint" {
+#   value       = module.mq_broker.primary_stomp_ssl_endpoint
+#   description = "AmazonMQ primary STOMP+SSL endpoint"
+# }
+
+# output "primary_mqtt_ssl_endpoint" {
+#   value       = module.mq_broker.primary_mqtt_ssl_endpoint
+#   description = "AmazonMQ primary MQTT+SSL endpoint"
+# }
+
+# output "primary_wss_endpoint" {
+#   value       = module.mq_broker.primary_wss_endpoint
+#   description = "AmazonMQ primary WSS endpoint"
+# }
+
+# output "primary_ip_address" {
+#   value       = module.mq_broker.primary_ip_address
+#   description = "AmazonMQ primary IP address"
+# }
+
+# output "secondary_console_url" {
+#   value       = module.mq_broker.secondary_console_url
+#   description = "AmazonMQ secondary web console URL"
+# }
+
+# output "secondary_ssl_endpoint" {
+#   value       = module.mq_broker.secondary_ssl_endpoint
+#   description = "AmazonMQ secondary SSL endpoint"
+# }
+
+# output "secondary_amqp_ssl_endpoint" {
+#   value       = module.mq_broker.secondary_amqp_ssl_endpoint
+#   description = "AmazonMQ secondary AMQP+SSL endpoint"
+# }
+
+# output "secondary_stomp_ssl_endpoint" {
+#   value       = module.mq_broker.secondary_stomp_ssl_endpoint
+#   description = "AmazonMQ secondary STOMP+SSL endpoint"
+# }
+
+# output "secondary_mqtt_ssl_endpoint" {
+#   value       = module.mq_broker.secondary_mqtt_ssl_endpoint
+#   description = "AmazonMQ secondary MQTT+SSL endpoint"
+# }
+
+# output "secondary_wss_endpoint" {
+#   value       = module.mq_broker.secondary_wss_endpoint
+#   description = "AmazonMQ secondary WSS endpoint"
+# }
+
+# output "secondary_ip_address" {
+#   value       = module.mq_broker.secondary_ip_address
+#   description = "AmazonMQ secondary IP address"
+# }
+
+# output "security_group_id" {
+#   value       = module.mq_broker.security_group_id
+#   description = "AmazonMQ Security Group ID"
+# }
+
+# output "security_group_arn" {
+#   value       = module.mq_broker.security_group_arn
+#   description = "AmazonMQ Security Group ARN"
+# }
+
+# output "security_group_name" {
+#   value       = module.mq_broker.security_group_name
+#   description = "AmazonMQ Security Group name"
+# }

examples/complete/variables.tf

@@ -252,3 +252,20 @@ variable "secret_manager_key_prefix" {
   type        = string
   default     = "mq"  # Default key prefix for Secrets Manager
 }
+variable "attributes" {
+  description = "List of attributes to be used in SSM path"
+  type        = list(string)
+  default     = ["default_value"]  # Provide a default value (a non-empty list)
+}
+
+variable "maintenance_time_of_day" {
+  description = "The time of day for the maintenance window (e.g., 02:00)."
+  type        = string
+  default     = "02:00"  # Set a default value, or leave it blank if required
+}
+
+variable "maintenance_time_zone" {
+  description = "The time zone for the maintenance window (e.g., UTC, America/New_York)."
+  type        = string
+  default     = "UTC"  # Set a default value, or leave it blank if required
+}

examples/complete/versions.tf

@@ -1,11 +1,17 @@
+
+# ------------------------------------------------------------------------------
+# Versions
+# ------------------------------------------------------------------------------
+
 terraform {
   required_version = ">= 1.6.6"
 
   required_providers {
 
     aws = {
-      source  = "hashicorp/aws" #
+      source  = "hashicorp/aws"
       version = ">= 5.31.0"
     }
   }
 }
+