Skip to content
Open
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
19 changes: 18 additions & 1 deletion docs/reference/services/data-storage/amazon-rds-replica.md
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,10 @@ module "rds_replica" {
# allocated_storage or 0 to disable Storage Autoscaling.
max_allocated_storage = 0

# The network type of the DB instance. Valid values: IPV4, DUAL. Use DUAL for
# dual-stack mode with IPv4 and IPv6 support.
network_type = null

# The number of read replicas to deploy
num_read_replicas = 0

Expand Down Expand Up @@ -601,6 +605,10 @@ inputs = {
# allocated_storage or 0 to disable Storage Autoscaling.
max_allocated_storage = 0

# The network type of the DB instance. Valid values: IPV4, DUAL. Use DUAL for
# dual-stack mode with IPv4 and IPv6 support.
network_type = null

# The number of read replicas to deploy
num_read_replicas = 0

Expand Down Expand Up @@ -1471,6 +1479,15 @@ When configured, the upper limit to which Amazon RDS can automatically scale the
<HclListItemDefaultValue defaultValue="0"/>
</HclListItem>

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

The network type of the DB instance. Valid values: IPV4, DUAL. Use DUAL for dual-stack mode with IPv4 and IPv6 support.

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

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

Expand Down Expand Up @@ -1692,6 +1709,6 @@ A list of IDs of the RDS DB instance's read replicas.
"https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/v2.2.0/modules/data-stores/rds-replica/outputs.tf"
],
"sourcePlugin": "service-catalog-api",
"hash": "d7ebd922ad72c31bebe2d939a634b43f"
"hash": "8c16a1db23a05ec10c8bc1b950713ff3"
}
##DOCS-SOURCER-END -->
160 changes: 159 additions & 1 deletion docs/reference/services/data-storage/amazon-rds.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,11 @@ module "rds" {
# dashboard.
dashboard_write_latency_widget_parameters = {"height":6,"period":60,"width":8}

# The mode of Database Insights to enable for the DB instance. Valid options
# are 'standard' or 'advanced'. This replaces Performance Insights which is
# deprecated June 30, 2026.
database_insights_mode = null

# The friendly name or ARN of an AWS Secrets Manager secret that contains
# database configuration information in the format outlined by this document:
# https://docs.aws.amazon.com/secretsmanager/latest/userguide/best-practices.html.
Expand All @@ -307,13 +312,27 @@ module "rds" {
# description of db_config_secrets_manager_id.
db_name = null

# Use a dedicated log volume (DLV) for the DB instance. A DLV moves database
# transaction logs onto a separate storage volume, which can improve database
# write performance. Only supported for Provisioned IOPS storage types
# (io1/io2) — gp3 is NOT supported. Engine version requirements: MariaDB
# 10.6.7+, MySQL 8.0.28+, PostgreSQL 13.10+/14.7+/15.2+. A reboot is required
# after enabling/disabling on an existing instance.
dedicated_log_volume = null

# Specifies whether to remove automated backups immediately after the DB
# instance is deleted
delete_automated_backups = true

# Timeout for DB deleting
deleting_timeout = "60m"

# Enable blue/green deployment to minimize down time due to changes made to
# the RDS Instance. See
# https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-overview.html
# for more detailed information.
enable_blue_green_update = false

# Set to true to enable several basic CloudWatch alarms around CPU usage,
# memory usage, and disk space usage. If set to true, make sure to specify SNS
# topics to send notifications to using var.alarms_sns_topic_arn.
Expand Down Expand Up @@ -348,6 +367,13 @@ module "rds" {
# Manager. See the description of db_config_secrets_manager_id.
engine = null

# The life cycle type for this DB instance. This setting applies to RDS for
# MySQL and RDS for PostgreSQL. Valid values are
# 'open-source-rds-extended-support' and
# 'open-source-rds-extended-support-disabled'. Controls enrollment in RDS
# Extended Support and associated costs.
engine_lifecycle_support = null

# The number of datapoints in CloudWatch Metric statistic, which triggers the
# alarm. Setting this as null (the default) will make it equal to the
# evaluation period
Expand Down Expand Up @@ -468,6 +494,11 @@ module "rds" {
# db_config_secrets_manager_id.
master_password = null # SENSITIVE

# The Amazon Web Services KMS key identifier used to encrypt the secret for
# the master user password. Only used when manage_master_user_password is
# true.
master_user_secret_kms_key_id = null

# The value to use for the master username of the database. This can also be
# provided via AWS Secrets Manager. See the description of
# db_config_secrets_manager_id.
Expand Down Expand Up @@ -504,6 +535,10 @@ module "rds" {
# zone. If the primary fails, this instance will automatically take over.
multi_az = false

# The network type of the DB instance. Valid values: IPV4, DUAL. Use DUAL for
# dual-stack mode with IPv4 and IPv6 support.
network_type = null

# The number of read replicas to deploy
num_read_replicas = 0

Expand Down Expand Up @@ -544,6 +579,12 @@ module "rds" {
# database.
replica_domain_name = null

# A configuration block for restoring a DB instance to an arbitrary point in
# time. Refer to
# https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_instance#restore-to-point-in-time
# for more details
restore_to_point_in_time = null

# The maximum number of snapshots to keep around for the purpose of cross
# account sharing. Once this number is exceeded, a lambda function will delete
# the oldest snapshots. Only used if var.share_snapshot_with_another_account
Expand Down Expand Up @@ -834,6 +875,11 @@ inputs = {
# dashboard.
dashboard_write_latency_widget_parameters = {"height":6,"period":60,"width":8}

# The mode of Database Insights to enable for the DB instance. Valid options
# are 'standard' or 'advanced'. This replaces Performance Insights which is
# deprecated June 30, 2026.
database_insights_mode = null

# The friendly name or ARN of an AWS Secrets Manager secret that contains
# database configuration information in the format outlined by this document:
# https://docs.aws.amazon.com/secretsmanager/latest/userguide/best-practices.html.
Expand All @@ -852,13 +898,27 @@ inputs = {
# description of db_config_secrets_manager_id.
db_name = null

# Use a dedicated log volume (DLV) for the DB instance. A DLV moves database
# transaction logs onto a separate storage volume, which can improve database
# write performance. Only supported for Provisioned IOPS storage types
# (io1/io2) — gp3 is NOT supported. Engine version requirements: MariaDB
# 10.6.7+, MySQL 8.0.28+, PostgreSQL 13.10+/14.7+/15.2+. A reboot is required
# after enabling/disabling on an existing instance.
dedicated_log_volume = null

# Specifies whether to remove automated backups immediately after the DB
# instance is deleted
delete_automated_backups = true

# Timeout for DB deleting
deleting_timeout = "60m"

# Enable blue/green deployment to minimize down time due to changes made to
# the RDS Instance. See
# https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-overview.html
# for more detailed information.
enable_blue_green_update = false

# Set to true to enable several basic CloudWatch alarms around CPU usage,
# memory usage, and disk space usage. If set to true, make sure to specify SNS
# topics to send notifications to using var.alarms_sns_topic_arn.
Expand Down Expand Up @@ -893,6 +953,13 @@ inputs = {
# Manager. See the description of db_config_secrets_manager_id.
engine = null

# The life cycle type for this DB instance. This setting applies to RDS for
# MySQL and RDS for PostgreSQL. Valid values are
# 'open-source-rds-extended-support' and
# 'open-source-rds-extended-support-disabled'. Controls enrollment in RDS
# Extended Support and associated costs.
engine_lifecycle_support = null

# The number of datapoints in CloudWatch Metric statistic, which triggers the
# alarm. Setting this as null (the default) will make it equal to the
# evaluation period
Expand Down Expand Up @@ -1013,6 +1080,11 @@ inputs = {
# db_config_secrets_manager_id.
master_password = null # SENSITIVE

# The Amazon Web Services KMS key identifier used to encrypt the secret for
# the master user password. Only used when manage_master_user_password is
# true.
master_user_secret_kms_key_id = null

# The value to use for the master username of the database. This can also be
# provided via AWS Secrets Manager. See the description of
# db_config_secrets_manager_id.
Expand Down Expand Up @@ -1049,6 +1121,10 @@ inputs = {
# zone. If the primary fails, this instance will automatically take over.
multi_az = false

# The network type of the DB instance. Valid values: IPV4, DUAL. Use DUAL for
# dual-stack mode with IPv4 and IPv6 support.
network_type = null

# The number of read replicas to deploy
num_read_replicas = 0

Expand Down Expand Up @@ -1089,6 +1165,12 @@ inputs = {
# database.
replica_domain_name = null

# A configuration block for restoring a DB instance to an arbitrary point in
# time. Refer to
# https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_instance#restore-to-point-in-time
# for more details
restore_to_point_in_time = null

# The maximum number of snapshots to keep around for the purpose of cross
# account sharing. Once this number is exceeded, a lambda function will delete
# the oldest snapshots. Only used if var.share_snapshot_with_another_account
Expand Down Expand Up @@ -1873,6 +1955,15 @@ object({
</HclGeneralListItem>
</HclListItem>

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

The mode of Database Insights to enable for the DB instance. Valid options are 'standard' or 'advanced'. This replaces Performance Insights which is deprecated June 30, 2026.

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

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

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

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

Use a dedicated log volume (DLV) for the DB instance. A DLV moves database transaction logs onto a separate storage volume, which can improve database write performance. Only supported for Provisioned IOPS storage types (io1/io2) — gp3 is NOT supported. Engine version requirements: MariaDB 10.6.7+, MySQL 8.0.28+, PostgreSQL 13.10+/14.7+/15.2+. A reboot is required after enabling/disabling on an existing instance.

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

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

Expand All @@ -1909,6 +2009,15 @@ Timeout for DB deleting
<HclListItemDefaultValue defaultValue="&quot;60m&quot;"/>
</HclListItem>

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

Enable blue/green deployment to minimize down time due to changes made to the RDS Instance. See https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments-overview.html for more detailed information.

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

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

Expand Down Expand Up @@ -1972,6 +2081,15 @@ The DB engine to use (e.g. mysql). This can also be provided via AWS Secrets Man
<HclListItemDefaultValue defaultValue="null"/>
</HclListItem>

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

The life cycle type for this DB instance. This setting applies to RDS for MySQL and RDS for PostgreSQL. Valid values are 'open-source-rds-extended-support' and 'open-source-rds-extended-support-disabled'. Controls enrollment in RDS Extended Support and associated costs.

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

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

Expand Down Expand Up @@ -2239,6 +2357,15 @@ The value to use for the master password of the database. This can also be provi
<HclListItemDefaultValue defaultValue="null"/>
</HclListItem>

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

The Amazon Web Services KMS key identifier used to encrypt the secret for the master user password. Only used when manage_master_user_password is true.

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

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

Expand Down Expand Up @@ -2302,6 +2429,15 @@ Specifies if a standby instance should be deployed in another availability zone.
<HclListItemDefaultValue defaultValue="false"/>
</HclListItem>

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

The network type of the DB instance. Valid values: IPV4, DUAL. Use DUAL for dual-stack mode with IPv4 and IPv6 support.

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

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

Expand Down Expand Up @@ -2383,6 +2519,28 @@ The domain name to create a route 53 record for the read replicas of the RDS dat
<HclListItemDefaultValue defaultValue="null"/>
</HclListItem>

<HclListItem name="restore_to_point_in_time" requirement="optional" type="map(object(…))">
<HclListItemDescription>

A configuration block for restoring a DB instance to an arbitrary point in time. Refer to https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/db_instance#restore-to-point-in-time for more details

</HclListItemDescription>
<HclListItemTypeDetails>

```hcl
map(object({
restore_time = string
source_db_instance_identifier = string
source_db_instance_automated_backups_arn = string
source_dbi_resource_id = string
use_latest_restorable_time = string
}))
```

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

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

Expand Down Expand Up @@ -2723,6 +2881,6 @@ The ID of the Security Group that controls access to the RDS DB instance.
"https://github.com/gruntwork-io/terraform-aws-service-catalog/tree/v2.2.0/modules/data-stores/rds/outputs.tf"
],
"sourcePlugin": "service-catalog-api",
"hash": "44a522919418b6191155245f2a8fd27c"
"hash": "808b40e70c388133e7ffd5a5a295c315"
}
##DOCS-SOURCER-END -->