Skip to content

Commit

Permalink
Remove unrelated snapshot comment from rds_instance state docs (ansib…
Browse files Browse the repository at this point in the history
…le-collections#1578)

Remove unrelated snapshot comment from rds_instance state docs

SUMMARY
The state field for rds_instance mentions snapshots. But that's irrelevant. Probably an error when copy-pasting to create the module.
Fixes ansible-collections#1574
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
rds_instance

Reviewed-by: Mark Chappell
  • Loading branch information
mdavis-xyz authored May 31, 2023
1 parent f1fe603 commit 4d74baf
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
2 changes: 2 additions & 0 deletions changelogs/fragments/1578-rds-instance-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
trivial:
- "Remove incorrect mention of RDS snapshots in RDS instance state parameter, and reformat the remaining parameter explanation."
6 changes: 3 additions & 3 deletions plugins/modules/rds_instance.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,11 @@
# General module options
state:
description:
- Whether the snapshot should exist or not. I(rebooted) is not idempotent and will leave the DB instance in a running state
- Desired state of the RDS Instance.
- I(state=rebooted) is not idempotent and will leave the DB instance in a running state
and start it prior to rebooting if it was stopped. I(present) will leave the DB instance in the current running/stopped state,
(running if creating the DB instance).
- I(state=running) and I(state=started) are synonyms, as are I(state=rebooted) and I(state=restarted). Note - rebooting the instance
is not idempotent.
- I(state=running) and I(state=started) are synonyms, as are I(state=rebooted) and I(state=restarted).
choices: ['present', 'absent', 'terminated', 'running', 'started', 'stopped', 'rebooted', 'restarted']
default: 'present'
type: str
Expand Down

0 comments on commit 4d74baf

Please sign in to comment.