Skip to content

Commit

Permalink
Fixup documentation for ec2_asg_instance_refresh.py and ec2_asg_insta…
Browse files Browse the repository at this point in the history
…nce_refreshes_info.py
  • Loading branch information
danquixote committed May 25, 2021
1 parent 7585682 commit 1cacca4
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 15 deletions.
7 changes: 4 additions & 3 deletions plugins/modules/ec2_asg_instance_refresh.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@
---
module: ec2_asg_instance_refresh
version_added: 1.0.0
short_description: Start or cancel an ec2 Auto Scaling Group (ASG) Instance Refresh in AWS
short_description: Start or cancel an EC2 Auto Scaling Group (ASG) instance refresh in AWS
description:
- Start or cancel an ec2 Auto Scaling Group Instance Refresh in AWS
- Start or cancel an EC2 Auto Scaling Group instance refresh in AWS.
- Can be used with ec2_asg_instance_refreshes_info to track the subsequent progress
requirements: [ boto3 ]
author: "Dan Khersonsky (@danquixote)"
Expand All @@ -39,7 +39,8 @@
preferences:
description:
- Set of preferences associated with the instance refresh request.
- If not provided, the default values are used. For MinHealthyPercentage, the default value is 90.
- If not provided, the default values are used.
- For I(min_healthy_percentage), the default value is C(90).
- For InstanceWarmup, the default is to use the value specified for the health check grace period for the Auto Scaling group.
required: false
suboptions:
Expand Down
26 changes: 14 additions & 12 deletions plugins/modules/ec2_asg_instance_refreshes_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,7 @@
short_description: Gather information about ec2 Auto Scaling Group (ASG) Instance Refreshes in AWS
description:
- Describes one or more instance refreshes.
- You can determine the status of a request by looking at the Status parameter. The following are the possible statuses
- Pending -- The request was created, but the operation has not started.
- InProgress -- The operation is in progress.
- Successful -- The operation completed successfully.
- Failed -- The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.
- Cancelling --
- 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.
- Cancelled -- The operation is cancelled.
- You can determine the status of a request by looking at the I(status) parameter.
requirements: [ boto3 ]
author: "Dan Khersonsky (@danquixote)"
options:
Expand Down Expand Up @@ -93,10 +84,21 @@
type: str
sample: "public-webapp-production-1"
status:
description: The current state of the group when DeleteAutoScalingGroup is in progress.
description:
- The current state of the group when DeleteAutoScalingGroup is in progress.
- The following are the possible statuses
- Pending -- The request was created, but the operation has not started.
- InProgress -- The operation is in progress.
- Successful -- The operation completed successfully.
- Failed -- The operation failed to complete. You can troubleshoot using the status reason and the scaling activities.
- Cancelling --
- 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.
- Cancelled -- The operation is cancelled.
returned: success
type: str
sample: None
sample: "Pending"
start_time:
description: The date and time this ASG was created, in ISO 8601 format.
returned: success
Expand Down

0 comments on commit 1cacca4

Please sign in to comment.