diff --git a/docs/reference/modules/terraform-aws-data-storage/aurora/aurora.md b/docs/reference/modules/terraform-aws-data-storage/aurora/aurora.md index fb1834473..943f5144c 100644 --- a/docs/reference/modules/terraform-aws-data-storage/aurora/aurora.md +++ b/docs/reference/modules/terraform-aws-data-storage/aurora/aurora.md @@ -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"; - + # Aurora Module -View Source +View Source -Release Notes +Release Notes This module creates an Amazon Aurora, a MySQL and PostgreSQL compatible relational database built for the cloud. @@ -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? @@ -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? @@ -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 @@ -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. @@ -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 @@ -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. @@ -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 = { @@ -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. @@ -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 @@ -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. @@ -1115,6 +1141,15 @@ Amount of time, in minutes, between maintenance windows of the cluster instances + + + +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. + + + + + @@ -1217,7 +1252,7 @@ An instance parameter group to associate with the cluster instances. Parameters -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. @@ -1592,6 +1627,15 @@ The time, in seconds, before an Aurora DB cluster in serverless mode is paused. + + + +The time, in seconds, before an Aurora DB cluster in serverless mode is paused. Valid values are 300 through 86400. + + + + + @@ -1706,11 +1750,11 @@ Timeout for DB updating diff --git a/docs/reference/modules/terraform-aws-data-storage/backup-plan/backup-plan.md b/docs/reference/modules/terraform-aws-data-storage/backup-plan/backup-plan.md index beb2f4b94..6af18f29b 100644 --- a/docs/reference/modules/terraform-aws-data-storage/backup-plan/backup-plan.md +++ b/docs/reference/modules/terraform-aws-data-storage/backup-plan/backup-plan.md @@ -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"; - + # Backup Plan Module -View Source +View Source Release Notes @@ -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? @@ -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 @@ -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 @@ -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 = { @@ -244,11 +244,11 @@ The ARN of the IAM service role used by Backup plans diff --git a/docs/reference/modules/terraform-aws-data-storage/backup-vault/backup-vault.md b/docs/reference/modules/terraform-aws-data-storage/backup-vault/backup-vault.md index a13d88edc..6c1ed6c3d 100644 --- a/docs/reference/modules/terraform-aws-data-storage/backup-vault/backup-vault.md +++ b/docs/reference/modules/terraform-aws-data-storage/backup-vault/backup-vault.md @@ -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"; - + # Backup Vault Module -View Source +View Source Release Notes @@ -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 @@ -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 = { @@ -322,11 +322,11 @@ A map of tags assigned to the vault resources, including those inherited from th diff --git a/docs/reference/modules/terraform-aws-data-storage/dms/dms.md b/docs/reference/modules/terraform-aws-data-storage/dms/dms.md index 382c9f393..5882531e7 100644 --- a/docs/reference/modules/terraform-aws-data-storage/dms/dms.md +++ b/docs/reference/modules/terraform-aws-data-storage/dms/dms.md @@ -9,15 +9,110 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # DMS Module -View Source +View Source Release Notes -This module creates an Amazon Database Migration Service (DMS) that makes it possible to migrate data from one source database to another target database. You can use this module to migrate your data into the AWS Cloud or between combinations of cloud and on-premise setups. Currently, this module only support MySQL, MariaDB, and Aurora MySQL engines as source and target databases. Additional support for more database engines will be added in the future. +This module creates AWS Database Migration Service (DMS) resources for database migration and replication. + +## What This Module Creates + +* DMS replication instance +* Source and target endpoints +* Replication tasks +* Required IAM roles and policies +* CloudWatch log groups +* Security groups for network access + +## Supported Engines + +Currently supports: + +* MySQL +* MariaDB +* Aurora MySQL + +(As source and target) + +## Migration Types + +The module supports three migration types via `migration_type` variable: + +* `full-load` - One-time migration +* `cdc` - Ongoing replication only +* `full-load-and-cdc` - Full migration plus ongoing replication + +## Usage + +```hcl +module "dms" { + source = "../modules/dms" + + name = "my-database-migration" + + # Replication instance + replication_instance_class = "dms.t3.medium" + allocated_storage = 100 + + # Source endpoint + source_endpoint_config = { + endpoint_id = "source-mysql" + endpoint_type = "source" + engine_name = "mysql" + server_name = "source.example.com" + port = 3306 + username = var.source_username + password = var.source_password + } + + # Target endpoint + target_endpoint_config = { + endpoint_id = "target-aurora" + endpoint_type = "target" + engine_name = "aurora" + server_name = "target.cluster.amazonaws.com" + port = 3306 + username = var.target_username + password = var.target_password + } + + migration_type = "full-load-and-cdc" +} +``` + +## Configuration + +* See the [root README](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/README.md) for instructions on using Terraform modules. +* See the [variables.tf](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/dms/variables.tf) for all the variables you can set on this module. +* See the [dms-mysql examples](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/examples/dms-mysql/) folder for instruction on how to setup the modules to migrate data from an AWS RDS MySQL Instance to another AWS RDS MySQL Instance. +* See the [dms-aurora examples](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/examples/dms-aurora/) folder for instructions on how to setup the modules to migrate data from an AWS RDS MySQL Instance to another AWS RDS MySQL Instance. + +## Key Variables + +* `name` - Name prefix for all DMS resources +* `replication_instance_class` - Instance size (e.g., dms.t3.medium) +* `allocated_storage` - Storage in GB +* `vpc_id` - VPC for deployment +* `subnet_ids` - Subnets for replication instance +* `migration_type` - full-load, cdc, or full-load-and-cdc + +## Common Issues + +* **Network**: Ensure replication instance can reach both databases +* **Storage**: Allocate enough for your data volume +* **Primary keys**: Required for CDC performance +* **LOB columns**: May need special handling + +## Outputs + +* `replication_instance_arn` - ARN of replication instance +* `source_endpoint_arn` - Source endpoint ARN +* `target_endpoint_arn` - Target endpoint ARN +* `replication_task_arn` - Task ARN ## Sample Usage @@ -32,7 +127,7 @@ This module creates an Amazon Database Migration Service (DMS) that makes it pos module "dms" { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/dms?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/dms?ref=v0.42.0" # ---------------------------------------------------------------------------------------------------- # REQUIRED VARIABLES @@ -276,7 +371,7 @@ module "dms" { # ------------------------------------------------------------------------------------------------------ terraform { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/dms?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/dms?ref=v0.42.0" } inputs = { @@ -1082,11 +1177,11 @@ A map of maps containing the replication tasks created and their full output of diff --git a/docs/reference/modules/terraform-aws-data-storage/efs/efs.md b/docs/reference/modules/terraform-aws-data-storage/efs/efs.md index 01e859cf7..675652b59 100644 --- a/docs/reference/modules/terraform-aws-data-storage/efs/efs.md +++ b/docs/reference/modules/terraform-aws-data-storage/efs/efs.md @@ -9,57 +9,91 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # EFS Module -View Source +View Source Release Notes -This module creates an Amazon Elastic File System (EFS) file system that provides NFSv4-compatible storage that can be used with other AWS services, such as EC2 instances. +This module creates an Amazon Elastic File System (EFS) with mount targets across multiple availability zones for NFSv4-compatible shared storage. -EFS is also supported in Kubernetes via the [EFS CSI driver](https://github.com/kubernetes-sigs/aws-efs-csi-driver). Among other features, it supports `ReadWriteMany` and `ReadOnlyMany` access modes in Kubernetes, allowing a volume to be attached to multiple pods (even across AZs) for failover/redundancy purposes. It also supports [encryption-in-transit](https://github.com/kubernetes-sigs/aws-efs-csi-driver#encryption-in-transit) for an additional layer of security. +## What This Module Creates -## Features +* EFS file system +* Mount targets in specified subnets +* Security group for access control +* Optional KMS encryption +* Optional lifecycle policies +* Optional backup policies -* Create a managed NFSv4-compliant file system +## Usage -* Supports encryption-at-rest and encryption-in-transit +```hcl +module "efs" { + source = "../modules/efs" -* Automatic failover to another availability zone + name = "my-efs" + vpc_id = var.vpc_id + subnet_ids = var.private_subnet_ids -## Learn + # Security + allow_connections_from_security_groups = [var.app_security_group_id] + allow_connections_from_cidr_blocks = ["10.0.0.0/16"] -Note + # Encryption + storage_encrypted = true + kms_key_arn = var.kms_key_arn -This repo is a part of [the Gruntwork Infrastructure as Code Library](https://gruntwork.io/infrastructure-as-code-library/), a collection of reusable, battle-tested, production ready infrastructure code. If you’ve never used the Infrastructure as Code Library before, make sure to read [How to use the Gruntwork Infrastructure as Code Library](https://docs.gruntwork.io/library/overview/)! + # Performance + performance_mode = "generalPurpose" + throughput_mode = "bursting" +} +``` -### Core concepts +## Key Variables -* [EFS documentation](https://docs.aws.amazon.com/efs/latest/ug/index.html): Amazon’s docs for EFS that cover core concepts such as performance modes, throughput modes, mounting file systems, etc. +### Required -## Deploy +* `name` - EFS file system name +* `vpc_id` - VPC for deployment +* `subnet_ids` - Subnets for mount targets (one per AZ) -### Non-production deployment (quick start for learning) +### Security -If you just want to try this repo out for experimenting and learning, check out the following resources: +* `allow_connections_from_security_groups` - Security groups that can mount +* `allow_connections_from_cidr_blocks` - CIDR blocks that can mount +* `storage_encrypted` - Enable encryption at rest +* `kms_key_arn` - Custom KMS key for encryption -* [examples folder](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/examples): The `examples` folder contains sample code optimized for learning, experimenting, and testing (but not production usage). +### Performance -### Production deployment +* `performance_mode` - generalPurpose or maxIO +* `throughput_mode` - bursting, provisioned, or elastic +* `provisioned_throughput_in_mibps` - For provisioned mode -If you want to deploy this repo in production, check out the following resources: +## Outputs -* [efs module variables](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/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. +* `file_system_id` - EFS file system ID +* `file_system_dns_name` - DNS name for mounting +* `file_system_arn` - EFS ARN +* `security_group_id` - Security group ID +* `mount_target_ids` - List of mount target IDs -## Manage +## Mounting -### Day-to-day operations +```bash +# Mount using DNS name +sudo mount -t nfs4 -o nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2,noresvport fs-12345678.efs.us-east-1.amazonaws.com:/ /mnt/efs +``` -* [How to mount an EFS file system](https://docs.aws.amazon.com/efs/latest/ug/mounting-fs.html) +## Common Issues -* [How to configure backups](https://docs.aws.amazon.com/efs/latest/ug/efs-backup-solutions.html) +* **Mount hangs**: Check security group rules allow NFS (port 2049) +* **Performance**: Use maxIO mode for workloads with >7000 ops/sec +* **Cross-AZ costs**: Data transfer between AZs incurs charges +* **Kubernetes**: Use [EFS CSI driver](https://github.com/kubernetes-sigs/aws-efs-csi-driver) for EKS integration ## Sample Usage @@ -74,7 +108,7 @@ If you want to deploy this repo in production, check out the following resources module "efs" { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/efs?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/efs?ref=v0.42.0" # ---------------------------------------------------------------------------------------------------- # REQUIRED VARIABLES @@ -187,7 +221,7 @@ module "efs" { # ------------------------------------------------------------------------------------------------------ terraform { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/efs?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/efs?ref=v0.42.0" } inputs = { @@ -586,11 +620,11 @@ The IDs of the security groups created for the file system. diff --git a/docs/reference/modules/terraform-aws-data-storage/lambda-cleanup-snapshots/lambda-cleanup-snapshots.md b/docs/reference/modules/terraform-aws-data-storage/lambda-cleanup-snapshots/lambda-cleanup-snapshots.md index 2e3d36e9a..0069ee848 100644 --- a/docs/reference/modules/terraform-aws-data-storage/lambda-cleanup-snapshots/lambda-cleanup-snapshots.md +++ b/docs/reference/modules/terraform-aws-data-storage/lambda-cleanup-snapshots/lambda-cleanup-snapshots.md @@ -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"; - + # Delete Snapshots Lambda Module -View Source +View Source Release Notes @@ -29,7 +29,7 @@ Note that to use this module, you must have access to the Gruntwork [Continuous This module allows you to configure a number of parameters, such as which database to backup, how often to run the backups, what account to share the backups with, and more. 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/lambda-cleanup-snapshots/variables.tf). +descriptions, see [variables.tf](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/lambda-cleanup-snapshots/variables.tf). ## Sample Usage @@ -44,7 +44,7 @@ descriptions, see [variables.tf](https://github.com/gruntwork-io/terraform-aws-d module "lambda_cleanup_snapshots" { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-cleanup-snapshots?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-cleanup-snapshots?ref=v0.42.0" # ---------------------------------------------------------------------------------------------------- # REQUIRED VARIABLES @@ -114,7 +114,7 @@ module "lambda_cleanup_snapshots" { # ------------------------------------------------------------------------------------------------------ terraform { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-cleanup-snapshots?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-cleanup-snapshots?ref=v0.42.0" } inputs = { @@ -295,11 +295,11 @@ Namespace of snapshots that will be cleaned up by this module. If specified then diff --git a/docs/reference/modules/terraform-aws-data-storage/lambda-copy-shared-snapshot/lambda-copy-shared-snapshot.md b/docs/reference/modules/terraform-aws-data-storage/lambda-copy-shared-snapshot/lambda-copy-shared-snapshot.md index ffb81dcbb..529b45346 100644 --- a/docs/reference/modules/terraform-aws-data-storage/lambda-copy-shared-snapshot/lambda-copy-shared-snapshot.md +++ b/docs/reference/modules/terraform-aws-data-storage/lambda-copy-shared-snapshot/lambda-copy-shared-snapshot.md @@ -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"; - + # Copy Snapshot Lambda Module -View Source +View Source Release Notes @@ -108,7 +108,7 @@ account 222222222222. To be able to make a copy of that snapshot in account 2222 ## Background info For more info on how to backup RDS snapshots to a separate AWS account, check out the [lambda-create-snapshot module -documentation](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/lambda-create-snapshot). +documentation](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/lambda-create-snapshot). ## Sample Usage @@ -123,7 +123,7 @@ documentation](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v module "lambda_copy_shared_snapshot" { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-copy-shared-snapshot?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-copy-shared-snapshot?ref=v0.42.0" # ---------------------------------------------------------------------------------------------------- # REQUIRED VARIABLES @@ -199,7 +199,7 @@ module "lambda_copy_shared_snapshot" { # ------------------------------------------------------------------------------------------------------ terraform { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-copy-shared-snapshot?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-copy-shared-snapshot?ref=v0.42.0" } inputs = { @@ -393,11 +393,11 @@ Namespace all Lambda scheduling resources created by this module with this name. diff --git a/docs/reference/modules/terraform-aws-data-storage/lambda-create-snapshot/lambda-create-snapshot.md b/docs/reference/modules/terraform-aws-data-storage/lambda-create-snapshot/lambda-create-snapshot.md index 2e9fba381..adaf12e36 100644 --- a/docs/reference/modules/terraform-aws-data-storage/lambda-create-snapshot/lambda-create-snapshot.md +++ b/docs/reference/modules/terraform-aws-data-storage/lambda-create-snapshot/lambda-create-snapshot.md @@ -9,45 +9,44 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # Database backup -View Source +View Source Release Notes -This module, along with the [lambda-share-snapshot](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/lambda-share-snapshot) and [lambda-copy-shared-snapshot](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/lambda-copy-shared-snapshot) modules, can be used to backup your RDS database to another AWS account (e.g., for disaster recovery) on a configurable schedule. Under the hood, each module runs a Lambda function that instructs your database to take a snapshot (this module), share the snapshot with another account (the `lambda-share-snapshot` module), and make a copy of the snapshot (`lambda-copy-shared-snapshot`). +This module, along with the [lambda-share-snapshot](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/lambda-share-snapshot) and +[lambda-copy-shared-snapshot](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/lambda-copy-shared-snapshot) modules, can be used to backup your RDS database +to another AWS account (e.g., for disaster recovery) on a configurable schedule. Under the hood, each module runs a +Lambda function that instructs your database to take a snapshot (this module), share the snapshot with another account +(the `lambda-share-snapshot` module), and make a copy of the snapshot (`lambda-copy-shared-snapshot`). ![RDS architecture](/img/reference/modules/terraform-aws-data-storage/lambda-create-snapshot/data-backup-architecture.png) ## Features -* Standalone functions for taking snapshots, sharing snapshots, and copying snapshots that can be combined in many different ways - +* Standalone functions for taking snapshots, sharing snapshots, and copying snapshots that can be combined in many + different ways * You can combine them to copy snapshots across AWS accounts and regions - * Configurable backup schedule (e.g., using cron expressions) - -* Clean up old snapshots automatically using the [lambda-cleanup-snapshots](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/lambda-cleanup-snapshots) module. - +* Clean up old snapshots automatically using the [lambda-cleanup-snapshots](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/lambda-cleanup-snapshots) + module. * Add tags to snapshots by passing in `additional_environment_variables` ## Learn -Note - -This repo is a part of [the Gruntwork Infrastructure as Code Library](https://gruntwork.io/infrastructure-as-code-library/), a collection of reusable, battle-tested, production ready infrastructure code. If you’ve never used the Infrastructure as Code Library before, make sure to read [How to use the Gruntwork Infrastructure as Code Library](https://docs.gruntwork.io/library/overview/)! +**Note:** This repo is a part of [the Gruntwork Infrastructure as Code Library](https://gruntwork.io/infrastructure-as-code-library/), a collection of reusable, battle-tested, production ready infrastructure code. If you've never used the Infrastructure as Code Library before, make sure to read [How to use the Gruntwork Infrastructure as Code Library](https://docs.gruntwork.io/library/overview/)! ### Core concepts -* [What is Amazon RDS?](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/rds/core-concepts.md#what-is-amazon-rds) - -* [How does this differ from RDS automatic snapshots?](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/lambda-create-snapshot/core-concepts.md#how-does-this-differ-from-rds-automatic-snapshots) - -* [RDS documentation](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html): Amazon’s docs for RDS that cover core concepts such as the types of databases supported, security, backup & restore, and monitoring. - -* *[Designing Data Intensive Applications](https://dataintensive.net)*: the best book we’ve found for understanding data systems, including relational databases, NoSQL, replication, sharding, consistency, and so on. +* [What is Amazon RDS?](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/rds/core-concepts.md#what-is-amazon-rds) +* [How does this differ from RDS automatic snapshots?](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/lambda-create-snapshot/core-concepts.md#how-does-this-differ-from-rds-automatic-snapshots) +* [RDS documentation](https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Welcome.html): Amazon's docs for RDS that + cover core concepts such as the types of databases supported, security, backup & restore, and monitoring. +* [Designing Data Intensive Applications](https://dataintensive.net): the best book we've found for understanding data + systems, including relational databases, NoSQL, replication, sharding, consistency, and so on. ## Deploy @@ -55,7 +54,8 @@ 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.41.1/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.42.0/examples): The `examples` folder contains sample code optimized for learning, experimenting, + and testing (but not production usage). ### Production deployment @@ -67,7 +67,7 @@ If you want to deploy this repo in production, check out the following resources ### Day-to-day operations -* [How to backup RDS snapshots to a separate AWS account](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/lambda-create-snapshot/core-concepts.md#how-do-you-backup-your-rds-snapshots-to-a-separate-aws-account) +* [How to backup RDS snapshots to a separate AWS account](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/lambda-create-snapshot/core-concepts.md#how-do-you-backup-your-rds-snapshots-to-a-separate-aws-account) ### Major changes @@ -86,7 +86,7 @@ If you want to deploy this repo in production, check out the following resources module "lambda_create_snapshot" { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-create-snapshot?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-create-snapshot?ref=v0.42.0" # ---------------------------------------------------------------------------------------------------- # REQUIRED VARIABLES @@ -188,7 +188,7 @@ module "lambda_create_snapshot" { # ------------------------------------------------------------------------------------------------------ terraform { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-create-snapshot?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-create-snapshot?ref=v0.42.0" } inputs = { @@ -465,11 +465,11 @@ Namespace all snapshots created by this module's jobs with this suffix. If not s diff --git a/docs/reference/modules/terraform-aws-data-storage/lambda-share-snapshot/lambda-share-snapshot.md b/docs/reference/modules/terraform-aws-data-storage/lambda-share-snapshot/lambda-share-snapshot.md index 600c6e755..80c667eae 100644 --- a/docs/reference/modules/terraform-aws-data-storage/lambda-share-snapshot/lambda-share-snapshot.md +++ b/docs/reference/modules/terraform-aws-data-storage/lambda-share-snapshot/lambda-share-snapshot.md @@ -9,23 +9,23 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # Share Snapshot Lambda Module -View Source +View Source Release Notes This module creates an [AWS Lambda](https://aws.amazon.com/lambda/) function that can share snapshots of an [Amazon Relational Database (RDS)](https://aws.amazon.com/rds/) database with another AWS account. Typically, the snapshots -are created by the [lambda-create-snapshot module](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/lambda-create-snapshot), which can be configured to +are created by the [lambda-create-snapshot module](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/lambda-create-snapshot), which can be configured to automatically trigger this lambda function after each run. ## Background info For more info on how to backup RDS snapshots to a separate AWS account, check out the [lambda-create-snapshot module -documentation](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/lambda-create-snapshot). +documentation](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/lambda-create-snapshot). ## Sample Usage @@ -40,7 +40,7 @@ documentation](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v module "lambda_share_snapshot" { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-share-snapshot?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-share-snapshot?ref=v0.42.0" # ---------------------------------------------------------------------------------------------------- # REQUIRED VARIABLES @@ -85,7 +85,7 @@ module "lambda_share_snapshot" { # ------------------------------------------------------------------------------------------------------ terraform { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-share-snapshot?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/lambda-share-snapshot?ref=v0.42.0" } inputs = { @@ -200,11 +200,11 @@ The amount of time, in seconds, between retries. diff --git a/docs/reference/modules/terraform-aws-data-storage/org-backup-policy/org-backup-policy.md b/docs/reference/modules/terraform-aws-data-storage/org-backup-policy/org-backup-policy.md index 89a31c2b6..59e9d7407 100644 --- a/docs/reference/modules/terraform-aws-data-storage/org-backup-policy/org-backup-policy.md +++ b/docs/reference/modules/terraform-aws-data-storage/org-backup-policy/org-backup-policy.md @@ -9,17 +9,17 @@ import VersionBadge from '../../../../../src/components/VersionBadge.tsx'; import { HclListItem, HclListItemDescription, HclListItemTypeDetails, HclListItemDefaultValue, HclGeneralListItem } from '../../../../../src/components/HclListItem.tsx'; import { ModuleUsage } from "../../../../../src/components/ModuleUsage"; - + # Organization Backup Policies Module -View Source +View Source Release Notes This Terraform Module creates the [AWS Organizations Backup Policies](https://docs.aws.amazon.com/organizations/latest/userguide/orgs_manage_policies_backup.html). -You associate your each plan on the backup policies with a [Backup vault](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/modules/backup-vault). +You associate your each plan on the backup policies with a [Backup vault](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/modules/backup-vault). ## What are Backup Policies ? @@ -42,7 +42,7 @@ account. This effective policy instructs AWS Backup how to automatically back up module "org_backup_policy" { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/org-backup-policy?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/org-backup-policy?ref=v0.42.0" # ---------------------------------------------------------------------------------------------------- # REQUIRED VARIABLES @@ -155,7 +155,7 @@ module "org_backup_policy" { # ------------------------------------------------------------------------------------------------------ terraform { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/org-backup-policy?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/org-backup-policy?ref=v0.42.0" } inputs = { @@ -734,11 +734,11 @@ ID of the backup policies diff --git a/docs/reference/modules/terraform-aws-data-storage/rds-proxy/rds-proxy.md b/docs/reference/modules/terraform-aws-data-storage/rds-proxy/rds-proxy.md index b674e1e58..10d924cac 100644 --- a/docs/reference/modules/terraform-aws-data-storage/rds-proxy/rds-proxy.md +++ b/docs/reference/modules/terraform-aws-data-storage/rds-proxy/rds-proxy.md @@ -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"; - + # RDS Proxy Module -View Source +View Source Release Notes @@ -54,7 +54,7 @@ Before using this module, you need to: ## How to use the RDS Proxy Module In order to setup a RDS proxy, you need to setup database credentials in AWS Secrets Manager and pass it to this module. -Refer to the [examples/rds-proxy](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.41.1/examples/rds-proxy) or [https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-setup.html#rds-proxy-secrets-arns](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-setup.html#rds-proxy-secrets-arns) for more information. +Refer to the [examples/rds-proxy](https://github.com/gruntwork-io/terraform-aws-data-storage/tree/v0.42.0/examples/rds-proxy) or [https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-setup.html#rds-proxy-secrets-arns](https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/rds-proxy-setup.html#rds-proxy-secrets-arns) for more information. If you use a customer managed KMS key to encrypt the secret, you will need to provide the KMS key ARN to this module using the `db_secret_kms_key_arn` parameter. @@ -143,7 +143,7 @@ Each authentication method can be configured with: module "rds_proxy" { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/rds-proxy?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/rds-proxy?ref=v0.42.0" # ---------------------------------------------------------------------------------------------------- # REQUIRED VARIABLES @@ -232,7 +232,7 @@ module "rds_proxy" { # ------------------------------------------------------------------------------------------------------ terraform { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/rds-proxy?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/rds-proxy?ref=v0.42.0" } inputs = { @@ -508,11 +508,11 @@ The ID of the security group associated with the RDS proxy. This security group diff --git a/docs/reference/modules/terraform-aws-data-storage/rds-replicas/rds-replicas.md b/docs/reference/modules/terraform-aws-data-storage/rds-replicas/rds-replicas.md index 36db30557..28f31404d 100644 --- a/docs/reference/modules/terraform-aws-data-storage/rds-replicas/rds-replicas.md +++ b/docs/reference/modules/terraform-aws-data-storage/rds-replicas/rds-replicas.md @@ -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"; - + # RDS Read Replicas Module -View Source +View Source Release Notes @@ -77,7 +77,7 @@ terraform import aws_db_instance. module "rds_replicas" { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/rds-replicas?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/rds-replicas?ref=v0.42.0" # ---------------------------------------------------------------------------------------------------- # REQUIRED VARIABLES @@ -315,7 +315,7 @@ module "rds_replicas" { # ------------------------------------------------------------------------------------------------------ terraform { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/rds-replicas?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/rds-replicas?ref=v0.42.0" } inputs = { @@ -1006,11 +1006,11 @@ Timeout for DB updating diff --git a/docs/reference/modules/terraform-aws-data-storage/rds/rds.md b/docs/reference/modules/terraform-aws-data-storage/rds/rds.md index 4569cd6e7..578c4f94b 100644 --- a/docs/reference/modules/terraform-aws-data-storage/rds/rds.md +++ b/docs/reference/modules/terraform-aws-data-storage/rds/rds.md @@ -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"; - + # RDS Module -View Source +View Source Release Notes @@ -159,7 +159,7 @@ Set `multi_az=true`. When setting up a multi-AZ (Availability Zone) RDS deployme module "rds" { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/rds?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/rds?ref=v0.42.0" # ---------------------------------------------------------------------------------------------------- # REQUIRED VARIABLES @@ -316,9 +316,11 @@ module "rds" { # created for it. The key is the tag name and the value is the tag value. custom_tags = {} - # 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 + # MySQL/MariaDB, 1-63 for PostgreSQL, 1-8 for Oracle. Must begin with a + # letter. Cannot be a reserved word. Not supported for SQL Server (must be + # null). If you do not provide a name, Amazon RDS will not create a database + # in the DB instance you are creating. db_name = null # A map of the default license to use for each supported RDS engine. @@ -546,7 +548,7 @@ module "rds" { # ------------------------------------------------------------------------------------------------------ terraform { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/rds?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/rds?ref=v0.42.0" } inputs = { @@ -706,9 +708,11 @@ inputs = { # created for it. The key is the tag name and the value is the tag value. custom_tags = {} - # 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 + # MySQL/MariaDB, 1-63 for PostgreSQL, 1-8 for Oracle. Must begin with a + # letter. Cannot be a reserved word. Not supported for SQL Server (must be + # null). If you do not provide a name, Amazon RDS will not create a database + # in the DB instance you are creating. db_name = null # A map of the default license to use for each supported RDS engine. @@ -1301,7 +1305,7 @@ A map of custom tags to apply to the RDS Instance and the Security Group created -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 MySQL/MariaDB, 1-63 for PostgreSQL, 1-8 for Oracle. Must begin with a letter. Cannot be a reserved word. Not supported for SQL Server (must be null). If you do not provide a name, Amazon RDS will not create a database in the DB instance you are creating. @@ -1797,11 +1801,11 @@ Timeout for DB updating diff --git a/docs/reference/modules/terraform-aws-data-storage/redshift/redshift.md b/docs/reference/modules/terraform-aws-data-storage/redshift/redshift.md index b5db483b2..a79d43206 100644 --- a/docs/reference/modules/terraform-aws-data-storage/redshift/redshift.md +++ b/docs/reference/modules/terraform-aws-data-storage/redshift/redshift.md @@ -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"; - + # Redshift Module -View Source +View Source Release Notes @@ -60,7 +60,7 @@ workaround, you can re-run the destroy command once the workspace gets deleted c module "redshift" { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/redshift?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/redshift?ref=v0.42.0" # ---------------------------------------------------------------------------------------------------- # REQUIRED VARIABLES @@ -149,9 +149,10 @@ module "redshift" { # created for it. The key is the tag name and the value is the tag value. custom_tags = {} - # 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 of the first database to create in the Redshift cluster. Must be + # 1-127 characters. Must begin with a letter or underscore. Subsequent + # characters can be letters, underscores, digits, or dollar signs. Cannot be a + # reserved word. Default is 'dev'. db_name = "dev" # Timeout for DB deleting @@ -290,7 +291,7 @@ module "redshift" { # ------------------------------------------------------------------------------------------------------ terraform { - source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/redshift?ref=v0.41.1" + source = "git::git@github.com:gruntwork-io/terraform-aws-data-storage.git//modules/redshift?ref=v0.42.0" } inputs = { @@ -382,9 +383,10 @@ inputs = { # created for it. The key is the tag name and the value is the tag value. custom_tags = {} - # 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 of the first database to create in the Redshift cluster. Must be + # 1-127 characters. Must begin with a letter or underscore. Subsequent + # characters can be letters, underscores, digits, or dollar signs. Cannot be a + # reserved word. Default is 'dev'. db_name = "dev" # Timeout for DB deleting @@ -690,7 +692,7 @@ A map of custom tags to apply to the RDS Instance and the Security Group created -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 of the first database to create in the Redshift cluster. Must be 1-127 characters. Must begin with a letter or underscore. Subsequent characters can be letters, underscores, digits, or dollar signs. Cannot be a reserved word. Default is 'dev'. @@ -1054,11 +1056,11 @@ The ID of the Security Group that controls access to the cluster