Support Redis log delivery (#26)

* Initial commit

* Fix dynamic

* More changes

* Updated Readme

* Add documentation

Co-authored-by: Abdul Wahid <abdul.wahid@umotif.com>

Author: iramello

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.1.0
+  rev: v4.2.0
   hooks:
   - id: check-added-large-files
     args: ['--maxkb=500']
@@ -17,8 +17,8 @@ repos:
   - id: detect-aws-credentials
     args: ['--allow-missing-credentials']
   - id: trailing-whitespace
-- repo: git://github.com/antonbabenko/pre-commit-terraform
-  rev: v1.64.0
+- repo: https://github.com/antonbabenko/pre-commit-terraform
+  rev: v1.71.0
   hooks:
   - id: terraform_fmt
   - id: terraform_docs

CHANGELOG.md

@@ -5,6 +5,16 @@ All notable changes to this project will be documented in this file.
 <a name="unreleased"></a>
 ## [Unreleased]
 
+- Updated Readme
+- More changes
+- Fix dynamic
+- Initial commit
+
+
+<a name="3.0.0"></a>
+## [3.0.0] - 2022-03-09
+
+- Upgrade module to be compatible with AWS Provider 4.0.0 ([#21](https://github.com/umotif-public/terraform-aws-elasticache-redis/issues/21))
 
 
 <a name="2.2.0"></a>
@@ -97,7 +107,8 @@ 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/2.2.0...HEAD
+[Unreleased]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/3.0.0...HEAD
+[3.0.0]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/2.2.0...3.0.0
 [2.2.0]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/2.1.0...2.2.0
 [2.1.0]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/2.0.0...2.1.0
 [2.0.0]: https://github.com/umotif-public/terraform-aws-elasticache-redis/compare/1.5.0...2.0.0

README.md

@@ -16,7 +16,7 @@ A Terraform module to create an AWS Redis ElastiCache cluster
 ```hcl
 module "redis" {
   source = "umotif-public/elasticache-redis/aws"
-  version = "~> 2.1.0"
+  version = "~> v3.0"
 
   name_prefix           = "core-example"
   number_cache_clusters = 2
@@ -50,6 +50,15 @@ module "redis" {
     }
   ]
 
+  log_delivery_configuration = [
+    {
+      destination_type = "cloudwatch-logs"
+      destination      = "aws_cloudwatch_log_group.example.name"
+      log_format       = "json"
+      log_type         = "engine-log"
+    }
+  ]
+
   tags = {
     Project = "Test"
   }
@@ -72,14 +81,14 @@ Module managed by [Abdul Wahid](https://github.com/Ohid25) ([LinkedIn](https://w
 | Name | Version |
 |------|---------|
 | <a name="requirement_terraform"></a> [terraform](#requirement\_terraform) | >= 0.14.11 |
-| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.0.0 |
+| <a name="requirement_aws"></a> [aws](#requirement\_aws) | >= 4.8.0 |
 | <a name="requirement_random"></a> [random](#requirement\_random) | >= 3.1.0 |
 
 ## Providers
 
 | Name | Version |
 |------|---------|
-| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.0.0 |
+| <a name="provider_aws"></a> [aws](#provider\_aws) | >= 4.8.0 |
 | <a name="provider_random"></a> [random](#provider\_random) | >= 3.1.0 |
 
 ## Modules
@@ -117,6 +126,7 @@ No modules.
 | <a name="input_ingress_cidr_blocks"></a> [ingress\_cidr\_blocks](#input\_ingress\_cidr\_blocks) | List of Ingress CIDR blocks. | `list(string)` | `[]` | no |
 | <a name="input_ingress_self"></a> [ingress\_self](#input\_ingress\_self) | Specify whether the security group itself will be added as a source to the ingress rule. | `bool` | `false` | no |
 | <a name="input_kms_key_id"></a> [kms\_key\_id](#input\_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 |
+| <a name="input_log_delivery_configuration"></a> [log\_delivery\_configuration](#input\_log\_delivery\_configuration) | Log Delivery configuration for the cluster. | <pre>list(object({<br>    destination_type = string<br>    destination      = string<br>    log_format       = string<br>    log_type         = string<br>  }))</pre> | `[]` | no |
 | <a name="input_maintenance_window"></a> [maintenance\_window](#input\_maintenance\_window) | Specifies the weekly time range for when maintenance on the cache cluster is performed. | `string` | `""` | no |
 | <a name="input_multi_az_enabled"></a> [multi\_az\_enabled](#input\_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` | `false` | no |
 | <a name="input_name_prefix"></a> [name\_prefix](#input\_name\_prefix) | The replication group identifier. This parameter is stored as a lowercase string. | `string` | n/a | yes |

examples/redis-basic/main.tf

@@ -58,6 +58,15 @@ module "redis" {
     }
   ]
 
+  log_delivery_configuration = [
+    {
+      destination_type = "cloudwatch-logs"
+      destination      = "aws_cloudwatch_log_group.henrique.name"
+      log_format       = "json"
+      log_type         = "engine-log"
+    }
+  ]
+
   tags = {
     Project = "Test"
   }

main.tf

@@ -36,6 +36,17 @@ resource "aws_elasticache_replication_group" "redis" {
   replicas_per_node_group = var.cluster_mode_enabled ? var.replicas_per_node_group : null
   num_node_groups         = var.cluster_mode_enabled ? var.num_node_groups : null
 
+  dynamic "log_delivery_configuration" {
+    for_each = var.log_delivery_configuration
+
+    content {
+      destination_type = log_delivery_configuration.value.destination_type
+      destination      = log_delivery_configuration.value.destination
+      log_format       = log_delivery_configuration.value.log_format
+      log_type         = log_delivery_configuration.value.log_type
+    }
+  }
+
   tags = merge(
     {
       "Name" = "${var.name_prefix}-redis"

variables.tf

@@ -192,3 +192,19 @@ variable "global_replication_group_id" {
   type        = string
   default     = null
 }
+
+variable "log_delivery_configuration" {
+  type = list(object({
+    destination_type = string
+    destination      = string
+    log_format       = string
+    log_type         = string
+  }))
+  description = "Log Delivery configuration for the cluster."
+  default     = []
+
+  validation {
+    condition     = length(var.log_delivery_configuration) <= 2
+    error_message = "You can set 2 targets at most for log delivery options."
+  }
+}

versions.tf

@@ -2,7 +2,7 @@ terraform {
   required_version = ">= 0.14.11"
 
   required_providers {
-    aws    = ">= 4.0.0"
+    aws    = ">= 4.8.0"
     random = ">= 3.1.0"
   }
 }