community.aws.autoscaling_instance_refresh module – Start or cancel an EC2 Auto Scaling Group (ASG) instance refresh in AWS
Note
This module is part of the community.aws collection (version 7.2.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.aws.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.aws.autoscaling_instance_refresh.
New in community.aws 3.2.0
Synopsis
Start or cancel an EC2 Auto Scaling Group instance refresh in AWS.
Can be used with community.aws.autoscaling_instance_refresh_info to track the subsequent progress.
Prior to release 5.0.0 this module was called
community.aws.ec2_asg_instance_refresh. The usage did not change.
Aliases: ec2_asg_instance_refresh
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.26.0
botocore >= 1.29.0
Parameters
Parameter |
Comments |
|---|---|
AWS access key ID. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The aws_access_key and profile options are mutually exclusive. The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The location of a CA Bundle to use when validating SSL certificates. The |
|
A dictionary to modify the botocore configuration. Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. |
|
Use a The Choices:
|
|
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 The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
The name of the auto scaling group you are searching for. |
|
Set of preferences associated with the instance refresh request. If not provided, the default values are used. For min_healthy_percentage, the default value is For 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 state is set to ‘cancelled’. |
|
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. |
|
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. Default: |
|
A named AWS profile to use for authentication. See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. The The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options. |
|
The AWS region to use. For global services such as IAM, Route53 and CloudFront, region is ignored. The See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region. The Support for the |
|
AWS secret access key. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The secret_key and profile options are mutually exclusive. The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK. The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
AWS STS session token for use with temporary credentials. See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. The The security_token and profile options are mutually exclusive. Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0. The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01. Support for the |
|
Desired state of the ASG. Choices:
|
|
The strategy to use for the instance refresh. The only valid value is 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. Default: |
|
When set to Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead. Choices:
|
Notes
Note
Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.
The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically
~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.
Examples
# 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Name of autoscaling group Returned: success Sample: |
|
The date and time this ASG was created, in ISO 8601 format. Returned: success Sample: |
|
instance refresh id Returned: success Sample: |
|
num. of instance to update Returned: success Sample: |
|
the % of completeness Returned: success Sample: |
|
The date and time this ASG was created, in ISO 8601 format. Returned: success Sample: |
|
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: |