[Docs] Updated rds_instance backup_retention_period parameter docs #183
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tremble
requested changes
Aug 12, 2020
plugins/modules/rds_instance.py
Outdated
| @@ -99,7 +99,8 @@ | |||
| type: str | |||
| backup_retention_period: | |||
| description: | |||
| - The number of days for which automated backups are retained (must be greater or equal to 1). | |||
| - The number of days for which automated backups are retained (>=1). | |||
There was a problem hiding this comment.
Suggested change
| - The number of days for which automated backups are retained (>=1). | |
| - The number of days for which automated backups are retained. |
plugins/modules/rds_instance.py
Outdated
| @@ -99,7 +99,8 @@ | |||
| type: str | |||
| backup_retention_period: | |||
| description: | |||
| - The number of days for which automated backups are retained (must be greater or equal to 1). | |||
| - The number of days for which automated backups are retained (>=1). | |||
| When set to 0, automated backups will be disabled. | |||
There was a problem hiding this comment.
Suggested change
| When set to 0, automated backups will be disabled. | |
| - When set to C(0), automated backups will be disabled. |
Part of me thinks we should also mention the caveat that Can't be set to 0 if the DB instance is a source to read replicas ( https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/rds.html#RDS.Client.create_db_instance )
There was a problem hiding this comment.
We definitely should mention the read replicas case! Why the C(0) btw?
There was a problem hiding this comment.
Using C() tweaks the formatting a little and formats it as a 'value'. See also:
https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_documenting.html#linking-within-module-documentation
plugins/modules/rds_instance.py
Outdated
| @@ -99,7 +99,8 @@ | |||
| type: str | |||
| backup_retention_period: | |||
| description: | |||
| - The number of days for which automated backups are retained (must be greater or equal to 1). | |||
| - The number of days for which automated backups are retained (>=1). | |||
| When set to 0, automated backups will be disabled. | |||
| May be used when creating a new cluster, when restoring from S3, or when modifying a cluster. | |||
There was a problem hiding this comment.
Suggested change
| May be used when creating a new cluster, when restoring from S3, or when modifying a cluster. | |
| - May be used when creating a new cluster, when restoring from S3, or when modifying a cluster. |
|
Fully aligned 🙂 Will be updating the pull request now! |
alinabuzachis
pushed a commit
to alinabuzachis/community.aws
that referenced
this pull request
Jul 19, 2021
alinabuzachis
pushed a commit
to alinabuzachis/community.aws
that referenced
this pull request
Jul 19, 2021
abikouo
pushed a commit
to abikouo/community.aws
that referenced
this pull request
Oct 24, 2023
…collections#183) This commit was initially merged in https://github.com/ansible-collections/community.aws See: ansible-collections@11a87e0
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SUMMARY
Documentation update:
When using rds_instance module, I noticed that when the backup_retention_period parameter is set to 0,
automated backups are disabled.
Previous documentation mentioned that this parameter should be greater than or equal to 1.
Documentation has been updated to reflect this behavior.
ISSUE TYPE
COMPONENT NAME
rds_instance