Rename directconnect modules (ansible-collections#1286)

Rename directconnect modules SUMMARY Rename directconnect modules in line with new naming guidelines dropping the aws_ prefix. ISSUE TYPE Feature Pull Request COMPONENT NAME plugins/modules/aws_direct_connect_confirm_connection.py plugins/modules/aws_direct_connect_connection.py plugins/modules/aws_direct_connect_gateway.py plugins/modules/aws_direct_connect_link_aggregation_group.py plugins/modules/aws_direct_connect_virtual_interface.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 ADDITIONAL INFORMATION Reviewed-by: Alina Buzachis <None> Reviewed-by: Mark Chappell <None> Reviewed-by: Markus Bergholz <[email protected]>
abikouo · Jul 1, 2022 · 74da9ad · 74da9ad
1 parent 1be7da1
commit 74da9ad
Show file tree

Hide file tree

Showing 66 changed files with 170 additions and 138 deletions.
diff --git a/README.md b/README.md
@@ -45,11 +45,6 @@ Name | Description
 [community.aws.aws_config_delivery_channel](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_config_delivery_channel_module.rst)|Manage AWS Config delivery channels
 [community.aws.aws_config_recorder](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_config_recorder_module.rst)|Manage AWS Config Recorders
 [community.aws.aws_config_rule](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_config_rule_module.rst)|Manage AWS Config resources
-[community.aws.aws_direct_connect_confirm_connection](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_direct_connect_confirm_connection_module.rst)|Confirms the creation of a hosted DirectConnect connection.
-[community.aws.aws_direct_connect_connection](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_direct_connect_connection_module.rst)|Creates, deletes, modifies a DirectConnect connection
-[community.aws.aws_direct_connect_gateway](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_direct_connect_gateway_module.rst)|Manage AWS Direct Connect gateway
-[community.aws.aws_direct_connect_link_aggregation_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_direct_connect_link_aggregation_group_module.rst)|Manage Direct Connect LAG bundles
-[community.aws.aws_direct_connect_virtual_interface](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_direct_connect_virtual_interface_module.rst)|Manage Direct Connect virtual interfaces
 [community.aws.aws_elasticbeanstalk_app](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_elasticbeanstalk_app_module.rst)|Create, update, and delete an elastic beanstalk application
 [community.aws.aws_glue_connection](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_glue_connection_module.rst)|Manage an AWS Glue connection
 [community.aws.aws_glue_job](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_glue_job_module.rst)|Manage an AWS Glue job
@@ -82,6 +77,11 @@ Name | Description
 [community.aws.cloudwatchlogs_log_group_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.cloudwatchlogs_log_group_info_module.rst)|Get information about log_group in CloudWatchLogs
 [community.aws.cloudwatchlogs_log_group_metric_filter](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.cloudwatchlogs_log_group_metric_filter_module.rst)|Manage CloudWatch log group metric filter
 [community.aws.data_pipeline](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.data_pipeline_module.rst)|Create and manage AWS Datapipelines
+[community.aws.directconnect_confirm_connection](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.directconnect_confirm_connection_module.rst)|Confirms the creation of a hosted DirectConnect connection
+[community.aws.directconnect_connection](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.directconnect_connection_module.rst)|Creates, deletes, modifies a DirectConnect connection
+[community.aws.directconnect_gateway](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.directconnect_gateway_module.rst)|Manage AWS Direct Connect gateway
+[community.aws.directconnect_link_aggregation_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.directconnect_link_aggregation_group_module.rst)|Manage Direct Connect LAG bundles
+[community.aws.directconnect_virtual_interface](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.directconnect_virtual_interface_module.rst)|Manage Direct Connect virtual interfaces
 [community.aws.dms_endpoint](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.dms_endpoint_module.rst)|Creates or destroys a data migration services endpoint
 [community.aws.dms_replication_subnet_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.dms_replication_subnet_group_module.rst)|creates or destroys a data migration services subnet group
 [community.aws.dynamodb_table](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.dynamodb_table_module.rst)|Create, update or delete AWS Dynamo DB tables

diff --git a/changelogs/fragments/1286-rename-directconnect.yml b/changelogs/fragments/1286-rename-directconnect.yml
@@ -0,0 +1,6 @@
+minor_changes:
+- aws_direct_connect_confirm_connection - the ``aws_direct_connect_confirm_connection`` module has been renamed to ``directconnect_confirm_connection``, ``aws_direct_connect_confirm_connection`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1286).
+- aws_direct_connect_connection - the ``aws_direct_connect_connection`` module has been renamed to ``directconnect_connection``, ``aws_direct_connect_connection`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1286).
+- aws_direct_connect_gateway - the ``aws_direct_connect_gateway`` module has been renamed to ``directconnect_gateway``, ``aws_direct_connect_gateway`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1286).
+- aws_direct_connect_link_aggregation_group - the ``aws_direct_connect_link_aggregation_group`` module has been renamed to ``directconnect_link_aggregation_group``, ``aws_direct_connect_link_aggregation_group`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1286).
+- aws_direct_connect_virtual_interface - the ``aws_direct_connect_virtual_interface`` module has been renamed to ``directconnect_virtual_interface``, ``aws_direct_connect_virtual_interface`` remains as an alias (https://github.com/ansible-collections/community.aws/pull/1286).
diff --git a/...ect_connect_confirm_connection_module.rst → ...rectconnect_confirm_connection_module.rst b/...ect_connect_confirm_connection_module.rst → ...rectconnect_confirm_connection_module.rst
@@ -1,11 +1,11 @@
-.. _community.aws.aws_direct_connect_confirm_connection_module:
+.. _community.aws.directconnect_confirm_connection_module:
 
 
-***************************************************
-community.aws.aws_direct_connect_confirm_connection
-***************************************************
+**********************************************
+community.aws.directconnect_confirm_connection
+**********************************************
 
-**Confirms the creation of a hosted DirectConnect connection.**
+**Confirms the creation of a hosted DirectConnect connection**
 
 
 
@@ -17,8 +17,8 @@ community.aws.aws_direct_connect_confirm_connection
 Synopsis
 --------
 - Confirms the creation of a hosted DirectConnect, which requires approval before it can be used.
-- DirectConnect connections that require approval would be in the 'ordering'.
-- After confirmation, they will move to the 'pending' state and finally the 'available' state.
+- DirectConnect connections that require approval would be in the ``ordering``.
+- After confirmation, they will move to the ``pending`` state and finally the ``available`` state.
 
 
 
@@ -265,12 +265,12 @@ Examples
 
     # confirm a Direct Connect by name
     - name: confirm the connection id
-      aws_direct_connect_confirm_connection:
+      community.aws.directconnect_confirm_connection:
         name: my_host_direct_connect
 
     # confirm a Direct Connect by connection_id
     - name: confirm the connection id
-      aws_direct_connect_confirm_connection:
+      community.aws.directconnect_confirm_connection:
         connection_id: dxcon-xxxxxxxx
 
 

diff --git a/....aws_direct_connect_connection_module.rst → ...y.aws.directconnect_connection_module.rst b/....aws_direct_connect_connection_module.rst → ...y.aws.directconnect_connection_module.rst
@@ -1,9 +1,9 @@
-.. _community.aws.aws_direct_connect_connection_module:
+.. _community.aws.directconnect_connection_module:
 
 
-*******************************************
-community.aws.aws_direct_connect_connection
-*******************************************
+**************************************
+community.aws.directconnect_connection
+**************************************
 
 **Creates, deletes, modifies a DirectConnect connection**
 
@@ -17,7 +17,9 @@ Version added: 1.0.0
 
 Synopsis
 --------
-- 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.
+- 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.
 
 
 
@@ -356,7 +358,7 @@ Examples
 .. code-block:: yaml
 
     # create a Direct Connect connection
-    - community.aws.aws_direct_connect_connection:
+    - community.aws.directconnect_connection:
         name: ansible-test-connection
         state: present
         location: EqDC2
@@ -365,22 +367,22 @@ Examples
       register: dc
 
     # disassociate the LAG from the connection
-    - community.aws.aws_direct_connect_connection:
+    - community.aws.directconnect_connection:
         state: present
         connection_id: dc.connection.connection_id
         location: EqDC2
         bandwidth: 1Gbps
 
     # replace the connection with one with more bandwidth
-    - community.aws.aws_direct_connect_connection:
+    - community.aws.directconnect_connection:
         state: present
         name: ansible-test-connection
         location: EqDC2
         bandwidth: 10Gbps
         forced_update: true
 
     # delete the connection
-    - community.aws.aws_direct_connect_connection:
+    - community.aws.directconnect_connection:
         state: absent
         name: ansible-test-connection
 

diff --git a/...aws.aws_direct_connect_gateway_module.rst → ...nity.aws.directconnect_gateway_module.rst b/...aws.aws_direct_connect_gateway_module.rst → ...nity.aws.directconnect_gateway_module.rst
@@ -1,9 +1,9 @@
-.. _community.aws.aws_direct_connect_gateway_module:
+.. _community.aws.directconnect_gateway_module:
 
 
-****************************************
-community.aws.aws_direct_connect_gateway
-****************************************
+***********************************
+community.aws.directconnect_gateway
+***********************************
 
 **Manage AWS Direct Connect gateway**
 
@@ -332,15 +332,15 @@ Examples
 .. code-block:: yaml
 
     - name: Create a new direct connect gateway attached to virtual private gateway
-      community.aws.aws_direct_connect_gateway:
+      community.aws.directconnect_gateway:
         state: present
         name: my-dx-gateway
         amazon_asn: 7224
         virtual_gateway_id: vpg-12345
       register: created_dxgw
 
     - name: Create a new unattached dxgw
-      community.aws.aws_direct_connect_gateway:
+      community.aws.directconnect_gateway:
         state: present
         name: my-dx-gateway
         amazon_asn: 7224

diff --git a/...connect_link_aggregation_group_module.rst → ...connect_link_aggregation_group_module.rst b/...connect_link_aggregation_group_module.rst → ...connect_link_aggregation_group_module.rst
@@ -1,9 +1,9 @@
-.. _community.aws.aws_direct_connect_link_aggregation_group_module:
+.. _community.aws.directconnect_link_aggregation_group_module:
 
 
-*******************************************************
-community.aws.aws_direct_connect_link_aggregation_group
-*******************************************************
+**************************************************
+community.aws.directconnect_link_aggregation_group
+**************************************************
 
 **Manage Direct Connect LAG bundles**
 
@@ -431,7 +431,7 @@ Examples
 .. code-block:: yaml
 
     # create a Direct Connect connection
-    - community.aws.aws_direct_connect_link_aggregation_group:
+    - community.aws.directconnect_link_aggregation_group:
       state: present
       location: EqDC2
       lag_id: dxlag-xxxxxxxx

diff --git a/...rect_connect_virtual_interface_module.rst → ...irectconnect_virtual_interface_module.rst b/...rect_connect_virtual_interface_module.rst → ...irectconnect_virtual_interface_module.rst
@@ -1,9 +1,9 @@
-.. _community.aws.aws_direct_connect_virtual_interface_module:
+.. _community.aws.directconnect_virtual_interface_module:
 
 
-**************************************************
-community.aws.aws_direct_connect_virtual_interface
-**************************************************
+*********************************************
+community.aws.directconnect_virtual_interface
+*********************************************
 
 **Manage Direct Connect virtual interfaces**
 
@@ -458,14 +458,14 @@ Examples
 
     ---
     - name: create an association between a LAG and connection
-      community.aws.aws_direct_connect_virtual_interface:
+      community.aws.directconnect_virtual_interface:
         state: present
         name: "{{ name }}"
         link_aggregation_group_id: LAG-XXXXXXXX
         connection_id: dxcon-XXXXXXXX
 
     - name: remove an association between a connection and virtual interface
-      community.aws.aws_direct_connect_virtual_interface:
+      community.aws.directconnect_virtual_interface:
         state: absent
         connection_id: dxcon-XXXXXXXX
         virtual_interface_id: dxv-XXXXXXXX

diff --git a/meta/runtime.yml b/meta/runtime.yml
@@ -66,6 +66,11 @@ action_groups:
   - cloudwatchlogs_log_group_info
   - cloudwatchlogs_log_group_metric_filter
   - data_pipeline
+  - directconnect_confirm_connection
+  - directconnect_connection
+  - directconnect_gateway
+  - directconnect_link_aggregation_group
+  - directconnect_virtual_interface
   - dms_endpoint
   - dms_replication_subnet_group
   - dynamodb_table
@@ -235,6 +240,21 @@ plugin_routing:
     aws_batch_job_queue:
       # Deprecation for this alias should not *start* prior to 2024-09-01
       redirect: community.aws.batch_job_queue
+    aws_direct_connect_confirm_connection:
+      # Deprecation for this alias should not *start* prior to 2024-09-01
+      redirect: community.aws.directconnect_confirm_connection
+    aws_direct_connect_connection:
+      # Deprecation for this alias should not *start* prior to 2024-09-01
+      redirect: community.aws.directconnect_connection
+    aws_direct_connect_gateway:
+      # Deprecation for this alias should not *start* prior to 2024-09-01
+      redirect: community.aws.directconnect_gateway
+    aws_direct_connect_link_aggregation_group:
+      # Deprecation for this alias should not *start* prior to 2024-09-01
+      redirect: community.aws.directconnect_link_aggregation_group
+    aws_direct_connect_virtual_interface:
+      # Deprecation for this alias should not *start* prior to 2024-09-01
+      redirect: community.aws.directconnect_virtual_interface
     aws_eks_cluster:
       # Deprecation for this alias should not *start* prior to 2024-09-01
       redirect: community.aws.eks_cluster

diff --git a/.../aws_direct_connect_confirm_connection.py → ...dules/directconnect_confirm_connection.py b/.../aws_direct_connect_confirm_connection.py → ...dules/directconnect_confirm_connection.py
@@ -11,16 +11,17 @@
 
 DOCUMENTATION = '''
 ---
-module: aws_direct_connect_confirm_connection
-short_description: Confirms the creation of a hosted DirectConnect connection.
+module: directconnect_confirm_connection
+short_description: Confirms the creation of a hosted DirectConnect connection
 description:
   - Confirms the creation of a hosted DirectConnect, which requires approval before it can be used.
-  - DirectConnect connections that require approval would be in the 'ordering'.
-  - After confirmation, they will move to the 'pending' state and finally the 'available' state.
-author: "Matt Traynham (@mtraynham)"
+  - 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.
+author:
+  - "Matt Traynham (@mtraynham)"
 extends_documentation_fragment:
-- amazon.aws.aws
-- amazon.aws.ec2
+  - amazon.aws.aws
+  - amazon.aws.ec2
 options:
   name:
     description:
@@ -38,12 +39,12 @@
 
 # confirm a Direct Connect by name
 - name: confirm the connection id
-  aws_direct_connect_confirm_connection:
+  community.aws.directconnect_confirm_connection:
     name: my_host_direct_connect
 
 # confirm a Direct Connect by connection_id
 - name: confirm the connection id
-  aws_direct_connect_confirm_connection:
+  community.aws.directconnect_confirm_connection:
     connection_id: dxcon-xxxxxxxx
 '''
 

diff --git a/.../modules/aws_direct_connect_connection.py → plugins/modules/directconnect_connection.py b/.../modules/aws_direct_connect_connection.py → plugins/modules/directconnect_connection.py
@@ -8,17 +8,18 @@
 
 DOCUMENTATION = '''
 ---
-module: aws_direct_connect_connection
+module: directconnect_connection
 version_added: 1.0.0
 short_description: Creates, deletes, modifies a DirectConnect connection
 description:
   - 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.
-author: "Sloane Hertel (@s-hertel)"
+  - 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.
+author:
+  - "Sloane Hertel (@s-hertel)"
 extends_documentation_fragment:
-- amazon.aws.aws
-- amazon.aws.ec2
+  - amazon.aws.aws
+  - amazon.aws.ec2
 options:
   state:
     description:
@@ -69,7 +70,7 @@
 EXAMPLES = """
 
 # create a Direct Connect connection
-- community.aws.aws_direct_connect_connection:
+- community.aws.directconnect_connection:
     name: ansible-test-connection
     state: present
     location: EqDC2
@@ -78,22 +79,22 @@
   register: dc
 
 # disassociate the LAG from the connection
-- community.aws.aws_direct_connect_connection:
+- community.aws.directconnect_connection:
     state: present
     connection_id: dc.connection.connection_id
     location: EqDC2
     bandwidth: 1Gbps
 
 # replace the connection with one with more bandwidth
-- community.aws.aws_direct_connect_connection:
+- community.aws.directconnect_connection:
     state: present
     name: ansible-test-connection
     location: EqDC2
     bandwidth: 10Gbps
     forced_update: true
 
 # delete the connection
-- community.aws.aws_direct_connect_connection:
+- community.aws.directconnect_connection:
     state: absent
     name: ansible-test-connection
 """

diff --git a/...ins/modules/aws_direct_connect_gateway.py → plugins/modules/directconnect_gateway.py b/...ins/modules/aws_direct_connect_gateway.py → plugins/modules/directconnect_gateway.py
@@ -7,8 +7,9 @@
 
 
 DOCUMENTATION = '''
-module: aws_direct_connect_gateway
-author: Gobin Sougrakpam (@gobins)
+module: directconnect_gateway
+author:
+  - Gobin Sougrakpam (@gobins)
 version_added: 1.0.0
 short_description: Manage AWS Direct Connect gateway
 description:
@@ -17,8 +18,8 @@
   - Attaches Virtual Gateways to Direct Connect Gateway.
   - Detaches Virtual Gateways to Direct Connect Gateway.
 extends_documentation_fragment:
-- amazon.aws.aws
-- amazon.aws.ec2
+  - amazon.aws.aws
+  - amazon.aws.ec2
 options:
   state:
     description:
@@ -54,20 +55,19 @@
 
 EXAMPLES = '''
 - name: Create a new direct connect gateway attached to virtual private gateway
-  community.aws.aws_direct_connect_gateway:
+  community.aws.directconnect_gateway:
     state: present
     name: my-dx-gateway
     amazon_asn: 7224
     virtual_gateway_id: vpg-12345
   register: created_dxgw
 
 - name: Create a new unattached dxgw
-  community.aws.aws_direct_connect_gateway:
+  community.aws.directconnect_gateway:
     state: present
     name: my-dx-gateway
     amazon_asn: 7224
   register: created_dxgw
-
 '''
 
 RETURN = '''