Note
This plugin is part of the community.aws collection (version 1.5.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.
To use it in a playbook, specify: community.aws.ec2_asg_info.
New in version 1.0.0: of community.aws
ec2_asg_facts before Ansible 2.9. The usage did not change.The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| aws_access_key string | AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. 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. aliases: ec2_access_key, access_key | |
| aws_ca_bundle path | The location of a CA Bundle to use when validating SSL certificates. Only used for boto3 based modules. Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally. | |
| aws_config dictionary | 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. | |
| aws_secret_key string | AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. 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. aliases: ec2_secret_key, secret_key | |
| 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. |
| ec2_url string | 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. aliases: aws_endpoint_url, endpoint_url | |
| name string | 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. | |
| profile string | Uses a boto profile. Only works with boto >= 2.24.0. 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. aliases: aws_profile | |
| region string | 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
aliases: aws_region, ec2_region | |
| security_token string | AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. 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_security_token, access_token | |
| tags dictionary | 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. | |
| validate_certs boolean |
| When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0. |
Note
AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE
AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file# 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 }}"
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| auto_scaling_group_arn string | success | The Amazon Resource Name of the ASG Sample: arn:aws:autoscaling:us-west-2:1234567890:autoScalingGroup:10787c52-0bcb-427d-82ba-c8e4b008ed2e:autoScalingGroupName/public-webapp-production-1 |
| auto_scaling_group_name string | success | Name of autoscaling group Sample: public-webapp-production-1 |
| availability_zones list / elements=string | success | List of Availability Zones that are enabled for this ASG. Sample: ['us-west-2a', 'us-west-2b', 'us-west-2a'] |
| created_time string | success | The date and time this ASG was created, in ISO 8601 format. Sample: 2015-11-25T00:05:36.309Z |
| default_cooldown integer | success | The default cooldown time in seconds. Sample: 300 |
| desired_capacity integer | success | The number of EC2 instances that should be running in this group. Sample: 3 |
| health_check_period integer | success | Length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking its health. Sample: 30 |
| health_check_type string | success | The service you want the health status from, one of "EC2" or "ELB". Sample: ELB |
| instances list / elements=string | success | List of EC2 instances and their status as it relates to the ASG. Sample: [{'availability_zone': 'us-west-2a', 'health_status': 'Healthy', 'instance_id': 'i-es22ad25', 'launch_configuration_name': 'public-webapp-production-1', 'lifecycle_state': 'InService', 'protected_from_scale_in': 'false'}] |
| launch_config_name string | success | Name of launch configuration associated with the ASG. Same as launch_configuration_name, provided for compatibility with ec2_asg module. Sample: public-webapp-production-1 |
| launch_configuration_name string | success | Name of launch configuration associated with the ASG. Sample: public-webapp-production-1 |
| lifecycle_hooks list / elements=string | success | List of lifecycle hooks for the ASG. Sample: [{'AutoScalingGroupName': 'public-webapp-production-1', 'DefaultResult': 'ABANDON', 'GlobalTimeout': 172800, 'HeartbeatTimeout': 3600, 'LifecycleHookName': 'instance-launch', 'LifecycleTransition': 'autoscaling:EC2_INSTANCE_LAUNCHING'}, {'AutoScalingGroupName': 'public-webapp-production-1', 'DefaultResult': 'ABANDON', 'GlobalTimeout': 172800, 'HeartbeatTimeout': 3600, 'LifecycleHookName': 'instance-terminate', 'LifecycleTransition': 'autoscaling:EC2_INSTANCE_TERMINATING'}] |
| load_balancer_names list / elements=string | success | List of load balancers names attached to the ASG. Sample: ['elb-webapp-prod'] |
| max_size integer | success | Maximum size of group Sample: 3 |
| min_size integer | success | Minimum size of group Sample: 1 |
| new_instances_protected_from_scale_in boolean | success | Whether or not new instances a protected from automatic scaling in. Sample: false |
| placement_group string | success | Placement group into which instances are launched, if any. Sample: None |
| status string | success | The current state of the group when DeleteAutoScalingGroup is in progress. Sample: None |
| tags list / elements=string | success | List of tags for the ASG, and whether or not each tag propagates to instances at launch. Sample: [{'key': 'Name', 'propagate_at_launch': 'true', 'resource_id': 'public-webapp-production-1', 'resource_type': 'auto-scaling-group', 'value': 'public-webapp-production-1'}, {'key': 'env', 'propagate_at_launch': 'true', 'resource_id': 'public-webapp-production-1', 'resource_type': 'auto-scaling-group', 'value': 'production'}] |
| target_group_arns list / elements=string | success | List of ARNs of the target groups that the ASG populates Sample: ['arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:targetgroup/target-group-host-hello/1a2b3c4d5e6f1a2b', 'arn:aws:elasticloadbalancing:ap-southeast-2:123456789012:targetgroup/target-group-path-world/abcd1234abcd1234'] |
| target_group_names list / elements=string | success | List of names of the target groups that the ASG populates Sample: ['target-group-host-hello', 'target-group-path-world'] |
| termination_policies string | success | A list of termination policies for the group. Sample: ['Default'] |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/ec2_asg_info_module.html