community.aws.ec2_asg_info module – Gather information about ec2 Auto Scaling Groups (ASGs) in AWS
Note
This module is part of the community.aws collection (version 3.6.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.ec2_asg_info
.
New in community.aws 1.0.0
Synopsis
Gather information about ec2 Auto Scaling Groups (ASGs) in AWS
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.16.0
botocore >= 1.19.0
Parameters
Parameter |
Comments |
---|---|
If profile is set this parameter is ignored. Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. |
|
The location of a CA Bundle to use when validating SSL certificates. Not used by boto 2 based modules. Note: The CA Bundle is read ‘module’ side and may need to be explicitly copied from the controller if not run locally. |
|
A dictionary to modify the botocore configuration. Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config. Only the ‘user_agent’ key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration. |
|
If profile is set this parameter is ignored. Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. |
|
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:
|
|
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used. |
|
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. |
|
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated. aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01. |
|
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region |
|
If profile is set this parameter is ignored. Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. Aliases aws_session_token and session_token have been added in version 3.2.0. |
|
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 “no”, SSL certificates will not be validated for communication with the AWS APIs. Choices:
|
Notes
Note
If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URL
orEC2_URL
,AWS_PROFILE
orAWS_DEFAULT_PROFILE
,AWS_ACCESS_KEY_ID
orAWS_ACCESS_KEY
orEC2_ACCESS_KEY
,AWS_SECRET_ACCESS_KEY
orAWS_SECRET_KEY
orEC2_SECRET_KEY
,AWS_SECURITY_TOKEN
orEC2_SECURITY_TOKEN
,AWS_REGION
orEC2_REGION
,AWS_CA_BUNDLE
When no credentials are explicitly provided the AWS SDK (boto3) that Ansible uses will fall back to its configuration files (typically
~/.aws/credentials
). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.Modules based on the original AWS SDK (boto) may read their default configuration from different files. See https://boto.readthedocs.io/en/latest/boto_config_tut.html for more information.
AWS_REGION
orEC2_REGION
can be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
Examples
# Note: These examples do not set authentication details, see the AWS Guide for details.
- name: Find all groups
community.aws.ec2_asg_info:
register: asgs
- name: Find a group with matching name/prefix
community.aws.ec2_asg_info:
name: public-webserver-asg
register: asgs
- name: Find a group with matching tags
community.aws.ec2_asg_info:
tags:
project: webapp
env: production
register: asgs
- name: Find a group with matching name/prefix and tags
community.aws.ec2_asg_info:
name: myproject
tags:
env: production
register: asgs
- name: Fail if no groups are found
community.aws.ec2_asg_info:
name: public-webserver-asg
register: asgs
failed_when: "{{ asgs.results | length == 0 }}"
- name: Fail if more than 1 group is found
community.aws.ec2_asg_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 |
---|---|
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: |
|
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 and their status as it relates to the ASG. Returned: success Sample: |
|
Name of launch configuration associated with the ASG. Same as launch_configuration_name, provided for compatibility with ec2_asg 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 current state of the group when DeleteAutoScalingGroup is in progress. Returned: success Sample: |
|
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: |