docs

ansible-collections · Jul 1, 2022 · 06f12bb · 06f12bb
1 parent 5612376
commit 06f12bb
Show file tree

Hide file tree

Showing 24 changed files with 318 additions and 301 deletions.
diff --git a/README.md b/README.md
@@ -36,6 +36,16 @@ Name | Description
 [community.aws.acm_certificate_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.acm_certificate_info_module.rst)|Retrieve certificate information from AWS Certificate Manager service
 [community.aws.api_gateway](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.api_gateway_module.rst)|Manage AWS API Gateway APIs
 [community.aws.api_gateway_domain](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.api_gateway_domain_module.rst)|Manage AWS API Gateway custom domains
+[community.aws.autoscaling_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.autoscaling_group_module.rst)|Create or delete AWS AutoScaling Groups (ASGs)
+[community.aws.autoscaling_group_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.autoscaling_group_info_module.rst)|Gather information about EC2 Auto Scaling Groups (ASGs) in AWS
+[community.aws.autoscaling_instance_refresh](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.autoscaling_instance_refresh_module.rst)|Start or cancel an EC2 Auto Scaling Group (ASG) instance refresh in AWS
+[community.aws.autoscaling_instance_refresh_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.autoscaling_instance_refresh_info_module.rst)|Gather information about EC2 Auto Scaling Group (ASG) Instance Refreshes in AWS
+[community.aws.autoscaling_launch_config](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.autoscaling_launch_config_module.rst)|Create or delete AWS Autoscaling Launch Configurations
+[community.aws.autoscaling_launch_config_find](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.autoscaling_launch_config_find_module.rst)|Find AWS Autoscaling Launch Configurations
+[community.aws.autoscaling_launch_config_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.autoscaling_launch_config_info_module.rst)|Gather information about AWS Autoscaling Launch Configurations
+[community.aws.autoscaling_lifecycle_hook](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.autoscaling_lifecycle_hook_module.rst)|Create, delete or update AWS ASG Lifecycle Hooks
+[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_application_scaling_policy](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_application_scaling_policy_module.rst)|Manage Application Auto Scaling Scaling Policies
 [community.aws.aws_codebuild](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_codebuild_module.rst)|Create or delete an AWS CodeBuild project
 [community.aws.aws_codecommit](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.aws_codecommit_module.rst)|Manage repositories in AWS CodeCommit
@@ -87,24 +97,14 @@ Name | Description
 [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
 [community.aws.dynamodb_ttl](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.dynamodb_ttl_module.rst)|Set TTL for a given DynamoDB table
 [community.aws.ec2_ami_copy](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_ami_copy_module.rst)|copies AMI between AWS regions, return new image id
-[community.aws.ec2_asg](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_asg_module.rst)|Create or delete AWS AutoScaling Groups (ASGs)
-[community.aws.ec2_asg_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_asg_info_module.rst)|Gather information about ec2 Auto Scaling Groups (ASGs) in AWS
-[community.aws.ec2_asg_instance_refresh](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_asg_instance_refresh_module.rst)|Start or cancel an EC2 Auto Scaling Group (ASG) instance refresh in AWS
-[community.aws.ec2_asg_instance_refresh_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_asg_instance_refresh_info_module.rst)|Gather information about ec2 Auto Scaling Group (ASG) Instance Refreshes in AWS
-[community.aws.ec2_asg_lifecycle_hook](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_asg_lifecycle_hook_module.rst)|Create, delete or update AWS ASG Lifecycle Hooks.
-[community.aws.ec2_asg_scheduled_action](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_asg_scheduled_action_module.rst)|Create, modify and delete ASG scheduled scaling actions.
 [community.aws.ec2_customer_gateway](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_customer_gateway_module.rst)|Manage an AWS customer gateway
 [community.aws.ec2_customer_gateway_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_customer_gateway_info_module.rst)|Gather information about customer gateways in AWS
 [community.aws.ec2_eip](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_eip_module.rst)|manages EC2 elastic IP (EIP) addresses.
 [community.aws.ec2_eip_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_eip_info_module.rst)|List EC2 EIP details
 [community.aws.ec2_launch_template](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_launch_template_module.rst)|Manage EC2 launch templates
-[community.aws.ec2_lc](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_lc_module.rst)|Create or delete AWS Autoscaling Launch Configurations
-[community.aws.ec2_lc_find](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_lc_find_module.rst)|Find AWS Autoscaling Launch Configurations
-[community.aws.ec2_lc_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_lc_info_module.rst)|Gather information about AWS Autoscaling Launch Configurations.
 [community.aws.ec2_metric_alarm](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_metric_alarm_module.rst)|Create/update or delete AWS Cloudwatch 'metric alarms'
 [community.aws.ec2_placement_group](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_placement_group_module.rst)|Create or delete an EC2 Placement Group
 [community.aws.ec2_placement_group_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_placement_group_info_module.rst)|List EC2 Placement Group(s) details
-[community.aws.ec2_scaling_policy](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_scaling_policy_module.rst)|Create or delete AWS scaling policies for Autoscaling groups
 [community.aws.ec2_snapshot_copy](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_snapshot_copy_module.rst)|Copies an EC2 snapshot and returns the new Snapshot ID
 [community.aws.ec2_transit_gateway](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_transit_gateway_module.rst)|Create and delete AWS Transit Gateways
 [community.aws.ec2_transit_gateway_info](https://github.com/ansible-collections/community.aws/blob/main/docs/community.aws.ec2_transit_gateway_info_module.rst)|Gather information about ec2 transit gateways in AWS

diff --git a/docs/community.aws.ec2_asg_info_module.rst → ...ity.aws.autoscaling_group_info_module.rst b/docs/community.aws.ec2_asg_info_module.rst → ...ity.aws.autoscaling_group_info_module.rst
@@ -1,11 +1,11 @@
-.. _community.aws.ec2_asg_info_module:
+.. _community.aws.autoscaling_group_info_module:
 
 
-**************************
-community.aws.ec2_asg_info
-**************************
+************************************
+community.aws.autoscaling_group_info
+************************************
 
-**Gather information about ec2 Auto Scaling Groups (ASGs) in AWS**
+**Gather information about EC2 Auto Scaling Groups (ASGs) in AWS**
 
 
 Version added: 1.0.0
@@ -17,7 +17,8 @@ Version added: 1.0.0
 
 Synopsis
 --------
-- Gather information about ec2 Auto Scaling Groups (ASGs) in AWS
+- Gather information about EC2 Auto Scaling Groups (ASGs) in AWS.
+- Prior to release 5.0.0 this module was called ``community.aws.ec2_asg_info``. The usage did not change.
 
 
 
@@ -264,36 +265,36 @@ Examples
     # Note: These examples do not set authentication details, see the AWS Guide for details.
 
     - name: Find all groups
-      community.aws.ec2_asg_info:
+      community.aws.autoscaling_group_info:
       register: asgs
 
     - name: Find a group with matching name/prefix
-      community.aws.ec2_asg_info:
+      community.aws.autoscaling_group_info:
         name: public-webserver-asg
       register: asgs
 
     - name: Find a group with matching tags
-      community.aws.ec2_asg_info:
+      community.aws.autoscaling_group_info:
         tags:
           project: webapp
           env: production
       register: asgs
 
     - name: Find a group with matching name/prefix and tags
-      community.aws.ec2_asg_info:
+      community.aws.autoscaling_group_info:
         name: myproject
         tags:
           env: production
       register: asgs
 
     - name: Fail if no groups are found
-      community.aws.ec2_asg_info:
+      community.aws.autoscaling_group_info:
         name: public-webserver-asg
       register: asgs
       failed_when: "{{ asgs.results | length == 0 }}"
 
     - name: Fail if more than 1 group is found
-      community.aws.ec2_asg_info:
+      community.aws.autoscaling_group_info:
         name: public-webserver-asg
       register: asgs
       failed_when: "{{ asgs.results | length > 1 }}"
@@ -476,7 +477,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                 </td>
                 <td>success</td>
                 <td>
-                            <div>Name of launch configuration associated with the ASG. Same as launch_configuration_name, provided for compatibility with ec2_asg module.</div>
+                            <div>Name of launch configuration associated with the ASG. Same as launch_configuration_name, provided for compatibility with <span class='module'>community.aws.autoscaling_group</span> module.</div>
                     <br/>
                         <div style="font-size: smaller"><b>Sample:</b></div>
                         <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">public-webapp-production-1</div>

diff --git a/docs/community.aws.ec2_asg_module.rst → ...ommunity.aws.autoscaling_group_module.rst b/docs/community.aws.ec2_asg_module.rst → ...ommunity.aws.autoscaling_group_module.rst
@@ -1,9 +1,9 @@
-.. _community.aws.ec2_asg_module:
+.. _community.aws.autoscaling_group_module:
 
 
-*********************
-community.aws.ec2_asg
-*********************
+*******************************
+community.aws.autoscaling_group
+*******************************
 
 **Create or delete AWS AutoScaling Groups (ASGs)**
 
@@ -18,7 +18,8 @@ Version added: 1.0.0
 Synopsis
 --------
 - Can create or delete AWS AutoScaling Groups.
-- Can be used with the :ref:`community.aws.ec2_lc <community.aws.ec2_lc_module>` module to manage Launch Configurations.
+- Can be used with the :ref:`community.aws.autoscaling_launch_config <community.aws.autoscaling_launch_config_module>` module to manage Launch Configurations.
+- Prior to release 5.0.0 this module was called ``community.aws.ec2_asg``. The usage did not change.
 
 
 
@@ -278,7 +279,7 @@ Parameters
                 <td>
                 </td>
                 <td>
-                        <div>Name of the Launch configuration to use for the group. See the community.aws.ec2_lc) module for managing these.</div>
+                        <div>Name of the Launch configuration to use for the group. See the community.aws.autoscaling_launch_config) module for managing these.</div>
                         <div>If unspecified then the current group value will be used.  One of <em>launch_config_name</em> or <em>launch_template</em> must be provided.</div>
                 </td>
             </tr>
@@ -1040,7 +1041,7 @@ Examples
 
     # Basic configuration with Launch Configuration
 
-    - community.aws.ec2_asg:
+    - community.aws.autoscaling_group:
         name: special
         load_balancers: [ 'lb1', 'lb2' ]
         availability_zones: [ 'eu-west-1a', 'eu-west-1b' ]
@@ -1066,7 +1067,7 @@ Examples
     # will have the current launch configuration.
 
     - name: create launch config
-      community.aws.ec2_lc:
+      community.aws.autoscaling_launch_config:
         name: my_new_lc
         image_id: ami-lkajsf
         key_name: mykey
@@ -1075,7 +1076,7 @@ Examples
         instance_type: m1.small
         assign_public_ip: yes
 
-    - community.aws.ec2_asg:
+    - community.aws.autoscaling_group:
         name: myasg
         launch_config_name: my_new_lc
         health_check_period: 60
@@ -1089,7 +1090,7 @@ Examples
     # To only replace a couple of instances instead of all of them, supply a list
     # to "replace_instances":
 
-    - community.aws.ec2_asg:
+    - community.aws.autoscaling_group:
         name: myasg
         launch_config_name: my_new_lc
         health_check_period: 60
@@ -1104,7 +1105,7 @@ Examples
 
     # Basic Configuration with Launch Template
 
-    - community.aws.ec2_asg:
+    - community.aws.autoscaling_group:
         name: special
         load_balancers: [ 'lb1', 'lb2' ]
         availability_zones: [ 'eu-west-1a', 'eu-west-1b' ]
@@ -1122,7 +1123,7 @@ Examples
 
     # Basic Configuration with Launch Template using mixed instance policy
 
-    - community.aws.ec2_asg:
+    - community.aws.autoscaling_group:
         name: special
         load_balancers: [ 'lb1', 'lb2' ]
         availability_zones: [ 'eu-west-1a', 'eu-west-1b' ]
@@ -1375,7 +1376,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                 </td>
                 <td>success</td>
                 <td>
-                            <div>Name of launch configuration associated with the ASG. Same as launch_configuration_name, provided for compatibility with ec2_asg module.</div>
+                            <div>Name of launch configuration associated with the ASG. Same as launch_configuration_name, provided for compatibility with <span class='module'>community.aws.autoscaling_group</span> module.</div>
                     <br/>
                         <div style="font-size: smaller"><b>Sample:</b></div>
                         <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">public-webapp-production-1</div>

diff --git a/....ec2_asg_instance_refresh_info_module.rst → ...oscaling_instance_refresh_info_module.rst b/....ec2_asg_instance_refresh_info_module.rst → ...oscaling_instance_refresh_info_module.rst
@@ -1,11 +1,11 @@
-.. _community.aws.ec2_asg_instance_refresh_info_module:
+.. _community.aws.autoscaling_instance_refresh_info_module:
 
 
-*******************************************
-community.aws.ec2_asg_instance_refresh_info
-*******************************************
+***********************************************
+community.aws.autoscaling_instance_refresh_info
+***********************************************
 
-**Gather information about ec2 Auto Scaling Group (ASG) Instance Refreshes in AWS**
+**Gather information about EC2 Auto Scaling Group (ASG) Instance Refreshes in AWS**
 
 
 Version added: 3.2.0
@@ -19,6 +19,7 @@ Synopsis
 --------
 - Describes one or more instance refreshes.
 - You can determine the status of a request by looking at the *status* parameter.
+- Prior to release 5.0.0 this module was called ``community.aws.ec2_asg_instance_refresh_info``. The usage did not change.
 
 
 
@@ -297,23 +298,23 @@ Examples
     # Note: These examples do not set authentication details, see the AWS Guide for details.
 
     - name: Find an refresh by ASG name
-      community.aws.ec2_asg_instance_refresh_info:
+      community.aws.autoscaling_instance_refresh_info:
         name: somename-asg
 
     - name: Find an refresh by ASG name and one or more refresh-IDs
-      community.aws.ec2_asg_instance_refresh_info:
+      community.aws.autoscaling_instance_refresh_info:
         name: somename-asg
         ids: ['some-id-123']
       register: asgs
 
     - name: Find an refresh by ASG name and set max_records
-      community.aws.ec2_asg_instance_refresh_info:
+      community.aws.autoscaling_instance_refresh_info:
         name: somename-asg
         max_records: 4
       register: asgs
 
     - name: Find an refresh by ASG name and NextToken, if received from a previous call
-      community.aws.ec2_asg_instance_refresh_info:
+      community.aws.autoscaling_instance_refresh_info:
         name: somename-asg
         next_token: 'some-token-123'
       register: asgs
@@ -447,15 +448,12 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                 <td>
                             <div>The current state of the group when DeleteAutoScalingGroup is in progress.</div>
                             <div>The following are the possible statuses</div>
-                            <div>Pending --  The request was created, but the operation has not started.</div>
-                            <div>InProgress --  The operation is in progress.</div>
-                            <div>Successful --  The operation completed successfully.</div>
-                            <div>Failed --  The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.</div>
-                            <div>Cancelling --</div>
-                            <div>An ongoing operation is being cancelled.</div>
-                            <div>Cancellation does not roll back any replacements that have already been completed,</div>
-                            <div>but it prevents new replacements from being started.</div>
-                            <div>Cancelled --  The operation is cancelled.</div>
+                            <div><code>Pending</code>: The request was created, but the operation has not started.</div>
+                            <div><code>InProgress</code>: The operation is in progress.</div>
+                            <div><code>Successful</code>: The operation completed successfully.</div>
+                            <div><code>Failed</code>: The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.</div>
+                            <div><code>Cancelling</code>: An ongoing operation is being cancelled.  Cancellation does not roll back any replacements that have already been completed, but it prevents new replacements from being started.</div>
+                            <div><code>Cancelled</code>: The operation is cancelled.</div>
                     <br/>
                         <div style="font-size: smaller"><b>Sample:</b></div>
                         <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">Pending</div>