Skip to content

Commit 7e88a1f

Browse files
docs-sourcer[bot]docs-sourcer[bot]
authored
Co-authored-by: docs-sourcer[bot] <99042413+docs-sourcer[bot]@users.noreply.github.com>
1 parent d5932db commit 7e88a1f

File tree

14 files changed

+365
-186
lines changed

14 files changed

+365
-186
lines changed

‎docs/reference/modules/terraform-aws-data-storage/aurora/aurora.md‎

Lines changed: 62 additions & 18 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="Data Storage Modules" version="0.41.1" lastModifiedVersion="0.41.1"/>
12+
<VersionBadge repoTitle="Data Storage Modules" version="0.42.0" lastModifiedVersion="0.42.0"/>
1313

1414
# Aurora Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/aurora" 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-data-storage/tree/v0.42.0/modules/aurora" 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-data-storage/releases/tag/v0.41.1" 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-data-storage/releases/tag/v0.42.0" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

2020
This module creates an Amazon Aurora, a MySQL and PostgreSQL compatible relational database built for the cloud.
2121

@@ -59,7 +59,7 @@ Cluster](http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Aurora.Managing.h
5959
## How do you configure this module?
6060

6161
This module allows you to configure a number of parameters, such as backup windows, maintenance window, port number,
62-
and encryption. For a list of all available variables and their descriptions, see [variables.tf](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/aurora/variables.tf).
62+
and encryption. For a list of all available variables and their descriptions, see [variables.tf](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/aurora/variables.tf).
6363

6464
## How do you create a cross-region read replica cluster?
6565

@@ -77,7 +77,7 @@ module "replica" {
7777
}
7878
```
7979

80-
See the example [here](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/examples/aurora-with-cross-region-replica) for more details.
80+
See the example [here](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/examples/aurora-with-cross-region-replica) for more details.
8181

8282
## How do you destroy a cross-region read replica?
8383

@@ -137,7 +137,7 @@ see [Limitations of Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/lat
137137
138138
module "aurora" {
139139
140-
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/aurora?ref=v0.41.1"
140+
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/aurora?ref=v0.42.0"
141141
142142
# ----------------------------------------------------------------------------------------------------
143143
# REQUIRED VARIABLES
@@ -240,6 +240,13 @@ module "aurora" {
240240
# instances
241241
cluster_instances_minutes_between_maintenance_windows = 180
242242
243+
# The interval, in seconds, between points when Enhanced Monitoring metrics
244+
# are collected for the cluster instances. To disable collecting Enhanced
245+
# Monitoring metrics, specify 0. Allowed values: 0, 1, 5, 15, 30, 60. Enhanced
246+
# Monitoring metrics are useful when you want to see how different processes
247+
# or threads on a DB instance use the CPU.
248+
cluster_monitoring_interval = null
249+
243250
# Specifies whether cluster level Performance Insights is enabled or not. On
244251
# Aurora MySQL, Performance Insights is not supported on db.t2 or db.t3 DB
245252
# instance classes.
@@ -288,9 +295,11 @@ module "aurora" {
288295
# Aurora DB cluster.
289296
db_instance_parameter_group_name = null
290297
291-
# The name for your database of up to 8 alpha-numeric characters. If you do
292-
# not provide a name, Amazon RDS will not create a database in the DB cluster
293-
# you are creating.
298+
# The name for your database. Must contain 1-64 alphanumeric characters for
299+
# Aurora MySQL, 1-63 for Aurora PostgreSQL. Must begin with a letter.
300+
# Subsequent characters can be letters, underscores, or digits. Cannot be a
301+
# reserved word. If you do not provide a name, Amazon RDS will not create a
302+
# database in the DB cluster you are creating.
294303
db_name = null
295304
296305
# If true, delete all automated backups when the DB cluster is deleted. If
@@ -482,6 +491,10 @@ module "aurora" {
482491
# paused. Valid values are 300 through 86400.
483492
scaling_configuration_seconds_until_auto_pause = 300
484493
494+
# The time, in seconds, before an Aurora DB cluster in serverless mode is
495+
# paused. Valid values are 300 through 86400.
496+
scaling_configuration_seconds_until_auto_pause_V2 = 300
497+
485498
# The action to take when the timeout is reached. Valid values:
486499
# ForceApplyCapacityChange, RollbackCapacityChange. Defaults to
487500
# RollbackCapacityChange.
@@ -530,7 +543,7 @@ module "aurora" {
530543
# ------------------------------------------------------------------------------------------------------
531544
532545
terraform {
533-
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/aurora?ref=v0.41.1"
546+
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/aurora?ref=v0.42.0"
534547
}
535548
536549
inputs = {
@@ -636,6 +649,13 @@ inputs = {
636649
# instances
637650
cluster_instances_minutes_between_maintenance_windows = 180
638651
652+
# The interval, in seconds, between points when Enhanced Monitoring metrics
653+
# are collected for the cluster instances. To disable collecting Enhanced
654+
# Monitoring metrics, specify 0. Allowed values: 0, 1, 5, 15, 30, 60. Enhanced
655+
# Monitoring metrics are useful when you want to see how different processes
656+
# or threads on a DB instance use the CPU.
657+
cluster_monitoring_interval = null
658+
639659
# Specifies whether cluster level Performance Insights is enabled or not. On
640660
# Aurora MySQL, Performance Insights is not supported on db.t2 or db.t3 DB
641661
# instance classes.
@@ -684,9 +704,11 @@ inputs = {
684704
# Aurora DB cluster.
685705
db_instance_parameter_group_name = null
686706
687-
# The name for your database of up to 8 alpha-numeric characters. If you do
688-
# not provide a name, Amazon RDS will not create a database in the DB cluster
689-
# you are creating.
707+
# The name for your database. Must contain 1-64 alphanumeric characters for
708+
# Aurora MySQL, 1-63 for Aurora PostgreSQL. Must begin with a letter.
709+
# Subsequent characters can be letters, underscores, or digits. Cannot be a
710+
# reserved word. If you do not provide a name, Amazon RDS will not create a
711+
# database in the DB cluster you are creating.
690712
db_name = null
691713
692714
# If true, delete all automated backups when the DB cluster is deleted. If
@@ -878,6 +900,10 @@ inputs = {
878900
# paused. Valid values are 300 through 86400.
879901
scaling_configuration_seconds_until_auto_pause = 300
880902
903+
# The time, in seconds, before an Aurora DB cluster in serverless mode is
904+
# paused. Valid values are 300 through 86400.
905+
scaling_configuration_seconds_until_auto_pause_V2 = 300
906+
881907
# The action to take when the timeout is reached. Valid values:
882908
# ForceApplyCapacityChange, RollbackCapacityChange. Defaults to
883909
# RollbackCapacityChange.
@@ -1115,6 +1141,15 @@ Amount of time, in minutes, between maintenance windows of the cluster instances
11151141
<HclListItemDefaultValue defaultValue="180"/>
11161142
</HclListItem>
11171143

1144+
<HclListItem name="cluster_monitoring_interval" requirement="optional" type="number">
1145+
<HclListItemDescription>
1146+
1147+
The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the cluster instances. To disable collecting Enhanced Monitoring metrics, specify 0. Allowed values: 0, 1, 5, 15, 30, 60. Enhanced Monitoring metrics are useful when you want to see how different processes or threads on a DB instance use the CPU.
1148+
1149+
</HclListItemDescription>
1150+
<HclListItemDefaultValue defaultValue="null"/>
1151+
</HclListItem>
1152+
11181153
<HclListItem name="cluster_performance_insights_enabled" requirement="optional" type="bool">
11191154
<HclListItemDescription>
11201155

@@ -1217,7 +1252,7 @@ An instance parameter group to associate with the cluster instances. Parameters
12171252
<HclListItem name="db_name" requirement="optional" type="string">
12181253
<HclListItemDescription>
12191254

1220-
The name for your database of up to 8 alpha-numeric characters. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.
1255+
The name for your database. Must contain 1-64 alphanumeric characters for Aurora MySQL, 1-63 for Aurora PostgreSQL. Must begin with a letter. Subsequent characters can be letters, underscores, or digits. Cannot be a reserved word. If you do not provide a name, Amazon RDS will not create a database in the DB cluster you are creating.
12211256

12221257
</HclListItemDescription>
12231258
<HclListItemDefaultValue defaultValue="null"/>
@@ -1592,6 +1627,15 @@ The time, in seconds, before an Aurora DB cluster in serverless mode is paused.
15921627
<HclListItemDefaultValue defaultValue="300"/>
15931628
</HclListItem>
15941629

1630+
<HclListItem name="scaling_configuration_seconds_until_auto_pause_V2" requirement="optional" type="number">
1631+
<HclListItemDescription>
1632+
1633+
The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Valid values are 300 through 86400.
1634+
1635+
</HclListItemDescription>
1636+
<HclListItemDefaultValue defaultValue="300"/>
1637+
</HclListItem>
1638+
15951639
<HclListItem name="scaling_configuration_timeout_action" requirement="optional" type="string">
15961640
<HclListItemDescription>
15971641

@@ -1706,11 +1750,11 @@ Timeout for DB updating
17061750
<!-- ##DOCS-SOURCER-START
17071751
{
17081752
"originalSources": [
1709-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/aurora/readme.md",
1710-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/aurora/variables.tf",
1711-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/aurora/outputs.tf"
1753+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/aurora/readme.md",
1754+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/aurora/variables.tf",
1755+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/aurora/outputs.tf"
17121756
],
17131757
"sourcePlugin": "module-catalog-api",
1714-
"hash": "fd9d080cf4f56179ff6e3c79fbe20415"
1758+
"hash": "927c554cd27e115ac72c8bcb6166ada2"
17151759
}
17161760
##DOCS-SOURCER-END -->

‎docs/reference/modules/terraform-aws-data-storage/backup-plan/backup-plan.md‎

Lines changed: 10 additions & 10 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="Data Storage Modules" version="0.41.1" lastModifiedVersion="0.38.1"/>
12+
<VersionBadge repoTitle="Data Storage Modules" version="0.42.0" lastModifiedVersion="0.38.1"/>
1313

1414
# Backup Plan Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/backup-plan" 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-data-storage/tree/v0.42.0/modules/backup-plan" 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-data-storage/releases/tag/v0.38.1" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -22,7 +22,7 @@ This Terraform Module creates the following AWS Backup resources:
2222
1. Backup plans - specifying **how and when** to back things up
2323
2. Resource selections - specifying **which resources** to back up
2424

25-
You associate your plans with a [Backup vault](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/backup-vault).
25+
You associate your plans with a [Backup vault](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/backup-vault).
2626

2727
## What is a Backup Plan?
2828

@@ -91,7 +91,7 @@ module "backup_plan" {
9191

9292
## How do you troubleshoot Backup jobs?
9393

94-
See [Troubleshooting AWS Backup](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/core-concepts.md#troubleshooting-aws-backup) in the core-concepts guide.
94+
See [Troubleshooting AWS Backup](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/core-concepts.md#troubleshooting-aws-backup) in the core-concepts guide.
9595

9696
## Sample Usage
9797

@@ -106,7 +106,7 @@ See [Troubleshooting AWS Backup](https://github.com/gruntwork-io/terraform-aws-d
106106
107107
module "backup_plan" {
108108
109-
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-plan?ref=v0.41.1"
109+
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-plan?ref=v0.42.0"
110110
111111
# ----------------------------------------------------------------------------------------------------
112112
# REQUIRED VARIABLES
@@ -137,7 +137,7 @@ module "backup_plan" {
137137
# ------------------------------------------------------------------------------------------------------
138138
139139
terraform {
140-
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-plan?ref=v0.41.1"
140+
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-plan?ref=v0.42.0"
141141
}
142142
143143
inputs = {
@@ -244,11 +244,11 @@ The ARN of the IAM service role used by Backup plans
244244
<!-- ##DOCS-SOURCER-START
245245
{
246246
"originalSources": [
247-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/backup-plan/readme.md",
248-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/backup-plan/variables.tf",
249-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/backup-plan/outputs.tf"
247+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/backup-plan/readme.md",
248+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/backup-plan/variables.tf",
249+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/backup-plan/outputs.tf"
250250
],
251251
"sourcePlugin": "module-catalog-api",
252-
"hash": "9ade0a30115cc6810ec8bb4fb67865ea"
252+
"hash": "3e95681f6b9e8b4005af95adbf0bdfda"
253253
}
254254
##DOCS-SOURCER-END -->

‎docs/reference/modules/terraform-aws-data-storage/backup-vault/backup-vault.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="Data Storage Modules" version="0.41.1" lastModifiedVersion="0.41.0"/>
12+
<VersionBadge repoTitle="Data Storage Modules" version="0.42.0" lastModifiedVersion="0.41.0"/>
1313

1414
# Backup Vault Module
1515

16-
<a href="https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/backup-vault" 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-data-storage/tree/v0.42.0/modules/backup-vault" 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-data-storage/releases/tag/v0.41.0" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>
1919

@@ -115,7 +115,7 @@ then you will end up with many potentially large recovery points that you cannot
115115
116116
module "backup_vault" {
117117
118-
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v0.41.1"
118+
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v0.42.0"
119119
120120
# ----------------------------------------------------------------------------------------------------
121121
# REQUIRED VARIABLES
@@ -159,7 +159,7 @@ module "backup_vault" {
159159
# ------------------------------------------------------------------------------------------------------
160160
161161
terraform {
162-
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v0.41.1"
162+
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v0.42.0"
163163
}
164164
165165
inputs = {
@@ -322,11 +322,11 @@ A map of tags assigned to the vault resources, including those inherited from th
322322
<!-- ##DOCS-SOURCER-START
323323
{
324324
"originalSources": [
325-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/backup-vault/readme.md",
326-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/backup-vault/variables.tf",
327-
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/backup-vault/outputs.tf"
325+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/backup-vault/readme.md",
326+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/backup-vault/variables.tf",
327+
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/backup-vault/outputs.tf"
328328
],
329329
"sourcePlugin": "module-catalog-api",
330-
"hash": "5d45b7c565c725ff2f20372a6abf82cf"
330+
"hash": "d21ddc9b351f4ff57dcec15b6fb4e09c"
331331
}
332332
##DOCS-SOURCER-END -->

0 commit comments

Comments
 (0)