Skip to content

Commit 29d6ab4

Browse files
docs-sourcer[bot]docs-sourcer[bot]
authored
Updated with the [latest changes](https://github.com/gruntwork-io/terraform-aws-cache/releases/tag/v1.0.3) from the [email protected] source branch. (#2847)
Co-authored-by: docs-sourcer[bot] <99042413+docs-sourcer[bot]@users.noreply.github.com>
1 parent ca9b324 commit 29d6ab4

File tree

5 files changed

+66
-43
lines changed

5 files changed

+66
-43
lines changed

‎docs/reference/modules/terraform-aws-cache/elastic-cache/elastic-cache.md‎

Lines changed: 32 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,13 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="Cache Modules" version="1.0.2" lastModifiedVersion="0.23.0"/>
12+
<VersionBadge repoTitle="Cache Modules" version="1.0.3" lastModifiedVersion="1.0.3"/>
1313

1414
# ElasticCache Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/elastic-cache" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/elastic-cache" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

18-
<a href="https://github.com/gruntwork-io/terraform-aws-cache/releases/tag/v0.23.0" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
18+
<a href="https://github.com/gruntwork-io/terraform-aws-cache/releases/tag/v1.0.3" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

2020
This module creates an ElastiCache cluster, which manages either a Memcached cluster, a single-node Redis instance.
2121

@@ -47,7 +47,7 @@ For more info, see [Scaling Memcached](http://docs.aws.amazon.com/AmazonElastiCa
4747
4848
module "elastic_cache" {
4949
50-
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/elastic-cache?ref=v1.0.2"
50+
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/elastic-cache?ref=v1.0.3"
5151
5252
# ----------------------------------------------------------------------------------------------------
5353
# REQUIRED VARIABLES
@@ -142,6 +142,13 @@ module "elastic_cache" {
142142
# https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/elasticache_replication_group#log-delivery-configuration.
143143
slow_log_delivery_configuration = null
144144
145+
# The ARN of the SNS Topic to which notifications will be sent when a
146+
# ElastiCache event happens, such as an automatic failover (e.g.
147+
# arn:aws:sns:*:123456789012:my_sns_topic). An empty string is a valid value
148+
# if you do not wish to receive notifications via SNS. This is required if
149+
# enable_single_instance_mode is set to false
150+
sns_topic_for_notifications = null
151+
145152
# A set of tags to set for the ElastiCache Cluster.
146153
tags = {}
147154
@@ -160,7 +167,7 @@ module "elastic_cache" {
160167
# ------------------------------------------------------------------------------------------------------
161168
162169
terraform {
163-
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/elastic-cache?ref=v1.0.2"
170+
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/elastic-cache?ref=v1.0.3"
164171
}
165172
166173
inputs = {
@@ -258,6 +265,13 @@ inputs = {
258265
# https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/elasticache_replication_group#log-delivery-configuration.
259266
slow_log_delivery_configuration = null
260267
268+
# The ARN of the SNS Topic to which notifications will be sent when a
269+
# ElastiCache event happens, such as an automatic failover (e.g.
270+
# arn:aws:sns:*:123456789012:my_sns_topic). An empty string is a valid value
271+
# if you do not wish to receive notifications via SNS. This is required if
272+
# enable_single_instance_mode is set to false
273+
sns_topic_for_notifications = null
274+
261275
# A set of tags to set for the ElastiCache Cluster.
262276
tags = {}
263277
@@ -466,6 +480,15 @@ object({
466480
<HclListItemDefaultValue defaultValue="null"/>
467481
</HclListItem>
468482

483+
<HclListItem name="sns_topic_for_notifications" requirement="optional" type="string">
484+
<HclListItemDescription>
485+
486+
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
487+
488+
</HclListItemDescription>
489+
<HclListItemDefaultValue defaultValue="null"/>
490+
</HclListItem>
491+
469492
<HclListItem name="tags" requirement="optional" type="map(string)">
470493
<HclListItemDescription>
471494

@@ -505,11 +528,11 @@ A set of tags to set for the ElastiCache Cluster.
505528
<!-- ##DOCS-SOURCER-START
506529
{
507530
"originalSources": [
508-
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/elastic-cache/readme.md",
509-
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/elastic-cache/variables.tf",
510-
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/elastic-cache/outputs.tf"
531+
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/elastic-cache/readme.md",
532+
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/elastic-cache/variables.tf",
533+
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/elastic-cache/outputs.tf"
511534
],
512535
"sourcePlugin": "module-catalog-api",
513-
"hash": "2d5ec9e7f3b641dddd4f1dac8f4a3aac"
536+
"hash": "59b3d6ca7dc63bd9a22672bfaef876ed"
514537
}
515538
##DOCS-SOURCER-END -->

‎docs/reference/modules/terraform-aws-cache/memcached/memcached.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="Cache Modules" version="1.0.2" lastModifiedVersion="0.22.4"/>
12+
<VersionBadge repoTitle="Cache Modules" version="1.0.3" lastModifiedVersion="0.22.4"/>
1313

1414
# Memcached Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/memcached" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/memcached" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

1818
<a href="https://github.com/gruntwork-io/terraform-aws-cache/releases/tag/v0.22.4" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -47,7 +47,7 @@ For more info, see [Scaling Memcached](http://docs.aws.amazon.com/AmazonElastiCa
4747
4848
module "memcached" {
4949
50-
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/memcached?ref=v1.0.2"
50+
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/memcached?ref=v1.0.3"
5151
5252
# ----------------------------------------------------------------------------------------------------
5353
# REQUIRED VARIABLES
@@ -137,7 +137,7 @@ module "memcached" {
137137
# ------------------------------------------------------------------------------------------------------
138138
139139
terraform {
140-
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/memcached?ref=v1.0.2"
140+
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/memcached?ref=v1.0.3"
141141
}
142142
143143
inputs = {
@@ -400,11 +400,11 @@ A set of tags to set for the ElastiCache Replication Group.
400400
<!-- ##DOCS-SOURCER-START
401401
{
402402
"originalSources": [
403-
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/memcached/readme.md",
404-
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/memcached/variables.tf",
405-
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/memcached/outputs.tf"
403+
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/memcached/readme.md",
404+
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/memcached/variables.tf",
405+
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/memcached/outputs.tf"
406406
],
407407
"sourcePlugin": "module-catalog-api",
408-
"hash": "2a6331355ddb0fb55ca9a0eacf0f41e9"
408+
"hash": "97247b0383b7dfe517c5eda47ae24d9a"
409409
}
410410
##DOCS-SOURCER-END -->

‎docs/reference/modules/terraform-aws-cache/redis/redis.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="Cache Modules" version="1.0.2" lastModifiedVersion="1.0.1"/>
12+
<VersionBadge repoTitle="Cache Modules" version="1.0.3" lastModifiedVersion="1.0.1"/>
1313

1414
# Redis Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/redis" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/redis" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

1818
<a href="https://github.com/gruntwork-io/terraform-aws-cache/releases/tag/v1.0.1" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -84,7 +84,7 @@ here: https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/ParameterGroup
8484
#### Choosing Cluster Mode vs. Single Instance
8585

8686
You can use `var.enable_single_instance_mode=true` to deploy a single node Redis instance. Refer
87-
to [examples/redis_single_instance](https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/examples/redis_single_instance) as an example.
87+
to [examples/redis_single_instance](https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/examples/redis_single_instance) as an example.
8888

8989
Here are some of the points you may consider while choosing which mode to run:
9090

@@ -243,7 +243,7 @@ ElastiCache for Redis supports the following types of automatic scaling dimensio
243243
244244
module "redis" {
245245
246-
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/redis?ref=v1.0.2"
246+
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/redis?ref=v1.0.3"
247247
248248
# ----------------------------------------------------------------------------------------------------
249249
# REQUIRED VARIABLES
@@ -479,7 +479,7 @@ module "redis" {
479479
# ------------------------------------------------------------------------------------------------------
480480
481481
terraform {
482-
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/redis?ref=v1.0.2"
482+
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/redis?ref=v1.0.3"
483483
}
484484
485485
inputs = {
@@ -1249,11 +1249,11 @@ This is a list of user IDs that should be added to the group defined in the 'us
12491249
<!-- ##DOCS-SOURCER-START
12501250
{
12511251
"originalSources": [
1252-
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/redis/readme.md",
1253-
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/redis/variables.tf",
1254-
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/redis/outputs.tf"
1252+
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/redis/readme.md",
1253+
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/redis/variables.tf",
1254+
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/redis/outputs.tf"
12551255
],
12561256
"sourcePlugin": "module-catalog-api",
1257-
"hash": "7e1a1c9f92a559bfab96355250e573d2"
1257+
"hash": "29bd087b17f380460a735f3621dfe851"
12581258
}
12591259
##DOCS-SOURCER-END -->

‎docs/reference/modules/terraform-aws-cache/redis_copy_snapshot/redis_copy_snapshot.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="Cache Modules" version="1.0.2" lastModifiedVersion="0.22.8"/>
12+
<VersionBadge repoTitle="Cache Modules" version="1.0.3" lastModifiedVersion="0.22.8"/>
1313

1414
# Redis Copy Snapshot Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/redis_copy_snapshot" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/redis_copy_snapshot" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

1818
<a href="https://github.com/gruntwork-io/terraform-aws-cache/releases/tag/v0.22.8" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -45,7 +45,7 @@ instruction: [Making manual backups](https://docs.aws.amazon.com/AmazonElastiCac
4545
The caller of the module needs to have the appropriate permission on the s3 bucket and the elastic cache cluster. The
4646
detailed permission requirement is explained in detail
4747
here: [Exporting a backup](https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-exporting.html) page.
48-
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.
48+
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.
4949

5050
## Encryption Limitation
5151

@@ -69,7 +69,7 @@ try to export a snapshot encrypted with CMK (Customer Managed Key), you will get
6969
7070
module "redis_copy_snapshot" {
7171
72-
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/redis_copy_snapshot?ref=v1.0.2"
72+
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/redis_copy_snapshot?ref=v1.0.3"
7373
7474
# ----------------------------------------------------------------------------------------------------
7575
# REQUIRED VARIABLES
@@ -112,7 +112,7 @@ module "redis_copy_snapshot" {
112112
# ------------------------------------------------------------------------------------------------------
113113
114114
terraform {
115-
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/redis_copy_snapshot?ref=v1.0.2"
115+
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/redis_copy_snapshot?ref=v1.0.3"
116116
}
117117
118118
inputs = {
@@ -216,11 +216,11 @@ A name for the exported snapshot copy. ElastiCache does not permit overwriting a
216216
<!-- ##DOCS-SOURCER-START
217217
{
218218
"originalSources": [
219-
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/redis_copy_snapshot/readme.md",
220-
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/redis_copy_snapshot/variables.tf",
221-
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/redis_copy_snapshot/outputs.tf"
219+
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/redis_copy_snapshot/readme.md",
220+
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/redis_copy_snapshot/variables.tf",
221+
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/redis_copy_snapshot/outputs.tf"
222222
],
223223
"sourcePlugin": "module-catalog-api",
224-
"hash": "77c2d123ec8197b162aa420139cd5074"
224+
"hash": "6e6f30e090aed9874faffdf3a47a8ba2"
225225
}
226226
##DOCS-SOURCER-END -->

‎docs/reference/modules/terraform-aws-cache/valkey/valkey.md‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx';
99
import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx';
1010
import { ModuleUsage } from "../../../../../src/components/ModuleUsage";
1111

12-
<VersionBadge repoTitle="Cache Modules" version="1.0.2" lastModifiedVersion="1.0.1"/>
12+
<VersionBadge repoTitle="Cache Modules" version="1.0.3" lastModifiedVersion="1.0.1"/>
1313

1414
# Valkey Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/valkey" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
16+
<a href="https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/valkey" className="link-button" title="View the source code for this module in GitHub.">View Source</a>
1717

1818
<a href="https://github.com/gruntwork-io/terraform-aws-cache/releases/tag/v1.0.1" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -240,7 +240,7 @@ ElastiCache for Valkey supports the following types of automatic scaling dimensi
240240
241241
module "valkey" {
242242
243-
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/valkey?ref=v1.0.2"
243+
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/valkey?ref=v1.0.3"
244244
245245
# ----------------------------------------------------------------------------------------------------
246246
# REQUIRED VARIABLES
@@ -473,7 +473,7 @@ module "valkey" {
473473
# ------------------------------------------------------------------------------------------------------
474474
475475
terraform {
476-
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/valkey?ref=v1.0.2"
476+
source = "git::[email protected]:gruntwork-io/terraform-aws-cache.git//modules/valkey?ref=v1.0.3"
477477
}
478478
479479
inputs = {
@@ -1219,11 +1219,11 @@ Version number of valkey to use (e.g. 7.2).
12191219
<!-- ##DOCS-SOURCER-START
12201220
{
12211221
"originalSources": [
1222-
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/valkey/readme.md",
1223-
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/valkey/variables.tf",
1224-
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.2/modules/valkey/outputs.tf"
1222+
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/valkey/readme.md",
1223+
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/valkey/variables.tf",
1224+
"https://github.com/gruntwork-io/terraform-aws-cache/tree/v1.0.3/modules/valkey/outputs.tf"
12251225
],
12261226
"sourcePlugin": "module-catalog-api",
1227-
"hash": "1d50707556871a35a55ebffcc93a9839"
1227+
"hash": "8a273aad27e8a163682465dc04aad2ee"
12281228
}
12291229
##DOCS-SOURCER-END -->

0 commit comments

Comments
 (0)