add new outputs for valkey, update existing output names and their descriptions

Author: hahirwar-cd

examples/valkey/example.tf

@@ -54,7 +54,7 @@ module "secrets_manager" {
       name                    = "aws/elasticache/auth-tokens"
       description             = "Elasticache AUTH Token"
       recovery_window_in_days = 7
-      secret_string           = "{ \"auth_token\": \"UseSomethingSecure*1234\"}"
+      secret_string           = "{ \"auth_token\": \"UseSomethingSecure*1234\"}" # -- The Secret can be changed with any DUMMY_VALUE after `terraform apply`. Terraform will not show any changes for `secret_string` in future plans.
     }
   ]
 }
@@ -97,7 +97,8 @@ module "valkey" {
     maintenance_window            = "sat:03:30-sat:04:30"
   }
   az_mode                    = "single-az"
-  kms_key_id                 = null # -- AWS Owned KMS Key
+  kms_key_id                 = null  # -- AWS Owned KMS Key
+  auto_generate_auth_token   = false # -- To Provide your own auth_token
   auth_token                 = jsondecode(data.aws_secretsmanager_secret_version.auth_token.secret_string)["auth_token"]
   auth_token_update_strategy = "SET"
   sg_ids                     = [module.vpc.vpc_default_security_group_id]

examples/valkey/outputs.tf

@@ -1,24 +1,45 @@
-# output "id" {
-#   value       = module.valkey[*].id
-#   description = "memcached id."
-# }
-
-# output "tags" {
-#   value       = module.memcached.tags
-#   description = "A mapping of tags to assign to the resource."
-# }
-
-# output "memcached_endpoint" {
-#   value       = module.memcached.memcached_endpoint
-#   description = "Memcached endpoint address."
-# }
-
-# output "hostname" {
-#   value       = module.memcached.hostname
-#   description = "DNS hostname"
-# }
-
-# output "redis_ssm_arn" {
-#   value       = module.memcached.Memcached_ssm_name
-#   description = "A map of the names and ARNs created"
-# }
+### ---------- aws_elasticache_replication_group --------------------
+output "valkey_elasticache_arn" {
+  description = "ARN of the created ElastiCache Replication Group."
+  value       = module.valkey.elasticache_arn
+}
+
+output "valkey_elasticache_engine_version" {
+  description = "Running version of the cache engine."
+  value       = module.valkey.elasticache_engine_version
+}
+
+output "valkey_elasticache_cluster_enabled" {
+  description = "Indicates if cluster mode is enabled."
+  value       = module.valkey.elasticache_cluster_enabled
+}
+
+output "valkey_elasticache_configuration_endpoint_address" {
+  description = "Address of the replication group configuration endpoint when cluster mode is enabled."
+  value       = module.valkey.elasticache_configuration_endpoint_address
+}
+
+output "valkey_elasticache_id" {
+  description = "ID of the ElastiCache Replication Group."
+  value       = module.valkey.id
+}
+
+output "valkey_elasticache_member_clusters" {
+  description = "Identifiers of all the nodes that are part of this replication group."
+  value       = module.valkey.elasticache_member_clusters
+}
+
+output "valkey_elasticache_primary_endpoint_address" {
+  description = "Address of the endpoint for the primary node in the replication group, if cluster mode is disabled."
+  value       = module.valkey.elasticache_endpoint
+}
+
+output "valkey_elasticache_reader_endpoint_address" {
+  description = "Address of the endpoint for the reader node in the replication group, if cluster mode is disabled."
+  value       = module.valkey.elasticache_reader_endpoint_address
+}
+
+output "valkey_elasticache_tags_all" {
+  description = "Map of tags assigned to the resource, including inherited ones."
+  value       = module.valkey.elasticache_tags_all
+}

main.tf

@@ -142,7 +142,7 @@ resource "aws_elasticache_subnet_group" "default" {
 ##----------------------------------------------------------------------------------
 
 resource "random_password" "auth_token" {
-  count   = var.enable && var.auth_token_enable && var.auth_token == null ? 1 : 0
+  count   = var.enable && var.auth_token_enable && var.auto_generate_auth_token ? 1 : 0
   length  = var.length
   special = var.special
 }
@@ -178,7 +178,7 @@ resource "aws_elasticache_replication_group" "cluster" {
   multi_az_enabled           = lookup(var.replication_group, "multi_az_enabled", false)
   network_type               = var.network_type
 
-  auth_token                 = var.auth_token_enable ? (var.auth_token == null ? random_password.auth_token[0].result : var.auth_token) : ""
+  auth_token                 = var.auth_token_enable ? (var.auto_generate_auth_token ? random_password.auth_token[0].result : var.auth_token) : ""
   auth_token_update_strategy = var.auth_token_enable ? var.auth_token_update_strategy : null
   kms_key_id                 = var.kms_key_id == "" ? join("", aws_kms_key.default[*].arn) : var.kms_key_id
   tags                       = module.labels.tags
@@ -247,7 +247,7 @@ resource "aws_ssm_parameter" "secret" {
   name        = format("/%s/%s/auth-token", var.environment, var.name)
   description = var.ssm_parameter_description
   type        = var.ssm_parameter_type
-  value       = var.auth_token == null ? random_password.auth_token[0].result : var.auth_token
+  value       = var.auto_generate_auth_token ? random_password.auth_token[0].result : var.auth_token
   key_id      = var.kms_key_id == "" ? join("", aws_kms_key.default[*].arn) : var.kms_key_id
 }
 

outputs.tf

@@ -2,7 +2,7 @@
 # Description : Terraform module to create Elasticache Cluster and replica for Redis.
 output "id" {
   value       = var.cluster_enabled ? "" : (var.cluster_replication_enabled ? join("", aws_elasticache_replication_group.cluster[*].id) : join("", aws_elasticache_replication_group.cluster[*].id))
-  description = "Redis cluster id."
+  description = "Elasticache cluster id."
 }
 
 output "port" {
@@ -16,14 +16,14 @@ output "tags" {
   description = "A mapping of tags to assign to the resource."
 }
 
-output "redis_endpoint" {
+output "elasticache_endpoint" {
   value       = var.cluster_replication_enabled ? "" : (var.cluster_replication_enabled ? join("", aws_elasticache_replication_group.cluster[*].primary_endpoint_address) : join("", aws_elasticache_cluster.default[*].configuration_endpoint))
-  description = "Redis endpoint address."
+  description = "Elasticache endpoint address."
 }
 
-output "redis_arn" {
+output "elasticache_arn" {
   value       = var.enable && length(aws_elasticache_replication_group.cluster) > 0 ? aws_elasticache_replication_group.cluster[0].arn : length(aws_elasticache_replication_group.cluster) > 0 ? aws_elasticache_replication_group.cluster[0].arn : null
-  description = "Redis arn"
+  description = "Elasticache arn"
 }
 
 output "memcached_endpoint" {
@@ -61,7 +61,55 @@ output "Memcached_ssm_name" {
 }
 
 output "auth_token" {
-  value       = var.enable && var.auth_token_enable && var.auth_token == null ? random_password.auth_token[0].result : null
+  value       = var.enable && var.auth_token_enable && var.auto_generate_auth_token ? random_password.auth_token[0].result : null
   sensitive   = true
   description = "Auth token generated value"
-}
+}
+
+### ---------- aws_elasticache_cluster ------------------------------
+output "elasticache_engine_version_actual" {
+  value       = try(aws_elasticache_cluster.default[0].engine_version_actual, null)
+  description = "Running version of the cache engine"
+}
+
+output "elasticache_cache_nodes" {
+  value       = try(aws_elasticache_cluster.default[0].cache_nodes, [])
+  description = "List of node objects"
+}
+
+output "elasticache_cluster_address" {
+  value       = try(aws_elasticache_cluster.default[0].cluster_address, null)
+  description = "(Memcached only) DNS name of the cache cluster"
+}
+
+### ---------- aws_elasticache_replication_group --------------------
+
+output "elasticache_engine_version" {
+  description = "Running version of the cache engine."
+  value       = try(aws_elasticache_replication_group.cluster[0].engine_version_actual, null)
+}
+
+output "elasticache_cluster_enabled" {
+  description = "Indicates if cluster mode is enabled."
+  value       = try(aws_elasticache_replication_group.cluster[0].cluster_enabled, null)
+}
+
+output "elasticache_configuration_endpoint_address" {
+  description = "Address of the replication group configuration endpoint when cluster mode is enabled."
+  value       = try(aws_elasticache_replication_group.cluster[0].configuration_endpoint_address, null)
+}
+
+output "elasticache_member_clusters" {
+  description = "Identifiers of all the nodes that are part of this replication group."
+  value       = try([for c in aws_elasticache_replication_group.cluster[0].member_clusters : c], null)
+}
+
+output "elasticache_reader_endpoint_address" {
+  description = "Address of the endpoint for the reader node in the replication group, if cluster mode is disabled."
+  value       = try(aws_elasticache_replication_group.cluster[0].reader_endpoint_address, null)
+}
+
+output "elasticache_tags_all" {
+  description = "Map of tags assigned to the resource, including inherited ones."
+  value       = try(aws_elasticache_replication_group.cluster[0].tags_all, null)
+}

variables.tf

@@ -93,6 +93,12 @@ variable "auth_token_enable" {
   description = "Flag to specify whether to create auth token (password) protected cluster. Can be specified only if transit_encryption_enabled = true."
 }
 
+variable "auto_generate_auth_token" {
+  type        = bool
+  default     = true
+  description = "Whether to automatically generate the authentication token using Terraform. If set to false, you must provide your own token via the 'auth_token' variable."
+}
+
 variable "auth_token" {
   type        = string
   default     = null