Skip to content

[Automated Update][terraform-aws-data-storage] v1.0.0 release #3081

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

Open
docs-sourcer wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[Automated Update][terraform-aws-data-storage] v1.0.0 release #3081

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
94 changes: 82 additions & 12 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.47.0" lastModifiedVersion="0.47.0"/>
<VersionBadge repoTitle="Data Storage Modules" version="1.0.0" lastModifiedVersion="1.0.0"/>

# Aurora Module

<a href="https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.47.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/tree/v1.0.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.47.0" 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/v1.0.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.47.0/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/v1.0.0/modules/aurora/variables.tf).

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

Expand All @@ -68,7 +68,7 @@ the primary cluster:

```hcl-terraform
module "replica" {
source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/aurora?ref=v1.0.8"
source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/aurora?ref=v1.0.0"

# ... other parameters omitted ...

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

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

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

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

inputs = {
Expand Down Expand Up @@ -1900,45 +1900,115 @@ Timeout for DB updating
<TabItem value="outputs" label="Outputs">

<HclListItem name="cluster_arn">
<HclListItemDescription>

The ARN of the Aurora cluster.

</HclListItemDescription>
</HclListItem>

<HclListItem name="cluster_endpoint">
<HclListItemDescription>

The connection endpoint for the primary (writer) instance of the Aurora cluster.

</HclListItemDescription>
</HclListItem>

<HclListItem name="cluster_id">
<HclListItemDescription>

The DB cluster identifier (name), e.g. 'my-aurora-cluster'.

</HclListItemDescription>
</HclListItem>

<HclListItem name="cluster_instances_maintenance_window">
<HclListItemDescription>

The maintenance window for each Aurora cluster instance.

</HclListItemDescription>
</HclListItem>

<HclListItem name="cluster_master_password_secret_arn">
<HclListItemDescription>

The ARN of the Secrets Manager secret containing the master user password, when manage_master_user_password is enabled.

</HclListItemDescription>
</HclListItem>

<HclListItem name="cluster_resource_id">
<HclListItemDescription>

The unique resource ID assigned to the cluster (e.g. 'cluster-POBCBQUFQC56EBAAWXGFJ77GRU'). Useful for IAM database authentication.

</HclListItemDescription>
</HclListItem>

<HclListItem name="db_name">
<HclListItemDescription>

The name of the database created in the Aurora cluster.

</HclListItemDescription>
</HclListItem>

<HclListItem name="instance_endpoints">
<HclListItemDescription>

A list of endpoints for each Aurora cluster instance.

</HclListItemDescription>
</HclListItem>

<HclListItem name="instance_ids">
<HclListItemDescription>

A list of identifiers for all Aurora cluster instances.

</HclListItemDescription>
</HclListItem>

<HclListItem name="port">
<HclListItemDescription>

The port number on which the Aurora cluster accepts connections.

</HclListItemDescription>
</HclListItem>

<HclListItem name="read_replica_instance_ids">
<HclListItemDescription>

A list of identifiers for Aurora cluster instances that are read replicas (non-writer).

</HclListItemDescription>
</HclListItem>

<HclListItem name="reader_endpoint">
<HclListItemDescription>

A read-only endpoint that load-balances connections across the Aurora read replicas.

</HclListItemDescription>
</HclListItem>

<HclListItem name="security_group_id">
<HclListItemDescription>

The ID of the security group created for the Aurora cluster.

</HclListItemDescription>
</HclListItem>

<HclListItem name="write_replica_instance_ids">
<HclListItemDescription>

A list of identifiers for Aurora cluster instances that are writers.

</HclListItemDescription>
</HclListItem>

</TabItem>
Expand All @@ -1947,11 +2017,11 @@ Timeout for DB updating
<!-- ##DOCS-SOURCER-START
{
"originalSources": [
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.47.0/modules/aurora/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.47.0/modules/aurora/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.47.0/modules/aurora/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v1.0.0/modules/aurora/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v1.0.0/modules/aurora/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v1.0.0/modules/aurora/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "d9ddfe7a13ffe98884fc909b1a245159"
"hash": "0a1fd90ddc3e7bebad669bd05f995478"
}
##DOCS-SOURCER-END -->
26 changes: 13 additions & 13 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,20 +9,20 @@ 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.47.0" lastModifiedVersion="0.47.0"/>
<VersionBadge repoTitle="Data Storage Modules" version="1.0.0" lastModifiedVersion="1.0.0"/>

# Backup Plan Module

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

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.47.0/modules/backup-vault).
You associate your plans with a [Backup vault](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v1.0.0/modules/backup-vault).

## What is a Backup Plan?

Expand Down Expand Up @@ -50,7 +50,7 @@ module "backup_plan" {
plans = {
"tag-based-backup-plan" = {
rule = {
target_vault_name = element(module.backup_vault.vault_names, 0),
target_vault_name = values(module.backup_vault.vault_names)[0],
schedule = "cron(47 0/1 * * ? *)"
}
selection = {
Expand All @@ -77,7 +77,7 @@ module "backup_plan" {
plans = {
"tag-based-backup-plan" = {
rule = {
target_vault_name = element(module.backup_vault.vault_names, 0),
target_vault_name = values(module.backup_vault.vault_names)[0],
schedule = "cron(47 0/1 * * ? *)"
}
resources = [
Expand All @@ -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.47.0/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/v1.0.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.47.0"
source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/backup-plan?ref=v1.0.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.47.0"
source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/backup-plan?ref=v1.0.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.47.0/modules/backup-plan/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.47.0/modules/backup-plan/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.47.0/modules/backup-plan/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v1.0.0/modules/backup-plan/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v1.0.0/modules/backup-plan/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v1.0.0/modules/backup-plan/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "317a849be7b1cae8888d4a32fcf0be98"
"hash": "54cef305ff9e0cbecd9a1f05c699346d"
}
##DOCS-SOURCER-END -->
18 changes: 9 additions & 9 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,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.47.0" lastModifiedVersion="0.47.0"/>
<VersionBadge repoTitle="Data Storage Modules" version="1.0.0" lastModifiedVersion="1.0.0"/>

# Backup Vault Module

<a href="https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.47.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/tree/v1.0.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.47.0" 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/v1.0.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 @@ -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.47.0"
source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v1.0.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.47.0"
source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/backup-vault?ref=v1.0.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.47.0/modules/backup-vault/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.47.0/modules/backup-vault/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.47.0/modules/backup-vault/outputs.tf"
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v1.0.0/modules/backup-vault/readme.md",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v1.0.0/modules/backup-vault/variables.tf",
"https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v1.0.0/modules/backup-vault/outputs.tf"
],
"sourcePlugin": "module-catalog-api",
"hash": "48d62b6f3341069280fa4a790eedf6fe"
"hash": "839a2be4b98746b0280bde3633e054b4"
}
##DOCS-SOURCER-END -->
Loading