From 11a87e0607ed7ce3d7c14a4db086260899840721 Mon Sep 17 00:00:00 2001 From: Jean-Marc Saad Date: Wed, 12 Aug 2020 23:16:48 +0300 Subject: [PATCH] [Docs] Updated rds_instance backup_retention_period parameter docs (#183) --- docs/community.aws.rds_instance_module.rst | 4 +++- plugins/modules/rds_instance.py | 5 +++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/community.aws.rds_instance_module.rst b/docs/community.aws.rds_instance_module.rst index f10000f56ff..78ef27aa24e 100644 --- a/docs/community.aws.rds_instance_module.rst +++ b/docs/community.aws.rds_instance_module.rst @@ -191,7 +191,9 @@ Parameters -
The number of days for which automated backups are retained (must be greater or equal to 1). May be used when creating a new cluster, when restoring from S3, or when modifying a cluster.
+
The number of days for which automated backups are retained.
+
When set to 0, automated backups will be disabled. (Not applicable if the DB instance is a source to read replicas)
+
May be used when creating a new cluster, when restoring from S3, or when modifying a cluster.
diff --git a/plugins/modules/rds_instance.py b/plugins/modules/rds_instance.py index 95781a48d54..e93322cc61b 100644 --- a/plugins/modules/rds_instance.py +++ b/plugins/modules/rds_instance.py @@ -99,8 +99,9 @@ type: str backup_retention_period: description: - - The number of days for which automated backups are retained (must be greater or equal to 1). - May be used when creating a new cluster, when restoring from S3, or when modifying a cluster. + - The number of days for which automated backups are retained. + - When set to C(0), automated backups will be disabled. (Not applicable if the DB instance is a source to read replicas) + - May be used when creating a new cluster, when restoring from S3, or when modifying a cluster. type: int ca_certificate_identifier: description: