Restructure standalone code

Author: jshre898

README.md

@@ -161,7 +161,7 @@ Security scanning is graciously provided by Prowler. Proowler is the leading ful
 | <a name="input_name"></a> [name](#input\_name) | The name of the redis cluster | `string` | `""` | no |
 | <a name="input_node_type"></a> [node\_type](#input\_node\_type) | The instance size of the redis cluster | `string` | `"cache.t3.micro"` | no |
 | <a name="input_notification_topic_arn"></a> [notification\_topic\_arn](#input\_notification\_topic\_arn) | (Optional) ARN of an SNS topic to send ElastiCache notifications | `string` | `null` | no |
-| <a name="input_num_cache_nodes"></a> [num\_cache\_nodes](#input\_num\_cache\_nodes) | The number of cache nodes | `number` | `1` | no |
+| <a name="input_num_cache_nodes"></a> [num\_cache\_nodes](#input\_num\_cache\_nodes) | The number of cache nodes | `number` | n/a | yes |
 | <a name="input_ok_actions"></a> [ok\_actions](#input\_ok\_actions) | The list of actions to execute when this alarm transitions into an OK state from any other state. Each action is specified as an Amazon Resource Number (ARN) | `list(string)` | `[]` | no |
 | <a name="input_parameter"></a> [parameter](#input\_parameter) | A list of Redis parameters to apply. It can be different based on mode slection. | <pre>list(object({<br/>    name  = string<br/>    value = string<br/>  }))</pre> | `[]` | no |
 | <a name="input_parameter_group_description"></a> [parameter\_group\_description](#input\_parameter\_group\_description) | Parameter group | `string` | `null` | no |
@@ -178,7 +178,7 @@ Security scanning is graciously provided by Prowler. Proowler is the leading ful
 | <a name="input_snapshot_retention_limit"></a> [snapshot\_retention\_limit](#input\_snapshot\_retention\_limit) | The number of days for which ElastiCache will retain automatic cache cluster snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, then a snapshot that was taken today will be retained for 5 days before being deleted. If the value of SnapshotRetentionLimit is set to zero (0), backups are turned off. Please note that setting a snapshot\_retention\_limit is not supported on cache.t1.micro or cache.t2.* cache nodes | `number` | `7` | no |
 | <a name="input_snapshot_window"></a> [snapshot\_window](#input\_snapshot\_window) | The daily time range (in UTC) during which ElastiCache will begin taking a daily snapshot of your cache cluster. The minimum maintenance window is a 60 minute period. Example: 05:00-09:00 | `string` | `"03:00-05:00"` | no |
 | <a name="input_subnets"></a> [subnets](#input\_subnets) | The subnets where the redis cluster is deployed | `list(string)` | `[]` | no |
-| <a name="input_transit_encryption_enabled"></a> [transit\_encryption\_enabled](#input\_transit\_encryption\_enabled) | (Optional) Whether to enable encryption in transit | `bool` | `true` | no |
+| <a name="input_transit_encryption_enabled"></a> [transit\_encryption\_enabled](#input\_transit\_encryption\_enabled) | (Optional) Whether to enable encryption in transit | `bool` | `false` | no |
 | <a name="input_vpc_id"></a> [vpc\_id](#input\_vpc\_id) | The vpc where we will put the redis cluster | `string` | `""` | no |
 
 ## Outputs

examples/complete-cluster-mode/README.md

@@ -26,7 +26,7 @@ This example will be very useful for users who are new to a module and want to q
 | Name | Source | Version |
 |------|--------|---------|
 | <a name="module_kms"></a> [kms](#module\_kms) | terraform-aws-modules/kms/aws | n/a |
-| <a name="module_redis"></a> [redis](#module\_redis) | squareops/elasticache-redis/aws | n/a |
+| <a name="module_redis"></a> [redis](#module\_redis) | ../../ | n/a |
 | <a name="module_vpc"></a> [vpc](#module\_vpc) | squareops/vpc/aws | 3.3.1 |
 
 ## Resources

examples/complete-cluster-mode/main.tf

@@ -104,20 +104,27 @@ module "redis" {
   environment                          = local.environment
   engine_version                       = local.redis_engine_version
   cluster_mode_enabled                 = local.cluster_mode_enabled
+  num_cache_nodes                      = 0
   cluster_mode_num_node_groups         = 1
   cluster_mode_replicas_per_node_group = 2
   vpc_id                               = module.vpc.vpc_id
   subnets                              = module.vpc.database_subnets
   kms_key_arn                          = module.kms.key_arn
   multi_az_enabled                     = true
+  transit_encryption_enabled           = true
   availability_zones                   = local.availability_zones
   snapshot_window                      = "07:00-08:00"
   maintenance_window                   = "sun:09:00-sun:10:00"
   allowed_security_groups              = local.allowed_security_groups
   cloudwatch_metric_alarms_enabled     = true
   alarm_cpu_threshold_percent          = 70
   alarm_memory_threshold_bytes         = "10000000" # in bytes
-  slack_notification_enabled           = true
+  alarm_eviction_threshold             = 1000
+  alarm_connections_threshold          = 100
+  alarm_replication_lag_threshold      = 10
+  alarm_cache_hits_threshold           = 1000
+  alarm_cache_misses_threshold         = 50
+  slack_notification_enabled           = false
   slack_username                       = ""
   slack_channel                        = ""
   slack_webhook_url                    = ""

examples/complete/main.tf

@@ -96,7 +96,7 @@ module "vpc" {
 }
 
 module "redis" {
-  source                           = "../../"
+  source                           = "squareops/elasticache-redis/aws"
   name                             = local.name
   family                           = local.family
   node_type                        = local.node_type
@@ -107,6 +107,7 @@ module "redis" {
   subnets                          = module.vpc.database_subnets
   kms_key_arn                      = module.kms.key_arn
   multi_az_enabled                 = true
+  transit_encryption_enabled       = true
   availability_zones               = local.availability_zones
   snapshot_window                  = "07:00-08:00"
   maintenance_window               = "sun:09:00-sun:10:00"

examples/standalone/README.md

@@ -7,45 +7,3 @@
 <br>
 
 This example will be very useful for users who are new to a module and want to quickly learn how to use it. By reviewing the examples, users can gain a better understanding of how the module works, what features it supports, and how to customize it to their specific needs.<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
-## Requirements
-
-| Name | Version |
-|------|---------|
-| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.13 |
-| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 3.63 |
-
-## Providers
-
-| Name | Version |
-|------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 3.63 |
-
-## Modules
-
-| Name | Source | Version |
-|------|--------|---------|
-| <a name="module_redis"></a> [redis](#module\_redis) | ../../ | n/a |
-| <a name="module_vpc"></a> [vpc](#module\_vpc) | squareops/vpc/aws | 3.3.1 |
-
-## Resources
-
-| Name | Type |
-|------|------|
-| [aws_availability_zones.primary](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) | data source |
-| [aws_caller_identity.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |
-| [aws_region.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/region) | data source |
-
-## Inputs
-
-No inputs.
-
-## Outputs
-
-| Name | Description |
-|------|-------------|
-| <a name="output_cluster_address"></a> [cluster\_address](#output\_cluster\_address) | (Memcached only) DNS name of the cache cluster without the port appended |
-| <a name="output_cluster_arn"></a> [cluster\_arn](#output\_cluster\_arn) | The ARN of the ElastiCache Cluster |
-| <a name="output_cluster_cache_nodes"></a> [cluster\_cache\_nodes](#output\_cluster\_cache\_nodes) | List of node objects including `id`, `address`, `port` and `availability_zone` |
-| <a name="output_cluster_configuration_endpoint"></a> [cluster\_configuration\_endpoint](#output\_cluster\_configuration\_endpoint) | (Memcached only) Configuration endpoint to allow host discovery |
-| <a name="output_cluster_engine_version_actual"></a> [cluster\_engine\_version\_actual](#output\_cluster\_engine\_version\_actual) | Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine |
-<!-- END_TF_DOCS -->

examples/standalone/main.tf

@@ -36,8 +36,8 @@ module "vpc" {
 }
 
 module "redis" {
-  source                           = "../../"
-  num_cache_nodes                  = 1   #keep it 1 for To create only master node and 0 replica node.
+  source                           = "squareops/elasticache-redis/aws"
+  num_cache_nodes                  = 1 #keep it 1 for To create only master node and 0 replica node.
   name                             = local.name
   family                           = local.family
   node_type                        = local.node_type

main.tf

@@ -36,7 +36,7 @@ resource "aws_elasticache_parameter_group" "default" {
 }
 
 resource "aws_elasticache_cluster" "redis" {
-  count                    = var.num_cache_nodes == 1 ? 1 : 0 # Only create if num_cache_nodes == 1
+  count                    = (!var.transit_encryption_enabled && var.num_cache_nodes == 1) ? 1 : 0
   cluster_id               = "${var.environment}-${var.name}-standalone-redis"
   engine                   = "redis"
   engine_version           = var.engine_version
@@ -77,7 +77,7 @@ resource "aws_elasticache_cluster" "redis" {
 }
 
 resource "aws_elasticache_replication_group" "redis" {
-  count                       = var.num_cache_nodes > 1 ? 1 : 0 # Only create if num_cache_nodes == 1
+  count                       = var.transit_encryption_enabled ? 1 : 0 # Only create if num_cache_nodes == 1
   replication_group_id        = "${var.environment}-${var.name}-redis"
   port                        = var.port
   engine                      = "redis"
@@ -222,7 +222,7 @@ resource "aws_cloudwatch_metric_alarm" "cache_cpu" {
   threshold           = var.alarm_cpu_threshold_percent
 
   dimensions = {
-    CacheClusterId = var.num_cache_nodes > 1 ? aws_elasticache_replication_group.redis[count.index].id : aws_elasticache_cluster.redis[0].id
+    CacheClusterId = var.transit_encryption_enabled ? aws_elasticache_replication_group.redis[count.index].id : aws_elasticache_cluster.redis[0].id
   }
 
   alarm_actions = [aws_sns_topic.slack_topic[0].arn]
@@ -248,7 +248,7 @@ resource "aws_cloudwatch_metric_alarm" "cache_memory" {
   threshold           = var.alarm_memory_threshold_bytes
 
   dimensions = {
-    CacheClusterId = var.num_cache_nodes > 1 ? aws_elasticache_replication_group.redis[count.index].id : aws_elasticache_cluster.redis[0].id
+    CacheClusterId = var.transit_encryption_enabled ? aws_elasticache_replication_group.redis[count.index].id : aws_elasticache_cluster.redis[0].id
   }
 
   alarm_actions = [aws_sns_topic.slack_topic[0].arn]
@@ -274,7 +274,7 @@ resource "aws_cloudwatch_metric_alarm" "cache_evictions" {
   threshold           = var.alarm_eviction_threshold
 
   dimensions = {
-    CacheClusterId = var.num_cache_nodes > 1 ? aws_elasticache_replication_group.redis[count.index].id : aws_elasticache_cluster.redis[0].id
+    CacheClusterId = var.transit_encryption_enabled ? aws_elasticache_replication_group.redis[count.index].id : aws_elasticache_cluster.redis[0].id
   }
 
   alarm_actions = [aws_sns_topic.slack_topic[0].arn]
@@ -300,7 +300,7 @@ resource "aws_cloudwatch_metric_alarm" "cache_connections" {
   threshold           = var.alarm_connections_threshold
 
   dimensions = {
-    CacheClusterId = var.num_cache_nodes > 1 ? aws_elasticache_replication_group.redis[count.index].id : aws_elasticache_cluster.redis[0].id
+    CacheClusterId = var.transit_encryption_enabled ? aws_elasticache_replication_group.redis[count.index].id : aws_elasticache_cluster.redis[0].id
   }
 
   alarm_actions = [aws_sns_topic.slack_topic[0].arn]
@@ -352,7 +352,7 @@ resource "aws_cloudwatch_metric_alarm" "cache_hits" {
   threshold           = var.alarm_cache_hits_threshold
 
   dimensions = {
-    CacheClusterId = var.num_cache_nodes > 1 ? aws_elasticache_replication_group.redis[count.index].id : aws_elasticache_cluster.redis[0].id
+    CacheClusterId = var.transit_encryption_enabled ? aws_elasticache_replication_group.redis[count.index].id : aws_elasticache_cluster.redis[0].id
   }
 
   alarm_actions = [aws_sns_topic.slack_topic[0].arn]
@@ -378,7 +378,7 @@ resource "aws_cloudwatch_metric_alarm" "cache_misses" {
   threshold           = var.alarm_cache_misses_threshold
 
   dimensions = {
-    CacheClusterId = var.num_cache_nodes > 1 ? aws_elasticache_replication_group.redis[count.index].id : aws_elasticache_cluster.redis[0].id
+    CacheClusterId = var.transit_encryption_enabled ? aws_elasticache_replication_group.redis[count.index].id : aws_elasticache_cluster.redis[0].id
   }
 
   alarm_actions = [aws_sns_topic.slack_topic[0].arn]

variables.tf

@@ -36,7 +36,6 @@ variable "parameter" {
 
 variable "num_cache_nodes" {
   description = "The number of cache nodes"
-  default     = 1
   type        = number
 }
 
@@ -127,7 +126,7 @@ variable "at_rest_encryption_enabled" {
 
 variable "transit_encryption_enabled" {
   description = "(Optional) Whether to enable encryption in transit"
-  default     = true
+  default     = false
   type        = bool
 }