feat: Update Redis replication group example

Author: bryantbiggs

examples/complete-redis-replication-group/README.md

@@ -32,7 +32,7 @@ Note that this example may create resources which will incur monetary charges on
 
 | Name | Source | Version |
 |------|--------|---------|
-| <a name="module_elasticache"></a> [elasticache](#module\_elasticache) | ../.. | n/a |
+| <a name="module_elasticache"></a> [elasticache](#module\_elasticache) | ../../ | n/a |
 | <a name="module_elasticache_disabled"></a> [elasticache\_disabled](#module\_elasticache\_disabled) | ../.. | n/a |
 | <a name="module_vpc"></a> [vpc](#module\_vpc) | terraform-aws-modules/vpc/aws | ~> 5.0 |
 
@@ -48,7 +48,23 @@ No inputs.
 
 ## Outputs
 
-No 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 |
+| <a name="output_parameter_group_arn"></a> [parameter\_group\_arn](#output\_parameter\_group\_arn) | The AWS ARN associated with the parameter group |
+| <a name="output_parameter_group_id"></a> [parameter\_group\_id](#output\_parameter\_group\_id) | The ElastiCache parameter group name |
+| <a name="output_rep_group_arn"></a> [rep\_group\_arn](#output\_rep\_group\_arn) | ARN of the created ElastiCache Replication Group |
+| <a name="output_rep_group_coniguration_endpoint_address"></a> [rep\_group\_coniguration\_endpoint\_address](#output\_rep\_group\_coniguration\_endpoint\_address) | Address of the replication group configuration endpoint when cluster mode is enabled |
+| <a name="output_rep_group_engine_version_actual"></a> [rep\_group\_engine\_version\_actual](#output\_rep\_group\_engine\_version\_actual) | Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine |
+| <a name="output_rep_group_id"></a> [rep\_group\_id](#output\_rep\_group\_id) | ID of the ElastiCache Replication Group |
+| <a name="output_rep_group_member_clusters"></a> [rep\_group\_member\_clusters](#output\_rep\_group\_member\_clusters) | Identifiers of all the nodes that are part of this replication group |
+| <a name="output_rep_group_primary_endpoint_address"></a> [rep\_group\_primary\_endpoint\_address](#output\_rep\_group\_primary\_endpoint\_address) | Address of the endpoint for the primary node in the replication group, if the cluster mode is disabled |
+| <a name="output_rep_group_reader_endpoint_address"></a> [rep\_group\_reader\_endpoint\_address](#output\_rep\_group\_reader\_endpoint\_address) | Address of the endpoint for the reader node in the replication group, if the cluster mode is disabled |
+| <a name="output_subnet_group_name"></a> [subnet\_group\_name](#output\_subnet\_group\_name) | The ElastiCache subnet group name |
 <!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
 
 Apache-2.0 Licensed. See [LICENSE](https://github.com/clowdhaus/terraform-aws-elasticache/blob/main/LICENSE).

examples/complete-redis-replication-group/main.tf

@@ -0,0 +1,54 @@
+# ElastiCache example for Redis replication group
+
+Configuration in this directory creates set of ElastiCaChe resources including replication group, subnet group and parameter group.
+
+## Usage
+
+To run this example you need to execute:
+
+```bash
+$ terraform init
+$ terraform plan
+$ terraform apply
+```
+
+Note that this example may create resources which will incur monetary charges on your AWS bill. Run `terraform destroy` when you no longer need these resources.
+
+<!-- BEGINNING OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+## Requirements
+
+| Name | Version |
+|------|---------|
+| <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 1.0 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 5.23 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 5.23 |
+
+## Modules
+
+| Name | Source | Version |
+|------|--------|---------|
+| <a name="module_elasticache"></a> [elasticache](#module\_elasticache) | ../.. | n/a |
+| <a name="module_elasticache_disabled"></a> [elasticache\_disabled](#module\_elasticache\_disabled) | ../.. | n/a |
+| <a name="module_vpc"></a> [vpc](#module\_vpc) | terraform-aws-modules/vpc/aws | ~> 5.0 |
+
+## Resources
+
+| Name | Type |
+|------|------|
+| [aws_availability_zones.available](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/availability_zones) | data source |
+
+## Inputs
+
+No inputs.
+
+## Outputs
+
+No outputs.
+<!-- END OF PRE-COMMIT-TERRAFORM DOCS HOOK -->
+
+Apache-2.0 Licensed. See [LICENSE](https://github.com/clowdhaus/terraform-aws-elasticache/blob/main/LICENSE).

examples/complete-redis-replication-group/outputs.tf

@@ -0,0 +1,90 @@
+provider "aws" {
+  region = local.region
+}
+
+data "aws_availability_zones" "available" {}
+
+locals {
+  region = "us-east-1"
+  name   = "ex-${basename(path.cwd)}"
+
+  vpc_cidr = "10.0.0.0/16"
+  azs      = slice(data.aws_availability_zones.available.names, 0, 3)
+
+  tags = {
+    Name       = local.name
+    Example    = local.name
+    Repository = "https://github.com/clowdhaus/terraform-aws-elasticache"
+  }
+}
+
+################################################################################
+# ElastiCache Module
+################################################################################
+
+module "elasticache" {
+  source = "../../"
+
+  create_replication_group = true
+  replication_group_id     = local.name
+
+  engine_version = "7.1"
+  node_type      = "cache.t4g.small"
+
+  # cluster_mode = [{
+  #   replicas_per_node_group = 1
+  #   num_node_groups         = 3
+  # }]
+
+  # snapshot_retention_limit = 1
+  # snapshot_window          = "20:00-23:00"
+
+  transit_encryption_enabled = true
+  auth_token                 = "PickSomethingMoreSecure123!"
+
+  security_group_ids = []
+
+  # subnet group
+  subnet_group_name        = local.name
+  subnet_group_description = "${title(local.name)} subnet group"
+  subnet_ids               = module.vpc.private_subnets
+
+  maintenance_window = "sun:05:00-sun:09:00"
+  apply_immediately  = true
+
+  # parameter group
+  create_parameter_group      = true
+  parameter_group_name        = local.name
+  parameter_group_family      = "redis7.1"
+  parameter_group_description = "${title(local.name)} parameter group"
+  parameters = [
+    {
+      name  = "activerehashing"
+      value = "yes"
+    },
+    {
+      name  = "min-slaves-to-write"
+      value = "2"
+    }
+  ]
+
+  tags = local.tags
+}
+
+################################################################################
+# Supporting Resources
+################################################################################
+
+module "vpc" {
+  source  = "terraform-aws-modules/vpc/aws"
+  version = "~> 5.0"
+
+  name = local.name
+  cidr = local.vpc_cidr
+
+  azs             = local.azs
+  public_subnets  = [for k, v in local.azs : cidrsubnet(local.vpc_cidr, 8, k)]
+  private_subnets = [for k, v in local.azs : cidrsubnet(local.vpc_cidr, 8, k + 10)]
+
+  tags = local.tags
+}

examples/complete-redis-replication-group/replication_group.tf

@@ -0,0 +1,90 @@
+################################################################################
+# Cluster
+################################################################################
+
+output "cluster_arn" {
+  description = "The ARN of the ElastiCache Cluster"
+  value       = module.elasticache.cluster_arn
+}
+
+output "cluster_engine_version_actual" {
+  description = "Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine"
+  value       = module.elasticache.cluster_engine_version_actual
+}
+
+output "cluster_cache_nodes" {
+  description = "List of node objects including `id`, `address`, `port` and `availability_zone`"
+  value       = module.elasticache.cluster_cache_nodes
+}
+
+output "cluster_address" {
+  description = "(Memcached only) DNS name of the cache cluster without the port appended"
+  value       = module.elasticache.cluster_address
+}
+
+output "cluster_configuration_endpoint" {
+  description = "(Memcached only) Configuration endpoint to allow host discovery"
+  value       = module.elasticache.cluster_configuration_endpoint
+}
+
+################################################################################
+# Replication Group
+################################################################################
+
+output "rep_group_arn" {
+  description = "ARN of the created ElastiCache Replication Group"
+  value       = module.elasticache.rep_group_arn
+}
+
+output "rep_group_engine_version_actual" {
+  description = "Because ElastiCache pulls the latest minor or patch for a version, this attribute returns the running version of the cache engine"
+  value       = module.elasticache.rep_group_engine_version_actual
+}
+
+output "rep_group_coniguration_endpoint_address" {
+  description = "Address of the replication group configuration endpoint when cluster mode is enabled"
+  value       = module.elasticache.rep_group_coniguration_endpoint_address
+}
+
+output "rep_group_id" {
+  description = "ID of the ElastiCache Replication Group"
+  value       = module.elasticache.rep_group_id
+}
+
+output "rep_group_member_clusters" {
+  description = "Identifiers of all the nodes that are part of this replication group"
+  value       = module.elasticache.rep_group_member_clusters
+}
+
+output "rep_group_primary_endpoint_address" {
+  description = "Address of the endpoint for the primary node in the replication group, if the cluster mode is disabled"
+  value       = module.elasticache.rep_group_primary_endpoint_address
+}
+
+output "rep_group_reader_endpoint_address" {
+  description = "Address of the endpoint for the reader node in the replication group, if the cluster mode is disabled"
+  value       = module.elasticache.rep_group_reader_endpoint_address
+}
+
+################################################################################
+# Parameter Group
+################################################################################
+
+output "parameter_group_arn" {
+  description = "The AWS ARN associated with the parameter group"
+  value       = module.elasticache.parameter_group_arn
+}
+
+output "parameter_group_id" {
+  description = "The ElastiCache parameter group name"
+  value       = module.elasticache.parameter_group_id
+}
+
+################################################################################
+# Subnet Group
+################################################################################
+
+output "subnet_group_name" {
+  description = "The ElastiCache subnet group name"
+  value       = module.elasticache.subnet_group_name
+}