Add missing note about renames to description of various modules (ans…

…ible-collections#1319) Add missing note about renames to description of various modules SUMMARY Minor post-rename docs cleanups Add notes about rename regen docs with FQCN in examples ISSUE TYPE Docs Pull Request COMPONENT NAME docs/community.aws.api_gateway_domain_module.rst docs/community.aws.api_gateway_module.rst docs/community.aws.application_autoscaling_policy_module.rst docs/community.aws.config_aggregation_authorization_module.rst docs/community.aws.config_aggregator_module.rst docs/community.aws.config_delivery_channel_module.rst docs/community.aws.config_recorder_module.rst docs/community.aws.config_rule_module.rst docs/community.aws.directconnect_confirm_connection_module.rst docs/community.aws.directconnect_connection_module.rst docs/community.aws.directconnect_gateway_module.rst docs/community.aws.directconnect_link_aggregation_group_module.rst docs/community.aws.directconnect_virtual_interface_module.rst docs/community.aws.elasticbeanstalk_app_module.rst docs/community.aws.msk_cluster_module.rst docs/community.aws.msk_config_module.rst docs/community.aws.storagegateway_info_module.rst plugins/modules/api_gateway.py plugins/modules/api_gateway_domain.py plugins/modules/config_aggregation_authorization.py plugins/modules/config_aggregator.py plugins/modules/config_delivery_channel.py plugins/modules/config_recorder.py plugins/modules/config_rule.py plugins/modules/directconnect_confirm_connection.py plugins/modules/directconnect_connection.py plugins/modules/directconnect_gateway.py plugins/modules/directconnect_link_aggregation_group.py plugins/modules/directconnect_virtual_interface.py plugins/modules/elasticbeanstalk_app.py plugins/modules/storagegateway_info.py ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis <None>
abikouo · Jul 6, 2022 · 8e7b7dd · 8e7b7dd
1 parent 599952c
commit 8e7b7dd
Show file tree

Hide file tree

Showing 14 changed files with 28 additions and 0 deletions.
diff --git a/api_gateway.py b/api_gateway.py
@@ -22,6 +22,8 @@
   - swagger_file and swagger_text are passed directly on to AWS
     transparently whilst swagger_dict is an ansible dict which is
     converted to JSON before the API definitions are uploaded.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_api_gateway).
+    The usage did not change.
 options:
   api_id:
     description:

diff --git a/api_gateway_domain.py b/api_gateway_domain.py
@@ -14,6 +14,8 @@
   - Manages API Gateway custom domains for API GW Rest APIs.
   - AWS API Gateway custom domain setups use CloudFront behind the scenes.
     So you will get a CloudFront distribution as a result, configured to be aliased with your domain.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_api_gateway_domain).
+    The usage did not change.
 version_added: '3.3.0'
 author:
   - 'Stefan Horning (@stefanhorning)'

diff --git a/config_aggregation_authorization.py b/config_aggregation_authorization.py
@@ -14,6 +14,8 @@
 short_description: Manage cross-account AWS Config authorizations
 description:
   - Module manages AWS Config aggregation authorizations.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_config_aggregation_authorization).
+    The usage did not change.
 author:
   - "Aaron Smith (@slapula)"
 options:

diff --git a/config_aggregator.py b/config_aggregator.py
@@ -14,6 +14,8 @@
 short_description: Manage AWS Config aggregations across multiple accounts
 description:
   - Module manages AWS Config aggregator resources.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_config_aggregator).
+    The usage did not change.
 author:
   - "Aaron Smith (@slapula)"
 options:

diff --git a/config_delivery_channel.py b/config_delivery_channel.py
@@ -14,6 +14,8 @@
 short_description: Manage AWS Config delivery channels
 description:
   - This module manages AWS Config delivery locations for rule checks and configuration info.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_config_delivery_channel).
+    The usage did not change.
 author:
   - "Aaron Smith (@slapula)"
 options:

diff --git a/config_recorder.py b/config_recorder.py
@@ -14,6 +14,8 @@
 short_description: Manage AWS Config Recorders
 description:
   - Module manages AWS Config configuration recorder settings.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_config_recorder).
+    The usage did not change.
 author:
   - "Aaron Smith (@slapula)"
 options:

diff --git a/config_rule.py b/config_rule.py
@@ -14,6 +14,8 @@
 short_description: Manage AWS Config rule resources
 description:
   - Module manages AWS Config rules.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_config_rule).
+    The usage did not change.
 author:
   - "Aaron Smith (@slapula)"
 options:

diff --git a/directconnect_confirm_connection.py b/directconnect_confirm_connection.py
@@ -17,6 +17,8 @@
   - Confirms the creation of a hosted DirectConnect, which requires approval before it can be used.
   - DirectConnect connections that require approval would be in the C(ordering).
   - After confirmation, they will move to the C(pending) state and finally the C(available) state.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_direct_connect_confirm_connection).
+    The usage did not change.
 author:
   - "Matt Traynham (@mtraynham)"
 extends_documentation_fragment:

diff --git a/directconnect_connection.py b/directconnect_connection.py
@@ -15,6 +15,8 @@
   - Create, update, or delete a Direct Connect connection between a network and a specific AWS Direct Connect location.
   - Upon creation the connection may be added to a link aggregation group or established as a standalone connection.
   - The connection may later be associated or disassociated with a link aggregation group.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_direct_connect_connection).
+    The usage did not change.
 author:
   - "Sloane Hertel (@s-hertel)"
 extends_documentation_fragment:

diff --git a/directconnect_gateway.py b/directconnect_gateway.py
@@ -17,6 +17,8 @@
   - Deletes AWS Direct Connect Gateway.
   - Attaches Virtual Gateways to Direct Connect Gateway.
   - Detaches Virtual Gateways to Direct Connect Gateway.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_direct_connect_gateway).
+    The usage did not change.
 extends_documentation_fragment:
   - amazon.aws.aws
   - amazon.aws.ec2

diff --git a/directconnect_link_aggregation_group.py b/directconnect_link_aggregation_group.py
@@ -13,6 +13,8 @@
 short_description: Manage Direct Connect LAG bundles
 description:
   - Create, delete, or modify a Direct Connect link aggregation group.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_direct_connect_link_aggregation_group).
+    The usage did not change.
 author:
   - "Sloane Hertel (@s-hertel)"
 extends_documentation_fragment:

diff --git a/directconnect_virtual_interface.py b/directconnect_virtual_interface.py
@@ -13,6 +13,8 @@
 short_description: Manage Direct Connect virtual interfaces
 description:
   - Create, delete, or modify a Direct Connect public or private virtual interface.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_direct_connect_virtual_interface).
+    The usage did not change.
 author:
   - "Sloane Hertel (@s-hertel)"
 options:

diff --git a/elasticbeanstalk_app.py b/elasticbeanstalk_app.py
@@ -15,6 +15,8 @@
 
 description:
   - Creates, updates, deletes Elastic Beanstalk applications if I(app_name) is provided.
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_elasticbeanstalk_app).
+    The usage did not change.
 
 options:
   app_name:

diff --git a/storagegateway_info.py b/storagegateway_info.py
@@ -15,6 +15,8 @@
 short_description: Fetch AWS Storage Gateway information
 description:
   - Fetch AWS Storage Gateway information
+  - Prior to release 5.0.0 this module was called C(community.aws.aws_sgw_info).
+    The usage did not change.
 author:
   - Loic Blot (@nerzhul) <loic.blot@unix-experience.fr>
 options: