community / community.aws / 5.1.0 / module / autoscaling_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.autoscaling_instance_refresh (5.1.0) — module
Install with ansible-galaxy collection install community.aws:==5.1.0
collections: - name: community.aws version: 5.1.0
Start or cancel an EC2 Auto Scaling Group instance refresh in AWS.
Can be used with M(community.aws.autoscaling_instance_refresh_info) to track the subsequent progress.
Prior to release 5.0.0 this module was called C(community.aws.ec2_asg_instance_refresh). The usage did not change.
# Note: These examples do not set authentication details, see the AWS Guide for details. - name: Start a refresh community.aws.autoscaling_instance_refresh: name: some-asg state: started
- name: Cancel a refresh community.aws.autoscaling_instance_refresh: name: some-asg state: cancelled
- name: Start a refresh and pass preferences community.aws.autoscaling_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. - For global services such as IAM, Route53 and CloudFront, I(region) is ignored. - The C(AWS_REGION) or C(EC2_REGION) environment variables may also be used. - See the Amazon AWS documentation for more information U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region). - The C(ec2_region) alias has been deprecated and will be removed in a release after 2024-12-01 - Support for the C(EC2_REGION) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str profile: aliases: - aws_profile description: - A named AWS profile to use for authentication. - See the AWS documentation for more information about named profiles U(https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html). - The C(AWS_PROFILE) environment variable may also be used. - The I(profile) option is mutually exclusive with the I(aws_access_key), I(aws_secret_key) and I(security_token) options. 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 access_key: aliases: - aws_access_key_id - aws_access_key - ec2_access_key description: - AWS access key ID. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variables may also be used in decreasing order of preference. - The I(aws_access_key) and I(profile) options are mutually exclusive. - The I(aws_access_key_id) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_access_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_ACCESS_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found in the AWS documentation U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config). type: dict secret_key: aliases: - aws_secret_access_key - aws_secret_key - ec2_secret_key description: - AWS secret access key. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variables may also be used in decreasing order of preference. - The I(secret_key) and I(profile) options are mutually exclusive. - The I(aws_secret_access_key) alias was added in release 5.1.0 for consistency with the AWS botocore SDK. - The I(ec2_secret_key) alias has been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str 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 endpoint_url: aliases: - ec2_url - aws_endpoint_url - s3_url description: - URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS. - The C(AWS_URL) or C(EC2_URL) environment variables may also be used, in decreasing order of preference. - The I(ec2_url) and I(s3_url) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_URL) environment variable has been deprecated and will be removed in a release after 2024-12-01. type: str aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - The C(AWS_CA_BUNDLE) environment variable may also be used. type: path session_token: aliases: - aws_session_token - security_token - aws_security_token - access_token description: - AWS STS session token for use with temporary credentials. - See the AWS documentation for more information about access tokens U(https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys). - The C(AWS_SESSION_TOKEN), C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variables may also be used in decreasing order of preference. - The I(security_token) and I(profile) options are mutually exclusive. - Aliases I(aws_session_token) and I(session_token) were added in release 3.2.0, with the parameter being renamed from I(security_token) to I(session_token) in release 6.0.0. - The I(security_token), I(aws_security_token), and I(access_token) aliases have been deprecated and will be removed in a release after 2024-12-01. - Support for the C(EC2_SECRET_KEY) and C(AWS_SECURITY_TOKEN) environment variables has been deprecated and will be removed in a release after 2024-12-01. type: str validate_certs: default: true description: - When set to C(false), SSL certificates will not be validated for communication with the AWS APIs. - Setting I(validate_certs=false) is strongly discouraged, as an alternative, consider setting I(aws_ca_bundle) instead. type: bool debug_botocore_endpoint_logs: default: false description: - Use a C(botocore.endpoint) logger to parse the unique (rather than total) C("resource:action") API calls made during a task, outputing the set to the resource_actions key in the task results. Use the C(aws_resource_action) callback to output to total list made during a playbook. - The C(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