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
20 changes: 10 additions & 10 deletions docs/reference/modules/terraform-aws-data-storage/aurora/aurora.md
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.7" lastModifiedVersion="0.40.7"/>
<VersionBadge repoTitle="Data Storage Modules" version="0.41.0" lastModifiedVersion="0.40.7"/>

# Aurora Module

<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/tree/v0.41.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.40.7" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>

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

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

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

inputs = {
Expand Down Expand Up @@ -1685,11 +1685,11 @@ Timeout for DB updating
<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"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"
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.0/modules/aurora/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.0/modules/aurora/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.0/modules/aurora/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "c66dffd2860778ca39d0e3463f6734d8"
"hash": "074f65534703a5b9affef27a3a09066d"
}
##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.40.7" lastModifiedVersion="0.38.1"/>
<VersionBadge repoTitle="Data Storage Modules" version="0.41.0" lastModifiedVersion="0.38.1"/>

# Backup Plan Module

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

# ----------------------------------------------------------------------------------------------------
# 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.7"
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-plan?ref=v0.41.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.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"
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.0/modules/backup-plan/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.0/modules/backup-plan/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.0/modules/backup-plan/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "266c816e330d20ca0be65f72e409cfed"
"hash": "d0c680cc10533b0823b712fa97a1ef22"
}
##DOCS-SOURCER-END -->
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.7" lastModifiedVersion="0.38.1"/>
<VersionBadge repoTitle="Data Storage Modules" version="0.41.0" lastModifiedVersion="0.41.0"/>

# Backup Vault Module

<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/tree/v0.41.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.38.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.41.0" className="link-button" title="Release notes for only versions which impacted this module.">Release Notes</a>

This Terraform Module launches a [Backup Vault](https://docs.aws.amazon.com/aws-backup/latest/devguide/vaults.html) that you can use to store, organize and, optionally, preserve your AWS Backup recovery points against deletion.

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.7"
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v0.41.0"

# ----------------------------------------------------------------------------------------------------
# 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.7"
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v0.41.0"
}

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.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"
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.0/modules/backup-vault/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.0/modules/backup-vault/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.0/modules/backup-vault/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "c5d2cd07ebcbddc7834580f0fb0cd0c8"
"hash": "a3f058d02fab45591e078eef3eba4873"
}
##DOCS-SOURCER-END -->
16 changes: 8 additions & 8 deletions docs/reference/modules/terraform-aws-data-storage/dms/dms.md
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.7" lastModifiedVersion="0.40.3"/>
<VersionBadge repoTitle="Data Storage Modules" version="0.41.0" lastModifiedVersion="0.40.3"/>

# DMS Module

<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/tree/v0.41.0/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.7"
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/dms?ref=v0.41.0"

# ----------------------------------------------------------------------------------------------------
# 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.7"
source = "git::[email protected]:gruntwork-io/terraform-aws-data-storage.git//modules/dms?ref=v0.41.0"
}

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.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"
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.0/modules/dms/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.0/modules/dms/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.0/modules/dms/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "afcecf2c7e022dbd2adf14de22aef96d"
"hash": "202e7e55677c11ee2ddaaec7f20f5e06"
}
##DOCS-SOURCER-END -->
20 changes: 10 additions & 10 deletions docs/reference/modules/terraform-aws-data-storage/efs/efs.md
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.7" lastModifiedVersion="0.40.5"/>
<VersionBadge repoTitle="Data Storage Modules" version="0.41.0" lastModifiedVersion="0.40.5"/>

# EFS Module

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

Expand Down Expand Up @@ -45,13 +45,13 @@ This repo is a part of [the Gruntwork Infrastructure as Code Library](https://gr

If you just want to try this repo out for experimenting and learning, check out the following resources:

* [examples folder](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.7/examples): The `examples` folder contains sample code optimized for learning, experimenting, and testing (but not production usage).
* [examples folder](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.0/examples): The `examples` folder contains sample code optimized for learning, experimenting, and testing (but not production usage).

### Production deployment

If you want to deploy this repo in production, check out the following resources:

* [efs module variables](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.7/modules/efs/variables.tf): Configuration variables available for the EFS module. At minimum, you should configure the `allow_connections_from_cidr_blocks` and `allow_connections_from_security_groups` values to only allow access from your private VPC(s). You may also want to enable `storage_encrypted` to encrypt data at-rest.
* [efs module variables](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.0/modules/efs/variables.tf): Configuration variables available for the EFS module. At minimum, you should configure the `allow_connections_from_cidr_blocks` and `allow_connections_from_security_groups` values to only allow access from your private VPC(s). You may also want to enable `storage_encrypted` to encrypt data at-rest.

## Manage

Expand All @@ -74,7 +74,7 @@ If you want to deploy this repo in production, check out the following resources

module "efs" {

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

# ----------------------------------------------------------------------------------------------------
# REQUIRED VARIABLES
Expand Down Expand Up @@ -187,7 +187,7 @@ module "efs" {
# ------------------------------------------------------------------------------------------------------

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

inputs = {
Expand Down Expand Up @@ -586,11 +586,11 @@ The IDs of the security groups created for the file system.
<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.7/modules/efs/readme.adoc",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.7/modules/efs/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.40.7/modules/efs/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.0/modules/efs/readme.adoc",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.0/modules/efs/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.0/modules/efs/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "f1451a070ba5dc1a9e289fbb274ef9fb"
"hash": "5b940f3ad7b97933d68bf3df3d2103c4"
}
##DOCS-SOURCER-END -->
Loading