From 8470d5af4dbf62996df343d9dc4934636897aa20 Mon Sep 17 00:00:00 2001
From: "docs-sourcer[bot]"
<99042413+docs-sourcer[bot]@users.noreply.github.com>
Date: Tue, 11 Nov 2025 01:18:38 +0000
Subject: [PATCH] Updated with the [latest
changes](https://github.com/gruntwork-io/terraform-aws-cache/releases/tag/v1.0.3)
from the `terraform-aws-cache@v1.0.3` source branch.
---
.../elastic-cache/elastic-cache.md | 41 +++++++++++++++----
.../memcached/memcached.md | 16 ++++----
.../terraform-aws-cache/redis/redis.md | 18 ++++----
.../redis_copy_snapshot.md | 18 ++++----
.../terraform-aws-cache/valkey/valkey.md | 16 ++++----
5 files changed, 66 insertions(+), 43 deletions(-)
diff --git a/docs/reference/modules/terraform-aws-cache/elastic-cache/elastic-cache.md b/docs/reference/modules/terraform-aws-cache/elastic-cache/elastic-cache.md
index a5be53eda..fecce3b3d 100644
--- a/docs/reference/modules/terraform-aws-cache/elastic-cache/elastic-cache.md
+++ b/docs/reference/modules/terraform-aws-cache/elastic-cache/elastic-cache.md
@@ -9,13 +9,13 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
-
+
# ElasticCache Module
-View Source
+View Source
-Release Notes
+Release Notes
This module creates an ElastiCache cluster, which manages either a Memcached cluster, a single-node Redis instance.
@@ -47,7 +47,7 @@ For more info, see [Scaling Memcached](http://docs.aws.amazon.com/AmazonElastiCa
module "elastic_cache" {
- source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/elastic-cache?ref=v1.0.2"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/elastic-cache?ref=v1.0.3"
# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
@@ -142,6 +142,13 @@ module "elastic_cache" {
# https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/elasticache_replication_group#log-delivery-configuration.
slow_log_delivery_configuration = null
+ # The ARN of the SNS Topic to which notifications will be sent when a
+ # ElastiCache event happens, such as an automatic failover (e.g.
+ # arn:aws:sns:*:123456789012:my_sns_topic). An empty string is a valid value
+ # if you do not wish to receive notifications via SNS. This is required if
+ # enable_single_instance_mode is set to false
+ sns_topic_for_notifications = null
+
# A set of tags to set for the ElastiCache Cluster.
tags = {}
@@ -160,7 +167,7 @@ module "elastic_cache" {
# ------------------------------------------------------------------------------------------------------
terraform {
- source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/elastic-cache?ref=v1.0.2"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/elastic-cache?ref=v1.0.3"
}
inputs = {
@@ -258,6 +265,13 @@ inputs = {
# https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/elasticache_replication_group#log-delivery-configuration.
slow_log_delivery_configuration = null
+ # The ARN of the SNS Topic to which notifications will be sent when a
+ # ElastiCache event happens, such as an automatic failover (e.g.
+ # arn:aws:sns:*:123456789012:my_sns_topic). An empty string is a valid value
+ # if you do not wish to receive notifications via SNS. This is required if
+ # enable_single_instance_mode is set to false
+ sns_topic_for_notifications = null
+
# A set of tags to set for the ElastiCache Cluster.
tags = {}
@@ -466,6 +480,15 @@ object({
+
+
+
+The ARN of the SNS Topic to which notifications will be sent when a ElastiCache event happens, such as an automatic failover (e.g. arn:aws:sns:*:123456789012:my_sns_topic). An empty string is a valid value if you do not wish to receive notifications via SNS. This is required if enable_single_instance_mode is set to false
+
+
+
+
+
@@ -505,11 +528,11 @@ A set of tags to set for the ElastiCache Cluster.
diff --git a/docs/reference/modules/terraform-aws-cache/memcached/memcached.md b/docs/reference/modules/terraform-aws-cache/memcached/memcached.md
index 6bc26cd21..f0614a2c1 100644
--- a/docs/reference/modules/terraform-aws-cache/memcached/memcached.md
+++ b/docs/reference/modules/terraform-aws-cache/memcached/memcached.md
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
-
+
# Memcached Module
-View Source
+View Source
Release Notes
@@ -47,7 +47,7 @@ For more info, see [Scaling Memcached](http://docs.aws.amazon.com/AmazonElastiCa
module "memcached" {
- source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/memcached?ref=v1.0.2"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/memcached?ref=v1.0.3"
# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
@@ -137,7 +137,7 @@ module "memcached" {
# ------------------------------------------------------------------------------------------------------
terraform {
- source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/memcached?ref=v1.0.2"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/memcached?ref=v1.0.3"
}
inputs = {
@@ -400,11 +400,11 @@ A set of tags to set for the ElastiCache Replication Group.
diff --git a/docs/reference/modules/terraform-aws-cache/redis/redis.md b/docs/reference/modules/terraform-aws-cache/redis/redis.md
index 43532e3e9..5b9156a8c 100644
--- a/docs/reference/modules/terraform-aws-cache/redis/redis.md
+++ b/docs/reference/modules/terraform-aws-cache/redis/redis.md
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
-
+
# Redis Module
-View Source
+View Source
Release Notes
@@ -84,7 +84,7 @@ here: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroup
#### Choosing Cluster Mode vs. Single Instance
You can use `var.enable_single_instance_mode=true` to deploy a single node Redis instance. Refer
-to [examples/redis_single_instance](https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/examples/redis_single_instance) as an example.
+to [examples/redis_single_instance](https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/examples/redis_single_instance) as an example.
Here are some of the points you may consider while choosing which mode to run:
@@ -243,7 +243,7 @@ ElastiCache for Redis supports the following types of automatic scaling dimensio
module "redis" {
- source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/redis?ref=v1.0.2"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/redis?ref=v1.0.3"
# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
@@ -479,7 +479,7 @@ module "redis" {
# ------------------------------------------------------------------------------------------------------
terraform {
- source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/redis?ref=v1.0.2"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/redis?ref=v1.0.3"
}
inputs = {
@@ -1249,11 +1249,11 @@ This is a list of user IDs that should be added to the group defined in the 'us
diff --git a/docs/reference/modules/terraform-aws-cache/redis_copy_snapshot/redis_copy_snapshot.md b/docs/reference/modules/terraform-aws-cache/redis_copy_snapshot/redis_copy_snapshot.md
index 83dd4fe65..1b1fb964a 100644
--- a/docs/reference/modules/terraform-aws-cache/redis_copy_snapshot/redis_copy_snapshot.md
+++ b/docs/reference/modules/terraform-aws-cache/redis_copy_snapshot/redis_copy_snapshot.md
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
-
+
# Redis Copy Snapshot Module
-View Source
+View Source
Release Notes
@@ -45,7 +45,7 @@ instruction: [Making manual backups](https://docs.aws.amazon.com/AmazonElastiCac
The caller of the module needs to have the appropriate permission on the s3 bucket and the elastic cache cluster. The
detailed permission requirement is explained in detail
here: [Exporting a backup](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html) page.
-You can also refer to [redis_copy_snapshot](https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/examples/redis_copy_snapshot) module as an example.
+You can also refer to [redis_copy_snapshot](https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/examples/redis_copy_snapshot) module as an example.
## Encryption Limitation
@@ -69,7 +69,7 @@ try to export a snapshot encrypted with CMK (Customer Managed Key), you will get
module "redis_copy_snapshot" {
- source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/redis_copy_snapshot?ref=v1.0.2"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/redis_copy_snapshot?ref=v1.0.3"
# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
@@ -112,7 +112,7 @@ module "redis_copy_snapshot" {
# ------------------------------------------------------------------------------------------------------
terraform {
- source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/redis_copy_snapshot?ref=v1.0.2"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/redis_copy_snapshot?ref=v1.0.3"
}
inputs = {
@@ -216,11 +216,11 @@ A name for the exported snapshot copy. ElastiCache does not permit overwriting a
diff --git a/docs/reference/modules/terraform-aws-cache/valkey/valkey.md b/docs/reference/modules/terraform-aws-cache/valkey/valkey.md
index 39209be70..333520fe7 100644
--- a/docs/reference/modules/terraform-aws-cache/valkey/valkey.md
+++ b/docs/reference/modules/terraform-aws-cache/valkey/valkey.md
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
-
+
# Valkey Module
-View Source
+View Source
Release Notes
@@ -240,7 +240,7 @@ ElastiCache for Valkey supports the following types of automatic scaling dimensi
module "valkey" {
- source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/valkey?ref=v1.0.2"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/valkey?ref=v1.0.3"
# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
@@ -473,7 +473,7 @@ module "valkey" {
# ------------------------------------------------------------------------------------------------------
terraform {
- source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/valkey?ref=v1.0.2"
+ source = "git::git@github.com:gruntwork-io/terraform-aws-cache.git//modules/valkey?ref=v1.0.3"
}
inputs = {
@@ -1219,11 +1219,11 @@ Version number of valkey to use (e.g. 7.2).