community / community.aws / 3.4.0 / module / ec2_asg_instance_refresh Start or cancel an EC2 Auto Scaling Group (ASG) instance refresh in AWS | "added in version" 3.2.0 of community.aws" Authors: Dan Khersonsky (@danquixote)community.aws.ec2_asg_instance_refresh (3.4.0) — module
Install with ansible-galaxy collection install community.aws:==3.4.0
collections: - name: community.aws version: 3.4.0
Start or cancel an EC2 Auto Scaling Group instance refresh in AWS.
Can be used with M(community.aws.ec2_asg_instance_refresh_info) to track the subsequent progress.
# Note: These examples do not set authentication details, see the AWS Guide for details. - name: Start a refresh community.aws.ec2_asg_instance_refresh: name: some-asg state: started
- name: Cancel a refresh community.aws.ec2_asg_instance_refresh: name: some-asg state: cancelled
- name: Start a refresh and pass preferences community.aws.ec2_asg_instance_refresh: name: some-asg state: started preferences: min_healthy_percentage: 91 instance_warmup: 60
name: description: - The name of the auto scaling group you are searching for. required: true type: str state: choices: - started - cancelled description: - Desired state of the ASG. required: true type: str region: aliases: - aws_region - ec2_region description: - The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. type: str profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str strategy: default: Rolling description: - The strategy to use for the instance refresh. The only valid value is C(Rolling). - A rolling update is an update that is applied to all instances in an Auto Scaling group until all instances have been updated. - A rolling update can fail due to failed health checks or if instances are on standby or are protected from scale in. - If the rolling update process fails, any instances that were already replaced are not rolled back to their previous configuration. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). - Only the 'user_agent' key is used for boto modules. See U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict preferences: description: - Set of preferences associated with the instance refresh request. - If not provided, the default values are used. - For I(min_healthy_percentage), the default value is C(90). - For I(instance_warmup), the default is to use the value specified for the health check grace period for the Auto Scaling group. - Can not be specified when I(state) is set to 'cancelled'. required: false suboptions: instance_warmup: description: - The number of seconds until a newly launched instance is configured and ready to use. - During this time, Amazon EC2 Auto Scaling does not immediately move on to the next replacement. - The default is to use the value for the health check grace period defined for the group. type: int min_healthy_percentage: default: 90 description: - Total percent of capacity in ASG that must remain healthy during instance refresh to allow operation to continue. - It is rounded up to the nearest integer. type: int type: dict aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Not used by boto 2 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool debug_botocore_endpoint_logs: default: 'no' description: - Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used. type: bool
auto_scaling_group_name: description: Name of autoscaling group returned: success sample: public-webapp-production-1 type: str end_time: description: The date and time this ASG was created, in ISO 8601 format. returned: success sample: '2015-11-25T00:05:36.309Z' type: str instance_refresh_id: description: instance refresh id returned: success sample: 08b91cf7-8fa6-48af-b6a6-d227f40f1b9b type: str instances_to_update: description: num. of instance to update returned: success sample: 5 type: int percentage_complete: description: the % of completeness returned: success sample: 100 type: int start_time: description: The date and time this ASG was created, in ISO 8601 format. returned: success sample: '2015-11-25T00:05:36.309Z' type: str status: 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 sample: Pending type: str