amazon.aws.autoscaling_instance module – manage instances associated with AWS AutoScaling Groups (ASGs)

Note

This module is part of the amazon.aws collection (version 10.0.0-dev0).

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 amazon.aws. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: amazon.aws.autoscaling_instance.

New in amazon.aws 9.0.0

Synopsis

  • Manage instances associated with AWS AutoScaling Groups (ASGs).

Requirements

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

  • python >= 3.6

  • boto3 >= 1.28.0

  • botocore >= 1.31.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

decrement_desired_capacity

boolean

When decrement_desired_capacity=True, detaching instances, terminating instances, or placing instances in standby mode will decrement the desired capacity of the AutoScaling Group

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.

group_name

string / required

Name of the AutoScaling Group to manage.

health

string

Sets the health of an instance to a specific state.

Choices:

  • "Healthy"

  • "Unhealthy"

instance_ids

list / elements=string

The IDs of the EC2 instances.

Required if state is one of standby, detached, terminated.

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.

protection

boolean

Sets the scale-in protection attribute.

Choices:

  • false

  • true

purge_instances

boolean

Ignored unless state=present or state=attached.

If purge_instances=True, any instances not in instance_ids will be scheduled for termination.

Note: Instances will be scheduled for termination after any new instances are added to the AutoScaling Group and, if wait=True and they will be terminated after the new instances have reached the expected state.

Choices:

  • false ← (default)

  • true

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.

respect_grace_period

boolean

Set respect_grace_period=False to ignore the grace period associated with the AutoScaling group when modifying the health.

Ignored unless health is set.

AWS defaults to respecting the grace period when modifying the health state of an instance.

Choices:

  • false

  • true ← (default)

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

The expected state of the instances.

present - The instance(s) should be attached to the AutoScaling Group and in service.

attached - The instance(s) should be attached to the AutoScaling Group. Instances in Standby will remain in standby.

standby - The instance(s) should be placed into standby. Instances must already be part of the AutoScaling Group.

detached - The instance(s) will be detached from the AutoScaling Group.

terminated - The instance(s) will be terminated. By default terminated instances will be replaced with new instances, to reduce the desired capacity at the same time as terminating instances set decrement_desired_capacity=True.

Note: When adding instances to an AutoScaling Group or returning instances to service from standby, the desired capacity is always incremented. If the total number of instances would exceed the maximum size of the group then the operation will fail.

Choices:

  • "present" ← (default)

  • "attached"

  • "terminated"

  • "detached"

  • "standby"

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)

wait

boolean

When wait=True will wait for instances to reach the requested state before returning.

Choices:

  • false

  • true ← (default)

wait_timeout

integer

Maximum time to wait for instances to reach the desired state.

Default: 120

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.

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

auto_scaling_instances

list / elements=string

A description of the EC2 instances attached to an Auto Scaling group.

Returned: always

availability_zone

string

The availability zone that the instance is in.

Returned: always

Sample: "us-east-1a"

health_status

string

The last reported health status of the instance.

Returned: always

Sample: "Healthy"

instance_id

string

The ID of the instance.

Returned: always

Sample: "i-123456789abcdef01"

instance_type

string

The instance type of the instance.

Returned: always

Sample: "t3.micro"

launch_configuration_name

string

The name of the launch configuration used when launching the instance.

Returned: When the instance was launched using an Auto Scaling launch configuration.

Sample: "ansible-test-49630214-mchappel-thinkpadt14gen3-asg-instance-1"

launch_template

dictionary

A description of the launch template used when launching the instance.

Returned: When the instance was launched using an Auto Scaling launch template.

launch_template_id

string

The ID of the launch template used when launching the instance.

Returned: always

Sample: "12345678-abcd-ef12-2345-6789abcdef01"

launch_template_name

string

The name of the launch template used when launching the instance.

Returned: always

Sample: "example-launch-configuration"

version

string

The version of the launch template used when launching the instance.

Returned: always

Sample: "$Default"

lifecycle_state

string

The lifecycle state of the instance.

Returned: always

Sample: "InService"

protected_from_scale_in

boolean

Whether the instance is protected from termination when the Auto Scaling group is scaled in.

Returned: always

Sample: false

Authors

  • Mark Chappell (@tremble)