diff --git a/README.md b/README.md index 2deced74c63..1e0c966ac45 100644 --- a/README.md +++ b/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 diff --git a/changelogs/fragments/1313-rename-ssm.yml b/changelogs/fragments/1313-rename-ssm.yml new file mode 100644 index 00000000000..67e2bd43bb1 --- /dev/null +++ b/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). diff --git a/docs/community.aws.aws_ssm_parameter_store_module.rst b/docs/community.aws.ssm_parameter_module.rst similarity index 97% rename from docs/community.aws.aws_ssm_parameter_store_module.rst rename to docs/community.aws.ssm_parameter_module.rst index bd420f45053..17a10397a3f 100644 --- a/docs/community.aws.aws_ssm_parameter_store_module.rst +++ b/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 ` 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,6 +389,14 @@ 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 ` + The documentation for the ``amazon.aws.aws_ssm`` lookup plugin. + Examples -------- @@ -396,25 +404,25 @@ 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" @@ -422,7 +430,7 @@ Examples 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" @@ -430,7 +438,7 @@ Examples 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" diff --git a/meta/runtime.yml b/meta/runtime.yml index 2bcafec19e0..dc3469f0303 100644 --- a/meta/runtime.yml +++ b/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 diff --git a/plugins/modules/aws_ssm_parameter_store.py b/plugins/modules/ssm_parameter.py similarity index 95% rename from plugins/modules/aws_ssm_parameter_store.py rename to plugins/modules/ssm_parameter.py index b3c13015c26..7a6e7eb7c20 100644 --- a/plugins/modules/aws_ssm_parameter_store.py +++ b/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,31 +87,31 @@ - "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" @@ -117,7 +119,7 @@ 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" @@ -125,7 +127,7 @@ 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" diff --git a/tests/integration/targets/aws_ssm_parameter_store/aliases b/tests/integration/targets/ssm_parameter/aliases similarity index 100% rename from tests/integration/targets/aws_ssm_parameter_store/aliases rename to tests/integration/targets/ssm_parameter/aliases diff --git a/tests/integration/targets/aws_ssm_parameter_store/defaults/main.yml b/tests/integration/targets/ssm_parameter/defaults/main.yml similarity index 100% rename from tests/integration/targets/aws_ssm_parameter_store/defaults/main.yml rename to tests/integration/targets/ssm_parameter/defaults/main.yml diff --git a/tests/integration/targets/aws_ssm_parameter_store/meta/main.yml b/tests/integration/targets/ssm_parameter/meta/main.yml similarity index 100% rename from tests/integration/targets/aws_ssm_parameter_store/meta/main.yml rename to tests/integration/targets/ssm_parameter/meta/main.yml diff --git a/tests/integration/targets/aws_ssm_parameter_store/tasks/main.yml b/tests/integration/targets/ssm_parameter/tasks/main.yml similarity index 100% rename from tests/integration/targets/aws_ssm_parameter_store/tasks/main.yml rename to tests/integration/targets/ssm_parameter/tasks/main.yml