Rename rds_snapshot to rds_instance_snapshot (#783)

Rename rds_snapshot to rds_instance_snapshot

SUMMARY

Rename rds_snapshot to rds_instance_snapshot since rds_snapshot only handles snapshotting of DB instances. A new module for snapshotting RDS clusters will be added in a future PR.

ISSUE TYPE


New Module Pull Request

COMPONENT NAME

rds_snapshot

Reviewed-by: Mark Chappell <None>
Reviewed-by: None <None>

changelogs/fragments/783-rds_snapshot.yml

@@ -0,0 +1,3 @@
+deprecated_features:
+ - rds_snapshot - the rds_snapshot module has been renamed to rds_instance_snapshot.
+   The usage of the module has not changed. The rds_snapshot alias will be removed in version 4.0.0 (https://github.com/ansible-collections/community.aws/pull/783).

meta/runtime.yml

@@ -190,6 +190,7 @@ action_groups:
   - rds_instance_info
   - rds_param_group
   - rds_snapshot
+  - rds_instance_snapshot
   - rds_snapshot_info
   - rds_subnet_group
   - rds_option_group
@@ -520,3 +521,10 @@ plugin_routing:
         warning_text: >-
           route53_facts was renamed in Ansible 2.9 to route53_info.
           Please update your tasks.
+    rds_snapshot:
+       redirect: community.aws.rds_instance_snapshot
+       deprecation:
+         removal_version: 4.0.0
+         warning_text: >-
+           rds_snapshot has been renamed to rds_instance_snapshot.
+           Please update your tasks.

plugins/modules/rds_snapshot.py → plugins/modules/rds_instance_snapshot.py

@@ -10,7 +10,7 @@
 
 DOCUMENTATION = '''
 ---
-module: rds_snapshot
+module: rds_instance_snapshot
 version_added: 1.0.0
 short_description: manage Amazon RDS snapshots.
 description:
@@ -66,12 +66,12 @@
 
 EXAMPLES = '''
 - name: Create snapshot
-  community.aws.rds_snapshot:
+  community.aws.rds_instance_snapshot:
     db_instance_identifier: new-database
     db_snapshot_identifier: new-database-snapshot
 
 - name: Delete snapshot
-  community.aws.rds_snapshot:
+  community.aws.rds_instance_snapshot:
     db_snapshot_identifier: new-database-snapshot
     state: absent
 '''

tests/integration/targets/rds_instance/roles/rds_instance/tasks/test_states.yml

@@ -144,7 +144,7 @@
 
   always:
     - name: remove snapshot
-      rds_snapshot:
+      rds_instance_snapshot:
         db_snapshot_identifier: "{{ resource_prefix }}-test-snapshot"
         state: absent
         wait: false