Skip to content

[Automated Preview][terraform-aws-data-storage] Air Gapped Vault Support #2671

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed

[Automated Preview][terraform-aws-data-storage] Air Gapped Vault Support #2671

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2cc5c6f
Updated with the [latest changes](https://github.com/gruntwork-io/ter…
docs-sourcer[bot] Jul 28, 2025
05fc0bb
Updated with the [latest changes](https://github.com/gruntwork-io/ter…
docs-sourcer[bot] Aug 13, 2025
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
41 changes: 30 additions & 11 deletions docs/reference/modules/terraform-aws-data-storage/aurora/aurora.md
View file
Open in desktop
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.40.6" lastModifiedVersion="0.40.6"/>
<VersionBadge repoTitle="Data Storage Modules" version="0.40.7" lastModifiedVersion="0.40.7"/>

# Aurora Module

<a href="https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.6/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.40.7/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.40.6" 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.40.7" 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.40.6/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.40.7/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.40.6/examples/aurora-with-cross-region-replica) for more details.
See the example [here](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.7/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::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/aurora?ref=v0.40.6"
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/aurora?ref=v0.40.7"

# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
Expand Down Expand Up @@ -287,6 +287,11 @@ module "aurora" {
# you are creating.
db_name = null

# If true, delete all automated backups when the DB cluster is deleted. If
# false, automated backups are retained until the retention period expires.
# Defaults to true.
delete_automated_backups = null

# Timeout for DB deleting
deleting_timeout = "120m"

Expand Down Expand Up @@ -519,7 +524,7 @@ module "aurora" {
# ------------------------------------------------------------------------------------------------------

terraform {
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/aurora?ref=v0.40.6"
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/aurora?ref=v0.40.7"
}

inputs = {
Expand Down Expand Up @@ -672,6 +677,11 @@ inputs = {
# you are creating.
db_name = null

# If true, delete all automated backups when the DB cluster is deleted. If
# false, automated backups are retained until the retention period expires.
# Defaults to true.
delete_automated_backups = null

# Timeout for DB deleting
deleting_timeout = "120m"

Expand Down Expand Up @@ -1192,6 +1202,15 @@ The name for your database of up to 8 alpha-numeric characters. If you do not pr
<HclListItemDefaultValue defaultValue="null"/>
</HclListItem>

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

If true, delete all automated backups when the DB cluster is deleted. If false, automated backups are retained until the retention period expires. Defaults to true.

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

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

Expand Down Expand Up @@ -1666,11 +1685,11 @@ Timeout for DB updating
<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.6/modules/aurora/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.6/modules/aurora/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.6/modules/aurora/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.7/modules/aurora/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.7/modules/aurora/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.7/modules/aurora/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "fdb921f8de3c227da0f5127529955d13"
"hash": "c66dffd2860778ca39d0e3463f6734d8"
}
##DOCS-SOURCER-END -->
20 changes: 10 additions & 10 deletions docs/reference/modules/terraform-aws-data-storage/backup-plan/backup-plan.md
View file
Open in desktop
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.40.6" lastModifiedVersion="0.38.1"/>
<VersionBadge repoTitle="Data Storage Modules" version="0.40.7" lastModifiedVersion="0.38.1"/>

# Backup Plan Module

<a href="https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.6/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.40.7/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.40.6/modules/backup-vault).
You associate your plans with a [Backup vault](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.7/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.40.6/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.40.7/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::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-plan?ref=v0.40.6"
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-plan?ref=v0.40.7"

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

terraform {
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-plan?ref=v0.40.6"
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-plan?ref=v0.40.7"
}

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.40.6/modules/backup-plan/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.6/modules/backup-plan/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.6/modules/backup-plan/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.7/modules/backup-plan/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.7/modules/backup-plan/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.7/modules/backup-plan/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "eac3e67139fc57a4700c2728f3209764"
"hash": "266c816e330d20ca0be65f72e409cfed"
}
##DOCS-SOURCER-END -->
35 changes: 27 additions & 8 deletions docs/reference/modules/terraform-aws-data-storage/backup-vault/backup-vault.md
View file
Open in desktop
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.40.6" lastModifiedVersion="0.38.1"/>
<VersionBadge repoTitle="Data Storage Modules" version="0.40.7" lastModifiedVersion="0.38.1"/>

# Backup Vault Module

<a href="https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.6/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.40.7/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.38.1" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>

Expand Down Expand Up @@ -51,6 +51,25 @@ module "backup_vault" {
}
```

## How do you create a logically air-gapped vault?

AWS Backup supports logically air-gapped vaults that provide additional protection against ransomware and malicious actors. Air-gapped vaults can only receive recovery points from copy jobs and enforce strict retention policies. To create an air-gapped vault, set the `air_gapped` attribute to true:

```hcl
module "backup_vault" {

vaults = {
"air-gapped-vault" = {
air_gapped = true
min_retention_days = 30
max_retention_days = 120
}
}
}
```

Note: Air-gapped vaults cannot be locked using the vault lock feature and can only receive recovery points through copy actions from other vaults.

## How do you enable vault notifications?

Backup vaults can publish notifications to an SNS topic. This is useful when you want to monitor for any problems with your backup workflows. To enable notifications for a vault when configuring a new vault with this module, set the `enable_notifications` attribute to true like so:
Expand Down Expand Up @@ -96,7 +115,7 @@ then you will end up with many potentially large recovery points that you cannot

module "backup_vault" {

source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v0.40.6"
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v0.40.7"

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

terraform {
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v0.40.6"
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v0.40.7"
}

inputs = {
Expand Down Expand Up @@ -303,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.40.6/modules/backup-vault/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.6/modules/backup-vault/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.6/modules/backup-vault/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.7/modules/backup-vault/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.7/modules/backup-vault/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.7/modules/backup-vault/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "6651e5635d9d33ee85355114613bc64a"
"hash": "caef1793dc224be34ca425449fe06a4b"
}
##DOCS-SOURCER-END -->
16 changes: 8 additions & 8 deletions docs/reference/modules/terraform-aws-data-storage/dms/dms.md
View file
Open in desktop
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.40.6" lastModifiedVersion="0.40.3"/>
<VersionBadge repoTitle="Data Storage Modules" version="0.40.7" lastModifiedVersion="0.40.3"/>

# DMS Module

<a href="https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.6/modules/dms" 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.40.7/modules/dms" 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.40.3" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>

Expand All @@ -32,7 +32,7 @@ This module creates an Amazon Database Migration Service (DMS) that makes it pos

module "dms" {

source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/dms?ref=v0.40.6"
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/dms?ref=v0.40.7"

# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
Expand Down Expand Up @@ -276,7 +276,7 @@ module "dms" {
# ------------------------------------------------------------------------------------------------------

terraform {
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/dms?ref=v0.40.6"
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/dms?ref=v0.40.7"
}

inputs = {
Expand Down Expand Up @@ -1082,11 +1082,11 @@ A map of maps containing the replication tasks created and their full output of
<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.6/modules/dms/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.6/modules/dms/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.6/modules/dms/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.7/modules/dms/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.7/modules/dms/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.7/modules/dms/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "e735783d4377e2c8c69ab2c0bbba6a77"
"hash": "afcecf2c7e022dbd2adf14de22aef96d"
}
##DOCS-SOURCER-END -->
Loading