Rename aws_ssm_parameter_store (ansible-collections#1313)

Rename aws_ssm_parameter_store

SUMMARY
Rename aws_ssm_parameter_store to ssm_parameter in line with the new naming guidelines.
ISSUE TYPE

Feature Pull Request

COMPONENT NAME
plugins/modules/aws_ssm_parameter_store.py
plugins/modules/ssm_parameter.py
ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis <None>

README.md

@@ -52,7 +52,6 @@ Name | Description
 [community.aws.aws_msk_config](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_msk_config_module.rst)|Manage Amazon MSK cluster configurations.
 [community.aws.aws_region_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_region_info_module.rst)|Gather information about AWS regions.
 [community.aws.aws_secret](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_secret_module.rst)|Manage secrets stored in AWS Secrets Manager
-[community.aws.aws_ssm_parameter_store](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_ssm_parameter_store_module.rst)|Manage key-value pairs in AWS SSM parameter store
 [community.aws.batch_compute_environment](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.batch_compute_environment_module.rst)|Manage AWS Batch Compute Environments
 [community.aws.batch_job_definition](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.batch_job_definition_module.rst)|Manage AWS Batch Job Definitions
 [community.aws.batch_job_queue](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.batch_job_queue_module.rst)|Manage AWS Batch Job Queues
@@ -209,6 +208,7 @@ Name | Description
 [community.aws.sns_topic](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.sns_topic_module.rst)|Manages AWS SNS topics and subscriptions
 [community.aws.sns_topic_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.sns_topic_info_module.rst)|sns_topic_info module
 [community.aws.sqs_queue](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.sqs_queue_module.rst)|Creates or deletes AWS SQS queues
+[community.aws.ssm_parameter](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ssm_parameter_module.rst)|Manage key-value pairs in AWS Systems Manager Parameter Store
 [community.aws.stepfunctions_state_machine](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.stepfunctions_state_machine_module.rst)|Manage AWS Step Functions state machines
 [community.aws.stepfunctions_state_machine_execution](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.stepfunctions_state_machine_execution_module.rst)|Start or stop execution of an AWS Step Functions state machine
 [community.aws.storagegateway_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.storagegateway_info_module.rst)|Fetch AWS Storage Gateway information

changelogs/fragments/1313-rename-ssm.yml

@@ -0,0 +1,2 @@
+minor_changes:
+- aws_ssm_parameter_store - the ``aws_ssm_parameter_store`` module has been renamed to ``ssm_parameter``, ``aws_ssm_parameter_store`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1313).

docs/community.aws.aws_ssm_parameter_store_module.rst → docs/community.aws.ssm_parameter_module.rst

@@ -1,11 +1,11 @@
-.. _community.aws.aws_ssm_parameter_store_module:
+.. _community.aws.ssm_parameter_module:
 
 
-*************************************
-community.aws.aws_ssm_parameter_store
-*************************************
+***************************
+community.aws.ssm_parameter
+***************************
 
-**Manage key-value pairs in AWS SSM parameter store**
+**Manage key-value pairs in AWS Systems Manager Parameter Store**
 
 
 Version added: 1.0.0
@@ -17,8 +17,8 @@ Version added: 1.0.0
 
 Synopsis
 --------
-- Manage key-value pairs in AWS SSM parameter store.
-- To retreive SSM parameters use the :ref:`amazon.aws.aws_ssm_parameter <amazon.aws.aws_ssm_parameter_module>` lookup plugin.
+- Manage key-value pairs in AWS Systems Manager (SSM) Parameter Store.
+- Prior to release 5.0.0 this module was called ``community.aws.aws_ssm_parameter_store``. The usage did not change.
 
 
 
@@ -389,48 +389,56 @@ Notes
    - ``AWS_REGION`` or ``EC2_REGION`` can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
 
 
+See Also
+--------
+
+.. seealso::
+
+   :ref:`amazon.aws.aws_ssm lookup <ansible_collections.amazon.aws.aws_ssm_lookup>`
+       The documentation for the ``amazon.aws.aws_ssm`` lookup plugin.
+
 
 Examples
 --------
 
 .. code-block:: yaml
 
     - name: Create or update key/value pair in AWS SSM parameter store
-      community.aws.aws_ssm_parameter_store:
+      community.aws.ssm_paramater:
         name: "Hello"
         description: "This is your first key"
         value: "World"
 
     - name: Delete the key
-      community.aws.aws_ssm_parameter_store:
+      community.aws.ssm_paramater:
         name: "Hello"
         state: absent
 
-    - name: Create or update secure key/value pair with default kms key (aws/ssm)
-      community.aws.aws_ssm_parameter_store:
+    - name: Create or update secure key/value pair with default KMS key (aws/ssm)
+      community.aws.ssm_paramater:
         name: "Hello"
         description: "This is your first key"
         string_type: "SecureString"
         value: "World"
 
-    - name: Create or update secure key/value pair with nominated kms key
-      community.aws.aws_ssm_parameter_store:
+    - name: Create or update secure key/value pair with nominated KMS key
+      community.aws.ssm_paramater:
         name: "Hello"
         description: "This is your first key"
         string_type: "SecureString"
         key_id: "alias/demo"
         value: "World"
 
     - name: Always update a parameter store value and create a new version
-      community.aws.aws_ssm_parameter_store:
+      community.aws.ssm_paramater:
         name: "overwrite_example"
         description: "This example will always overwrite the value"
         string_type: "String"
         value: "Test1234"
         overwrite_value: "always"
 
     - name: Create or update key/value pair in AWS SSM parameter store with tier
-      community.aws.aws_ssm_parameter_store:
+      community.aws.ssm_paramater:
         name: "Hello"
         description: "This is your first key"
         value: "World"

meta/runtime.yml

@@ -232,6 +232,7 @@ action_groups:
   - sns_topic
   - sns_topic_info
   - sqs_queue
+  - ssm_parameter
   - stepfunctions_state_machine
   - stepfunctions_state_machine_execution
   - sts_assume_role
@@ -350,6 +351,9 @@ plugin_routing:
     aws_sgw_info:
       # Deprecation for this alias should not *start* prior to 2024-09-01
       redirect: community.aws.storagegateway_info
+    aws_ssm_parameter_store:
+      # Deprecation for this alias should not *start* prior to 2024-09-01
+      redirect: community.aws.ssm_parameter
     aws_step_functions_state_machine:
       # Deprecation for this alias should not *start* prior to 2024-09-01
       redirect: community.aws.stepfunctions_state_machine

plugins/modules/aws_ssm_parameter_store.py → plugins/modules/ssm_parameter.py

@@ -8,11 +8,13 @@
 
 DOCUMENTATION = '''
 ---
-module: aws_ssm_parameter_store
+module: ssm_parameter
 version_added: 1.0.0
-short_description: Manage key-value pairs in AWS SSM parameter store
+short_description: Manage key-value pairs in AWS Systems Manager Parameter Store
 description:
-  - Manage key-value pairs in AWS SSM parameter store.
+  - Manage key-value pairs in AWS Systems Manager (SSM) Parameter Store.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_ssm_parameter_store).
+    The usage did not change.
 options:
   name:
     description:
@@ -85,47 +87,47 @@
   - "Michael De La Rue (@mikedlr)"
 
 extends_documentation_fragment:
-- amazon.aws.aws
-- amazon.aws.ec2
+  - amazon.aws.aws
+  - amazon.aws.ec2
 '''
 
 EXAMPLES = '''
 - name: Create or update key/value pair in AWS SSM parameter store
-  community.aws.aws_ssm_parameter_store:
+  community.aws.ssm_paramater:
     name: "Hello"
     description: "This is your first key"
     value: "World"
 
 - name: Delete the key
-  community.aws.aws_ssm_parameter_store:
+  community.aws.ssm_paramater:
     name: "Hello"
     state: absent
 
-- name: Create or update secure key/value pair with default kms key (aws/ssm)
-  community.aws.aws_ssm_parameter_store:
+- name: Create or update secure key/value pair with default KMS key (aws/ssm)
+  community.aws.ssm_paramater:
     name: "Hello"
     description: "This is your first key"
     string_type: "SecureString"
     value: "World"
 
-- name: Create or update secure key/value pair with nominated kms key
-  community.aws.aws_ssm_parameter_store:
+- name: Create or update secure key/value pair with nominated KMS key
+  community.aws.ssm_paramater:
     name: "Hello"
     description: "This is your first key"
     string_type: "SecureString"
     key_id: "alias/demo"
     value: "World"
 
 - name: Always update a parameter store value and create a new version
-  community.aws.aws_ssm_parameter_store:
+  community.aws.ssm_paramater:
     name: "overwrite_example"
     description: "This example will always overwrite the value"
     string_type: "String"
     value: "Test1234"
     overwrite_value: "always"
 
 - name: Create or update key/value pair in AWS SSM parameter store with tier
-  community.aws.aws_ssm_parameter_store:
+  community.aws.ssm_paramater:
     name: "Hello"
     description: "This is your first key"
     value: "World"