Add support for multi-az and final snapshot (#12)

Author: marcincuber

.gitignore

@@ -4,4 +4,5 @@ errored.tfstate
 crash.log
 terraform.tfstate
 *.tfstate*
-terraform.tfvars
+terraform.tfvars
+*.terraform.lock.hcl

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v3.3.0
+  rev: v3.4.0
   hooks:
   - id: check-added-large-files
     args: ['--maxkb=500']

CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes to this project will be documented in this file.
 <a name="unreleased"></a>
 ## [Unreleased]
 
+- Update README.md
+
+
+<a name="1.4.0"></a>
+## [1.4.0] - 2020-12-08
+
+- Add support for availability_zones parameter ([#11](https://github.com/umotif-public/terraform-aws-elasticache-redis/issues/11))
+
+
+<a name="1.3.1"></a>
+## [1.3.1] - 2020-11-12
+
+- Update outputs + docs ([#9](https://github.com/umotif-public/terraform-aws-elasticache-redis/issues/9))
 
 
 <a name="1.3.0"></a>
@@ -59,7 +72,9 @@ All notable changes to this project will be documented in this file.
 - Initial commit of docs
 
 
-[Unreleased]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/1.3.0...HEAD
+[Unreleased]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/1.4.0...HEAD
+[1.4.0]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/1.3.1...1.4.0
+[1.3.1]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/1.3.0...1.3.1
 [1.3.0]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/1.2.0...1.3.0
 [1.2.0]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/1.1.1...1.2.0
 [1.1.1]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/1.1.0...1.1.1

README.md

@@ -13,7 +13,7 @@ Terraform 0.12. Pin module version to `~> v1.0`. Submit pull-requests to `master
 ```hcl
 module "redis" {
   source = "umotif-public/elasticache-redis/aws"
-  version = "~> 1.3.0"
+  version = "~> 1.5.0"
 
   name_prefix           = "core-example"
   number_cache_clusters = 2
@@ -72,14 +72,14 @@ Module managed by [Marcin Cuber](https://github.com/marcincuber) [linkedin](http
 | Name | Version |
 |------|---------|
 | terraform | >= 0.12.6 |
-| aws | >= 2.41 |
+| aws | >= 3.26 |
 | random | >= 3.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| aws | >= 2.41 |
+| aws | >= 3.26 |
 | random | >= 3.0 |
 
 ## Inputs
@@ -96,10 +96,12 @@ Module managed by [Marcin Cuber](https://github.com/marcincuber) [linkedin](http
 | description | The description of the all resources. | `string` | `"Managed by Terraform"` | no |
 | engine\_version | The version number of the cache engine to be used for the cache clusters in this replication group. | `string` | `"5.0.6"` | no |
 | family | The family of the ElastiCache parameter group. | `string` | `"redis5.0"` | no |
+| final\_snapshot\_identifier | The name of your final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster. If omitted, no final snapshot will be made. | `string` | `null` | no |
 | ingress\_cidr\_blocks | List of Ingress CIDR blocks. | `list(string)` | `[]` | no |
 | ingress\_self | Specify whether the security group itself will be added as a source to the ingress rule. | `bool` | `false` | no |
 | kms\_key\_id | The ARN of the key that you wish to use if encrypting at rest. If not supplied, uses service managed encryption. Can be specified only if `at_rest_encryption_enabled = true` | `string` | `""` | no |
 | maintenance\_window | Specifies the weekly time range for when maintenance on the cache cluster is performed. | `string` | `""` | no |
+| multi\_az\_enabled | Specifies whether to enable Multi-AZ Support for the replication group. If true, `automatic_failover_enabled` must also be enabled. Defaults to false. | `string` | `null` | no |
 | name\_prefix | The replication group identifier. This parameter is stored as a lowercase string. | `string` | n/a | yes |
 | node\_type | The compute and memory capacity of the nodes in the node group. | `string` | n/a | yes |
 | notification\_topic\_arn | An Amazon Resource Name (ARN) of an SNS topic to send ElastiCache notifications to. Example: `arn:aws:sns:us-east-1:012345678999:my_sns_topic` | `string` | `""` | no |
@@ -123,9 +125,11 @@ Module managed by [Marcin Cuber](https://github.com/marcincuber) [linkedin](http
 | elasticache\_auth\_token | The Redis Auth Token. |
 | elasticache\_parameter\_group\_id | The ElastiCache parameter group name. |
 | elasticache\_port | The Redis port. |
+| elasticache\_replication\_group\_arn | The Amazon Resource Name (ARN) of the created ElastiCache Replication Group. |
 | elasticache\_replication\_group\_id | The ID of the ElastiCache Replication Group. |
 | elasticache\_replication\_group\_member\_clusters | The identifiers of all the nodes that are part of this replication group. |
 | elasticache\_replication\_group\_primary\_endpoint\_address | The address of the endpoint for the primary node in the replication group. |
+| elasticache\_replication\_group\_reader\_endpoint\_address | The address of the endpoint for the reader node in the replication group. |
 | security\_group\_arn | The ARN of the Redis ElastiCache security group. |
 | security\_group\_description | The description of the Redis ElastiCache security group. |
 | security\_group\_egress | The egress rules of the Redis ElastiCache security group. |

examples/redis-basic/main.tf

@@ -2,28 +2,19 @@ provider "aws" {
   region = "eu-west-1"
 }
 
+data "aws_caller_identity" "current" {}
+data "aws_region" "current" {}
+
 #####
 # VPC and subnets
 #####
-module "vpc" {
-  source  = "terraform-aws-modules/vpc/aws"
-  version = "2.63.0"
-
-  name = "simple-vpc"
-
-  cidr = "10.0.0.0/16"
-
-  azs             = ["eu-west-1a", "eu-west-1b", "eu-west-1c"]
-  private_subnets = ["10.0.1.0/24", "10.0.2.0/24", "10.0.3.0/24"]
-  public_subnets  = ["10.0.101.0/24", "10.0.102.0/24", "10.0.103.0/24"]
-
-  enable_nat_gateway = false
-
-  tags = {
-    Environment = "test"
-  }
+data "aws_vpc" "default" {
+  default = true
 }
 
+data "aws_subnet_ids" "all" {
+  vpc_id = data.aws_vpc.default.id
+}
 #####
 # Elasticache Redis
 #####
@@ -34,24 +25,26 @@ module "redis" {
   number_cache_clusters = 2
   node_type             = "cache.t3.small"
 
-  engine_version           = "5.0.6"
-  port                     = 6379
-  maintenance_window       = "mon:03:00-mon:04:00"
-  snapshot_window          = "04:00-06:00"
-  snapshot_retention_limit = 7
+  engine_version            = "6.x"
+  port                      = 6379
+  maintenance_window        = "mon:03:00-mon:04:00"
+  snapshot_window           = "04:00-06:00"
+  snapshot_retention_limit  = 7
+  final_snapshot_identifier = "redis-final-snapshot-name"
 
   automatic_failover_enabled = true
+  multi_az_enabled           = true
 
   at_rest_encryption_enabled = true
   transit_encryption_enabled = true
   auth_token                 = "1234567890asdfghjkl"
 
   apply_immediately = true
-  family            = "redis5.0"
+  family            = "redis6.x"
   description       = "Test elasticache redis."
 
-  subnet_ids = module.vpc.private_subnets
-  vpc_id     = module.vpc.vpc_id
+  subnet_ids = data.aws_subnet_ids.all.ids
+  vpc_id     = data.aws_vpc.default.id
 
   ingress_cidr_blocks = ["0.0.0.0/0"]
 

examples/redis-clustered-mode/main.tf

@@ -5,23 +5,12 @@ provider "aws" {
 #####
 # VPC and subnets
 #####
-module "vpc" {
-  source  = "terraform-aws-modules/vpc/aws"
-  version = "2.63.0"
-
-  name = "simple-vpc"
-
-  cidr = "10.0.0.0/16"
-
-  azs             = ["eu-west-1a", "eu-west-1b", "eu-west-1c"]
-  private_subnets = ["10.0.1.0/24", "10.0.2.0/24", "10.0.3.0/24"]
-  public_subnets  = ["10.0.101.0/24", "10.0.102.0/24", "10.0.103.0/24"]
-
-  enable_nat_gateway = false
+data "aws_vpc" "default" {
+  default = true
+}
 
-  tags = {
-    Environment = "test"
-  }
+data "aws_subnet_ids" "all" {
+  vpc_id = data.aws_vpc.default.id
 }
 
 #####
@@ -54,8 +43,8 @@ module "redis" {
   family            = "redis6.x"
   description       = "Test elasticache redis."
 
-  subnet_ids = module.vpc.private_subnets
-  vpc_id     = module.vpc.vpc_id
+  subnet_ids = data.aws_subnet_ids.all.ids
+  vpc_id     = data.aws_vpc.default.id
 
   ingress_cidr_blocks = ["0.0.0.0/0"]
 

main.tf

@@ -16,8 +16,10 @@ resource "aws_elasticache_replication_group" "redis" {
   maintenance_window         = var.maintenance_window
   snapshot_window            = var.snapshot_window
   snapshot_retention_limit   = var.snapshot_retention_limit
+  final_snapshot_identifier  = var.final_snapshot_identifier
   automatic_failover_enabled = var.automatic_failover_enabled && var.number_cache_clusters > 1 ? true : false
   auto_minor_version_upgrade = var.auto_minor_version_upgrade
+  multi_az_enabled           = var.multi_az_enabled
 
   at_rest_encryption_enabled = var.at_rest_encryption_enabled
   transit_encryption_enabled = var.transit_encryption_enabled

outputs.tf

@@ -1,3 +1,8 @@
+output "elasticache_replication_group_arn" {
+  value       = aws_elasticache_replication_group.redis.arn
+  description = "The Amazon Resource Name (ARN) of the created ElastiCache Replication Group."
+}
+
 output "elasticache_replication_group_id" {
   value       = aws_elasticache_replication_group.redis.id
   description = "The ID of the ElastiCache Replication Group."
@@ -8,6 +13,11 @@ output "elasticache_replication_group_primary_endpoint_address" {
   description = "The address of the endpoint for the primary node in the replication group."
 }
 
+output "elasticache_replication_group_reader_endpoint_address" {
+  value       = var.cluster_mode_enabled ? aws_elasticache_replication_group.redis.configuration_endpoint_address : aws_elasticache_replication_group.redis.reader_endpoint_address
+  description = "The address of the endpoint for the reader node in the replication group."
+}
+
 output "elasticache_replication_group_member_clusters" {
   value       = aws_elasticache_replication_group.redis.member_clusters
   description = "The identifiers of all the nodes that are part of this replication group."

variables.tf

@@ -168,3 +168,15 @@ variable "availability_zones" {
   description = "A list of EC2 availability zones in which the replication group's cache clusters will be created. The order of the availability zones in the list is not important."
   default     = null
 }
+
+variable "multi_az_enabled" {
+  type        = string
+  description = "Specifies whether to enable Multi-AZ Support for the replication group. If true, `automatic_failover_enabled` must also be enabled. Defaults to false."
+  default     = null
+}
+
+variable "final_snapshot_identifier" {
+  type        = string
+  description = "The name of your final node group (shard) snapshot. ElastiCache creates the snapshot from the primary node in the cluster. If omitted, no final snapshot will be made."
+  default     = null
+}

versions.tf

@@ -2,7 +2,7 @@ terraform {
   required_version = ">= 0.12.6"
 
   required_providers {
-    aws    = ">= 2.41"
+    aws    = ">= 3.26"
     random = ">= 3.0"
   }
 }