Rename ACM modules (ansible-collections#1263)

Rename ACM modules SUMMARY In line with what I understood to be the consensus on ansible-collections#881 and ansible-collections#610 Rename aws_acm to acm_certificate Rename aws_acm_info to acm_certificate_info ISSUE TYPE Feature Pull Request COMPONENT NAME aws_acm aws_acm_info acm_certificate acm_certificate_info ADDITIONAL INFORMATION Reviewed-by: Markus Bergholz <[email protected]>
abikouo · Sep 18, 2023 · d44c54d · d44c54d
1 parent 9db4f25
commit d44c54d
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/aws_acm.py → acm_certificate.py b/aws_acm.py → acm_certificate.py
@@ -27,7 +27,7 @@
 
 DOCUMENTATION = r'''
 ---
-module: aws_acm
+module: acm_certificate
 short_description: Upload and delete certificates in the AWS Certificate Manager service
 version_added: 1.0.0
 description:
@@ -74,6 +74,8 @@
   - >
     Note that this may not work properly with keys of size 4096 bits, due to a
     limitation of the ACM API.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_acm).
+    The usage did not change.
 options:
   certificate:
     description:
@@ -176,7 +178,6 @@
   - amazon.aws.aws
   - amazon.aws.ec2
   - amazon.aws.tags.deprecated_purge
-
 '''
 
 EXAMPLES = '''

diff --git a/aws_acm_info.py → acm_certificate_info.py b/aws_acm_info.py → acm_certificate_info.py
@@ -7,12 +7,14 @@
 
 
 DOCUMENTATION = r'''
-module: aws_acm_info
+module: acm_certificate_info
 short_description: Retrieve certificate information from AWS Certificate Manager service
 version_added: 1.0.0
 description:
-  - Retrieve information for ACM certificates
+  - Retrieve information for ACM certificates.
   - Note that this will not return information about uploaded keys of size 4096 bits, due to a limitation of the ACM API.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_acm_info).
+    The usage did not change.
 options:
   certificate_arn:
     description:
@@ -24,13 +26,13 @@
     type: str
   domain_name:
     description:
-      - The domain name of an ACM certificate to limit the search to
+      - The domain name of an ACM certificate to limit the search to.
     aliases:
       - name
     type: str
   statuses:
     description:
-      - Status to filter the certificate results
+      - Status to filter the certificate results.
     choices: ['PENDING_VALIDATION', 'ISSUED', 'INACTIVE', 'EXPIRED', 'VALIDATION_TIMED_OUT', 'REVOKED', 'FAILED']
     type: list
     elements: str