diff --git a/README.md b/README.md index e0ea64137da..1d91d5d7632 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,6 @@ Name | Description [community.aws.autoscaling_policy](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.autoscaling_policy_module.rst)|Create or delete AWS scaling policies for Autoscaling groups [community.aws.autoscaling_scheduled_action](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.autoscaling_scheduled_action_module.rst)|Create, modify and delete ASG scheduled scaling actions [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.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 @@ -201,6 +200,7 @@ Name | Description [community.aws.s3_metrics_configuration](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.s3_metrics_configuration_module.rst)|Manage s3 bucket metrics configuration in AWS [community.aws.s3_sync](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.s3_sync_module.rst)|Efficiently upload multiple files to S3 [community.aws.s3_website](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.s3_website_module.rst)|Configure an s3 bucket as a website +[community.aws.secretsmanager_secret](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.secretsmanager_secret_module.rst)|Manage secrets stored in AWS Secrets Manager [community.aws.ses_identity](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ses_identity_module.rst)|Manages SES email and domain identity [community.aws.ses_identity_policy](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ses_identity_policy_module.rst)|Manages SES sending authorization policies [community.aws.ses_rule_set](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ses_rule_set_module.rst)|Manages SES inbound receipt rule sets diff --git a/changelogs/fragments/1315-rename-aws_secret.yml b/changelogs/fragments/1315-rename-aws_secret.yml new file mode 100644 index 00000000000..2bef600c639 --- /dev/null +++ b/changelogs/fragments/1315-rename-aws_secret.yml @@ -0,0 +1,2 @@ +minor_changes: +- aws_secret - the ``aws_secret`` module has been renamed to ``secretsmanager_secret``, ``aws_secret`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1315). diff --git a/docs/community.aws.aws_secret_module.rst b/docs/community.aws.secretsmanager_secret_module.rst similarity index 98% rename from docs/community.aws.aws_secret_module.rst rename to docs/community.aws.secretsmanager_secret_module.rst index e6a0aa14129..c32c713f795 100644 --- a/docs/community.aws.aws_secret_module.rst +++ b/docs/community.aws.secretsmanager_secret_module.rst @@ -1,9 +1,9 @@ -.. _community.aws.aws_secret_module: +.. _community.aws.secretsmanager_secret_module: -************************ -community.aws.aws_secret -************************ +*********************************** +community.aws.secretsmanager_secret +*********************************** **Manage secrets stored in AWS Secrets Manager** @@ -18,6 +18,7 @@ Version added: 1.0.0 Synopsis -------- - Create, update, and delete secrets stored in AWS Secrets Manager. +- Prior to release 5.0.0 this module was called ``community.aws.aws_secret``. The usage did not change. @@ -435,14 +436,14 @@ Examples .. code-block:: yaml - name: Add string to AWS Secrets Manager - community.aws.aws_secret: + community.aws.secretsmanager_secret: name: 'test_secret_string' state: present secret_type: 'string' secret: "{{ super_secret_string }}" - name: Add a secret with resource policy attached - community.aws.aws_secret: + community.aws.secretsmanager_secret: name: 'test_secret_string' state: present secret_type: 'string' @@ -450,7 +451,7 @@ Examples resource_policy: "{{ lookup('template', 'templates/resource_policy.json.j2', convert_data=False) | string }}" - name: remove string from AWS Secrets Manager - community.aws.aws_secret: + community.aws.secretsmanager_secret: name: 'test_secret_string' state: absent secret_type: 'string' diff --git a/meta/runtime.yml b/meta/runtime.yml index 338af204743..c2e9b30b13a 100644 --- a/meta/runtime.yml +++ b/meta/runtime.yml @@ -229,6 +229,7 @@ action_groups: - s3_metrics_configuration - s3_sync - s3_website + - secretsmanager_secret - ses_identity - ses_identity_policy - ses_rule_set @@ -355,6 +356,9 @@ plugin_routing: aws_s3_cors: # Deprecation for this alias should not *start* prior to 2024-09-01 redirect: community.aws.s3_cors + aws_secret: + # Deprecation for this alias should not *start* prior to 2024-09-01 + redirect: community.aws.secretsmanager_secret aws_ses_identity: # Deprecation for this alias should not *start* prior to 2024-09-01 redirect: community.aws.ses_identity diff --git a/plugins/modules/aws_secret.py b/plugins/modules/secretsmanager_secret.py similarity index 98% rename from plugins/modules/aws_secret.py rename to plugins/modules/secretsmanager_secret.py index 044ba1061ae..2ce3351077b 100644 --- a/plugins/modules/aws_secret.py +++ b/plugins/modules/secretsmanager_secret.py @@ -8,11 +8,13 @@ DOCUMENTATION = r''' --- -module: aws_secret +module: secretsmanager_secret version_added: 1.0.0 short_description: Manage secrets stored in AWS Secrets Manager description: - Create, update, and delete secrets stored in AWS Secrets Manager. + - Prior to release 5.0.0 this module was called C(community.aws.aws_secret). + The usage did not change. author: - "REY Remi (@rrey)" options: @@ -80,14 +82,14 @@ EXAMPLES = r''' - name: Add string to AWS Secrets Manager - community.aws.aws_secret: + community.aws.secretsmanager_secret: name: 'test_secret_string' state: present secret_type: 'string' secret: "{{ super_secret_string }}" - name: Add a secret with resource policy attached - community.aws.aws_secret: + community.aws.secretsmanager_secret: name: 'test_secret_string' state: present secret_type: 'string' @@ -95,7 +97,7 @@ resource_policy: "{{ lookup('template', 'templates/resource_policy.json.j2', convert_data=False) | string }}" - name: remove string from AWS Secrets Manager - community.aws.aws_secret: + community.aws.secretsmanager_secret: name: 'test_secret_string' state: absent secret_type: 'string' diff --git a/tests/integration/targets/aws_secret/aliases b/tests/integration/targets/secretsmanager_secret/aliases similarity index 100% rename from tests/integration/targets/aws_secret/aliases rename to tests/integration/targets/secretsmanager_secret/aliases diff --git a/tests/integration/targets/aws_secret/defaults/main.yaml b/tests/integration/targets/secretsmanager_secret/defaults/main.yaml similarity index 100% rename from tests/integration/targets/aws_secret/defaults/main.yaml rename to tests/integration/targets/secretsmanager_secret/defaults/main.yaml diff --git a/tests/integration/targets/aws_secret/files/hello_world.zip b/tests/integration/targets/secretsmanager_secret/files/hello_world.zip similarity index 100% rename from tests/integration/targets/aws_secret/files/hello_world.zip rename to tests/integration/targets/secretsmanager_secret/files/hello_world.zip diff --git a/tests/integration/targets/aws_secret/files/secretsmanager-trust-policy.json b/tests/integration/targets/secretsmanager_secret/files/secretsmanager-trust-policy.json similarity index 100% rename from tests/integration/targets/aws_secret/files/secretsmanager-trust-policy.json rename to tests/integration/targets/secretsmanager_secret/files/secretsmanager-trust-policy.json diff --git a/tests/integration/targets/aws_secret/meta/main.yml b/tests/integration/targets/secretsmanager_secret/meta/main.yml similarity index 100% rename from tests/integration/targets/aws_secret/meta/main.yml rename to tests/integration/targets/secretsmanager_secret/meta/main.yml diff --git a/tests/integration/targets/aws_secret/tasks/basic.yml b/tests/integration/targets/secretsmanager_secret/tasks/basic.yml similarity index 100% rename from tests/integration/targets/aws_secret/tasks/basic.yml rename to tests/integration/targets/secretsmanager_secret/tasks/basic.yml diff --git a/tests/integration/targets/aws_secret/tasks/main.yaml b/tests/integration/targets/secretsmanager_secret/tasks/main.yaml similarity index 100% rename from tests/integration/targets/aws_secret/tasks/main.yaml rename to tests/integration/targets/secretsmanager_secret/tasks/main.yaml diff --git a/tests/integration/targets/aws_secret/tasks/rotation.yml b/tests/integration/targets/secretsmanager_secret/tasks/rotation.yml similarity index 100% rename from tests/integration/targets/aws_secret/tasks/rotation.yml rename to tests/integration/targets/secretsmanager_secret/tasks/rotation.yml diff --git a/tests/integration/targets/aws_secret/templates/secret-policy.j2 b/tests/integration/targets/secretsmanager_secret/templates/secret-policy.j2 similarity index 100% rename from tests/integration/targets/aws_secret/templates/secret-policy.j2 rename to tests/integration/targets/secretsmanager_secret/templates/secret-policy.j2