From a5efa4a1faf9564267afaf0eda04129f0cdb5097 Mon Sep 17 00:00:00 2001 From: clint shryock Date: Fri, 18 Dec 2015 11:22:21 -0600 Subject: [PATCH] Better document RDS apply immediately --- .../providers/aws/r/db_instance.html.markdown | 17 ++++++++++++++++- .../providers/aws/r/rds_cluster.html.markdown | 11 +++++++++++ 2 files changed, 27 insertions(+), 1 deletion(-) diff --git a/website/source/docs/providers/aws/r/db_instance.html.markdown b/website/source/docs/providers/aws/r/db_instance.html.markdown index 2ff282d10..4efed4ac6 100644 --- a/website/source/docs/providers/aws/r/db_instance.html.markdown +++ b/website/source/docs/providers/aws/r/db_instance.html.markdown @@ -8,7 +8,21 @@ description: |- # aws\_db\_instance -Provides an RDS instance resource. +Provides an RDS instance resource. A DB instance is an isolated database +environment in the cloud. A DB instance can contain multiple user-created +databases. + +Changes to a DB instance can occur when you manually change a +parameter, such as `allocated_storage`, and are reflected in the next maintenance +window. Because of this, Terraform may report a difference in it's planning +phase because a modification has not yet taken place. You can use the +`apply_immediately` flag to instruct the service to apply the change immediately +(see documentation below). + +~> **Note:** using `apply_immediately` can result in a +brief downtime as the server reboots. See the AWS Docs on [RDS Maintenance][2] +for more information. + ## Example Usage @@ -114,3 +128,4 @@ The following attributes are exported: * `storage_encrypted` - Specifies whether the DB instance is encrypted [1]: http://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/Overview.Replication.html +[2]: http://docs.aws.amazon.com/fr_fr/AmazonRDS/latest/UserGuide/USER_UpgradeDBInstance.Maintenance.html diff --git a/website/source/docs/providers/aws/r/rds_cluster.html.markdown b/website/source/docs/providers/aws/r/rds_cluster.html.markdown index c60e6ef29..a9bd4c1a7 100644 --- a/website/source/docs/providers/aws/r/rds_cluster.html.markdown +++ b/website/source/docs/providers/aws/r/rds_cluster.html.markdown @@ -15,6 +15,17 @@ database engine. For more information on Amazon Aurora, see [Aurora on Amazon RDS][2] in the Amazon RDS User Guide. +Changes to a RDS Cluster can occur when you manually change a +parameter, such as `port`, and are reflected in the next maintenance +window. Because of this, Terraform may report a difference in it's planning +phase because a modification has not yet taken place. You can use the +`apply_immediately` flag to instruct the service to apply the change immediately +(see documentation below). + +~> **Note:** using `apply_immediately` can result in a +brief downtime as the server reboots. See the AWS Docs on [RDS Maintenance][2] +for more information. + ## Example Usage ```