amazon.aws.autoscaling_group_info module – Gather information about EC2 Auto Scaling Groups (ASGs) in AWS
Note
This module is part of the amazon.aws collection (version 9.0.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 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_group_info.
New in amazon.aws 5.0.0
Synopsis
Gather information about EC2 Auto Scaling Groups (ASGs) in AWS.
Prior to release 5.0.0 this module was called community.aws.ec2_asg_info. The usage did not change.
This module was originally added to
community.awsin release 1.0.0.
Aliases: ec2_asg_info
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 |
|---|---|
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 prefix or name of the auto scaling group(s) you are searching for. Note: This is a regular expression match with implicit ‘^’ (beginning of string). Append ‘$’ for a complete name match. |
|
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 |
|
A dictionary/hash of tags in the format { tag1_name: ‘tag1_value’, tag2_name: ‘tag2_value’ } to match against the auto scaling group(s) you are searching for. |
|
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: Find all groups
amazon.aws.autoscaling_group_info:
register: asgs
- name: Find a group with matching name/prefix
amazon.aws.autoscaling_group_info:
name: public-webserver-asg
register: asgs
- name: Find a group with matching tags
amazon.aws.autoscaling_group_info:
tags:
project: webapp
env: production
register: asgs
- name: Find a group with matching name/prefix and tags
amazon.aws.autoscaling_group_info:
name: myproject
tags:
env: production
register: asgs
- name: Fail if no groups are found
amazon.aws.autoscaling_group_info:
name: public-webserver-asg
register: asgs
failed_when: "{{ asgs.results | length == 0 }}"
- name: Fail if more than 1 group is found
amazon.aws.autoscaling_group_info:
name: public-webserver-asg
register: asgs
failed_when: "{{ asgs.results | length > 1 }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A list of Auto Scaling Groups. Returned: always |
|
The Amazon Resource Name of the ASG. Returned: success Sample: |
|
Name of autoscaling group. Returned: success Sample: |
|
List of Availability Zones that are enabled for this ASG. Returned: success Sample: |
|
The date and time this ASG was created, in ISO 8601 format. Returned: success Sample: |
|
The default cooldown time in seconds. Returned: success Sample: |
|
The number of EC2 instances that should be running in this group. Returned: success Sample: |
|
The metrics enabled for the group. Returned: success Sample: |
|
The granularity of the metric. The only valid value is 1Minute. Returned: success Sample: |
|
Name of the metric. Returned: success Sample: |
|
Length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking its health. Returned: success Sample: |
|
The service you want the health status from, one of “EC2” or “ELB”. Returned: success Sample: |
|
List of EC2 instances associated with ASG and their status. Returned: success Sample: |
|
The Availability Zone of the instance. Returned: success Sample: |
|
The last reported health status of the instance. Returned: success Sample: |
|
The ID of the instance. Returned: success Sample: |
|
The instance type size of the running instance. Returned: success Sample: |
|
The EC2 launch template to base instance configuration on. Returned: success |
|
The ID of the launch template. Returned: success |
|
The name of the launch template. Returned: success |
|
The specific version of the launch template to use. Returned: success |
|
A description of the current lifecycle state. Returned: success |
|
Indicates whether the instance is protected from termination by Amazon EC2 Auto Scaling when scaling in. Returned: success |
|
Name of launch configuration associated with the ASG. Same as launch_configuration_name, provided for compatibility with amazon.aws.autoscaling_group module. Returned: success Sample: |
|
Name of launch configuration associated with the ASG. Returned: success Sample: |
|
List of lifecycle hooks for the ASG. Returned: success Sample: |
|
List of load balancers names attached to the ASG. Returned: success Sample: |
|
Maximum size of group. Returned: success Sample: |
|
Minimum size of group. Returned: success Sample: |
|
Whether or not new instances a protected from automatic scaling in. Returned: success Sample: |
|
Placement group into which instances are launched, if any. Returned: success Sample: |
|
The ARN of the service-linked role that the Auto Scaling group uses to call other Amazon Web Services on your behalf. Returned: success Sample: |
|
The current state of the group when DeleteAutoScalingGroup is in progress. Returned: success Sample: |
|
The suspended processes associated with the group. Returned: success Sample: |
|
The name of the suspended process. Returned: success |
|
The reason that the process was suspended. Returned: success |
|
List of tags for the ASG, and whether or not each tag propagates to instances at launch. Returned: success Sample: |
|
List of ARNs of the target groups that the ASG populates. Returned: success Sample: |
|
List of names of the target groups that the ASG populates. Returned: success Sample: |
|
A list of termination policies for the group. Returned: success Sample: |
|
The traffic sources associated with this Auto Scaling group. Returned: success Sample: |
|
Identifies the traffic source. Returned: success |
|
Provides additional context for the value of Identifier. Returned: success |
|
One or more subnet IDs, if applicable, separated by commas. Returned: success Sample: |