Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 62 additions & 18 deletions docs/reference/modules/terraform-aws-data-storage/aurora/aurora.md
Original file line number Diff line number Diff line change
Expand Up @@ -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";

<VersionBadge repoTitle="Data Storage Modules" version="0.41.1" lastModifiedVersion="0.41.1"/>
<VersionBadge repoTitle="Data Storage Modules" version="0.42.0" lastModifiedVersion="0.42.0"/>

# Aurora Module

<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>
<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>

<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>
<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>

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

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

This module allows you to configure a number of parameters, such as backup windows, maintenance window, port number,
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).
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).

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

Expand All @@ -77,7 +77,7 @@ module "replica" {
}
```

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.
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.

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

Expand Down Expand Up @@ -137,7 +137,7 @@ see [Limitations of Aurora Serverless](https://docs.aws.amazon.com/AmazonRDS/lat

module "aurora" {

source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/aurora?ref=v0.41.1"
source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/aurora?ref=v0.42.0"

# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
Expand Down Expand Up @@ -240,6 +240,13 @@ module "aurora" {
# instances
cluster_instances_minutes_between_maintenance_windows = 180

# 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.
cluster_monitoring_interval = null

# Specifies whether cluster level Performance Insights is enabled or not. On
# Aurora MySQL, Performance Insights is not supported on db.t2 or db.t3 DB
# instance classes.
Expand Down Expand Up @@ -288,9 +295,11 @@ module "aurora" {
# Aurora DB cluster.
db_instance_parameter_group_name = null

# 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.
# 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.
db_name = null

# If true, delete all automated backups when the DB cluster is deleted. If
Expand Down Expand Up @@ -482,6 +491,10 @@ module "aurora" {
# paused. Valid values are 300 through 86400.
scaling_configuration_seconds_until_auto_pause = 300

# The time, in seconds, before an Aurora DB cluster in serverless mode is
# paused. Valid values are 300 through 86400.
scaling_configuration_seconds_until_auto_pause_V2 = 300

# The action to take when the timeout is reached. Valid values:
# ForceApplyCapacityChange, RollbackCapacityChange. Defaults to
# RollbackCapacityChange.
Expand Down Expand Up @@ -530,7 +543,7 @@ module "aurora" {
# ------------------------------------------------------------------------------------------------------

terraform {
source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/aurora?ref=v0.41.1"
source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/aurora?ref=v0.42.0"
}

inputs = {
Expand Down Expand Up @@ -636,6 +649,13 @@ inputs = {
# instances
cluster_instances_minutes_between_maintenance_windows = 180

# 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.
cluster_monitoring_interval = null

# Specifies whether cluster level Performance Insights is enabled or not. On
# Aurora MySQL, Performance Insights is not supported on db.t2 or db.t3 DB
# instance classes.
Expand Down Expand Up @@ -684,9 +704,11 @@ inputs = {
# Aurora DB cluster.
db_instance_parameter_group_name = null

# 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.
# 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.
db_name = null

# If true, delete all automated backups when the DB cluster is deleted. If
Expand Down Expand Up @@ -878,6 +900,10 @@ inputs = {
# paused. Valid values are 300 through 86400.
scaling_configuration_seconds_until_auto_pause = 300

# The time, in seconds, before an Aurora DB cluster in serverless mode is
# paused. Valid values are 300 through 86400.
scaling_configuration_seconds_until_auto_pause_V2 = 300

# The action to take when the timeout is reached. Valid values:
# ForceApplyCapacityChange, RollbackCapacityChange. Defaults to
# RollbackCapacityChange.
Expand Down Expand Up @@ -1115,6 +1141,15 @@ Amount of time, in minutes, between maintenance windows of the cluster instances
<HclListItemDefaultValue defaultValue="180"/>
</HclListItem>

<HclListItem name="cluster_monitoring_interval" requirement="optional" type="number">
<HclListItemDescription>

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.

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="null"/>
</HclListItem>

<HclListItem name="cluster_performance_insights_enabled" requirement="optional" type="bool">
<HclListItemDescription>

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

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.
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.

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

<HclListItem name="scaling_configuration_seconds_until_auto_pause_V2" requirement="optional" type="number">
<HclListItemDescription>

The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Valid values are 300 through 86400.

</HclListItemDescription>
<HclListItemDefaultValue defaultValue="300"/>
</HclListItem>

<HclListItem name="scaling_configuration_timeout_action" requirement="optional" type="string">
<HclListItemDescription>

Expand Down Expand Up @@ -1706,11 +1750,11 @@ Timeout for DB updating
<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/aurora/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/aurora/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/aurora/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/aurora/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/aurora/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/aurora/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "fd9d080cf4f56179ff6e3c79fbe20415"
"hash": "927c554cd27e115ac72c8bcb6166ada2"
}
##DOCS-SOURCER-END -->
Original file line number Diff line number Diff line change
Expand Up @@ -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";

<VersionBadge repoTitle="Data Storage Modules" version="0.41.1" lastModifiedVersion="0.38.1"/>
<VersionBadge repoTitle="Data Storage Modules" version="0.42.0" lastModifiedVersion="0.38.1"/>

# Backup Plan Module

<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>
<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>

<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>

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

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

## What is a Backup Plan?

Expand Down Expand Up @@ -91,7 +91,7 @@ module "backup_plan" {

## How do you troubleshoot Backup jobs?

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.
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.

## Sample Usage

Expand All @@ -106,7 +106,7 @@ See [Troubleshooting AWS Backup](https://github.com/gruntwork-io/terraform-aws-d

module "backup_plan" {

source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/backup-plan?ref=v0.41.1"
source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/backup-plan?ref=v0.42.0"

# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
Expand Down Expand Up @@ -137,7 +137,7 @@ module "backup_plan" {
# ------------------------------------------------------------------------------------------------------

terraform {
source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/backup-plan?ref=v0.41.1"
source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/backup-plan?ref=v0.42.0"
}

inputs = {
Expand Down Expand Up @@ -244,11 +244,11 @@ The ARN of the IAM service role used by Backup plans
<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/backup-plan/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/backup-plan/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/backup-plan/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/backup-plan/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/backup-plan/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/backup-plan/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "9ade0a30115cc6810ec8bb4fb67865ea"
"hash": "3e95681f6b9e8b4005af95adbf0bdfda"
}
##DOCS-SOURCER-END -->
Original file line number Diff line number Diff line change
Expand Up @@ -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";

<VersionBadge repoTitle="Data Storage Modules" version="0.41.1" lastModifiedVersion="0.41.0"/>
<VersionBadge repoTitle="Data Storage Modules" version="0.42.0" lastModifiedVersion="0.41.0"/>

# Backup Vault Module

<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>
<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>

<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>

Expand Down Expand Up @@ -115,7 +115,7 @@ then you will end up with many potentially large recovery points that you cannot

module "backup_vault" {

source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v0.41.1"
source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v0.42.0"

# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
Expand Down Expand Up @@ -159,7 +159,7 @@ module "backup_vault" {
# ------------------------------------------------------------------------------------------------------

terraform {
source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v0.41.1"
source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v0.42.0"
}

inputs = {
Expand Down Expand Up @@ -322,11 +322,11 @@ A map of tags assigned to the vault resources, including those inherited from th
<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/backup-vault/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/backup-vault/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/backup-vault/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/backup-vault/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/backup-vault/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/backup-vault/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "5d45b7c565c725ff2f20372a6abf82cf"
"hash": "d21ddc9b351f4ff57dcec15b6fb4e09c"
}
##DOCS-SOURCER-END -->
Loading