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 5.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.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.6

  • boto3 >= 1.18.0

  • botocore >= 1.21.0

Parameters

Parameter

Comments

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

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 AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference.

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 EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

The AWS_CA_BUNDLE environment variable may also be used.

aws_config

dictionary

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.

debug_botocore_endpoint_logs

boolean

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.

Choices:

  • false ← (default)

  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

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 AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

name

string / required

The name of the auto scaling group you are searching for.

preferences

dictionary

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 90.

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’.

instance_warmup

integer

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.

min_healthy_percentage

integer

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: 90

profile

aliases: aws_profile

string

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 AWS_PROFILE environment variable may also be used.

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

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 AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference.

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 EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

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 AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference.

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 EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

state

string / required

Desired state of the ASG.

Choices:

  • "started"

  • "cancelled"

strategy

string

The strategy to use for the instance refresh. The only valid value is 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.

Default: "Rolling"

validate_certs

boolean

When set to false, SSL certificates will not be validated for communication with the AWS APIs.

Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

Choices:

  • false

  • true ← (default)

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

auto_scaling_group_name

string

Name of autoscaling group

Returned: success

Sample: "public-webapp-production-1"

end_time

string

The date and time this ASG was created, in ISO 8601 format.

Returned: success

Sample: "2015-11-25T00:05:36.309Z"

instance_refresh_id

string

instance refresh id

Returned: success

Sample: "08b91cf7-8fa6-48af-b6a6-d227f40f1b9b"

instances_to_update

integer

num. of instance to update

Returned: success

Sample: 5

percentage_complete

integer

the % of completeness

Returned: success

Sample: 100

start_time

string

The date and time this ASG was created, in ISO 8601 format.

Returned: success

Sample: "2015-11-25T00:05:36.309Z"

status

string

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"

Authors

  • Dan Khersonsky (@danquixote)