community.aws.ec2_asg module – Create or delete AWS AutoScaling Groups (ASGs)
Note
This module is part of the community.aws collection (version 2.6.1).
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.
New in version 1.0.0: of community.aws
Synopsis
Can create or delete AWS AutoScaling Groups.
Can be used with the community.aws.ec2_lc module to manage Launch Configurations.
Requirements
The below requirements are needed on the host that executes this module.
python >= 3.6
boto3 >= 1.15.0
botocore >= 1.18.0
Parameters
Parameter |
Comments |
|---|---|
List of availability zone names in which to create the group. Defaults to all the availability zones in the region if vpc_zone_identifier is not set. |
|
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:
|
|
The number of seconds after a scaling activity completes before another can begin. Default: 300 |
|
Desired number of instances in group, if unspecified then the current group value will be used. |
|
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. |
|
Length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking its health. Default: 300 |
|
The service you want the health status from, Amazon EC2 or Elastic Load Balancer. Choices:
|
|
Name of the Launch configuration to use for the group. See the community.aws.ec2_lc) module for managing these. If unspecified then the current group value will be used. One of launch_config_name or launch_template must be provided. |
|
Dictionary describing the Launch Template to use |
|
The id of the launch template. Only one of launch_template_name or launch_template_id is required. |
|
The name of the launch template. Only one of launch_template_name or launch_template_id is required. |
|
The version number of the launch template to use. Defaults to latest version if not provided. |
|
Check to make sure instances that are being replaced with replace_instances do not already have the current launch_config. Choices:
|
|
List of ELB names to use for the group. Use for classic load balancers. |
|
Check to make sure instances that are being replaced with replace_instances do not already have the current launch_template or I(launch_template version. Choices:
|
|
The maximum amount of time, in seconds, that an instance can be in service. Maximum instance lifetime must be equal to 0, between 604800 and 31536000 seconds (inclusive), or not specified. Value of 0 removes lifetime restriction. |
|
Maximum number of instances in group, if unspecified then the current group value will be used. |
|
Enable ASG metrics collection. Choices:
|
|
When metrics_collection=true this will determine the granularity of metrics collected by CloudWatch. Default: “1Minute” |
|
List of autoscaling metrics to collect when metrics_collection=true. Default: [“GroupMinSize”, “GroupMaxSize”, “GroupDesiredCapacity”, “GroupInServiceInstances”, “GroupPendingInstances”, “GroupStandbyInstances”, “GroupTerminatingInstances”, “GroupTotalInstances”] |
|
Minimum number of instances in group, if unspecified then the current group value will be used. |
|
A mixed instance policy to use for the ASG. Only used when the ASG is configured to use a Launch Template (launch_template). |
|
A list of instance_types. |
|
Specifies the distribution of On-Demand Instances and Spot Instances, the maximum price to pay for Spot Instances, and how the Auto Scaling group allocates instance types to fulfill On-Demand and Spot capacity. See also https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_InstancesDistribution.html |
|
Indicates how to allocate instance types to fulfill On-Demand capacity. |
|
The minimum amount of the Auto Scaling group’s capacity that must be fulfilled by On-Demand Instances. This base portion is provisioned first as your group scales. Default if not set is 0. If you leave it set to 0, On-Demand Instances are launched as a percentage of the Auto Scaling group’s desired capacity, per the OnDemandPercentageAboveBaseCapacity setting. |
|
Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity. Default if not set is 100. If you leave it set to 100, the percentages are 100% for On-Demand Instances and 0% for Spot Instances. Valid range: 0 to 100 |
|
Indicates how to allocate instances across Spot Instance pools. |
|
The number of Spot Instance pools across which to allocate your Spot Instances. The Spot pools are determined from the different instance types in the Overrides array of LaunchTemplate. Default if not set is 2. Used only when the Spot allocation strategy is lowest-price. Valid Range: Minimum value of 1. Maximum value of 20. |
|
The maximum price per unit hour that you are willing to pay for a Spot Instance. If you leave the value of this parameter blank (which is the default), the maximum Spot price is set at the On-Demand price. To remove a value that you previously set, include the parameter but leave the value blank. |
|
Unique name for group to be created or deleted. |
|
A SNS topic ARN to send auto scaling notifications to. |
|
A list of auto scaling events to trigger notifications on. Default: [“autoscaling:EC2_INSTANCE_LAUNCH”, “autoscaling:EC2_INSTANCE_LAUNCH_ERROR”, “autoscaling:EC2_INSTANCE_TERMINATE”, “autoscaling:EC2_INSTANCE_TERMINATE_ERROR”] |
|
Physical location of your cluster placement group created in Amazon EC2. |
|
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 |
|
In a rolling fashion, replace all instances that used the old launch configuration with one from the new launch configuration. It increases the ASG size by replace_batch_size, waits for the new instances to be up and running. After that, it terminates a batch of old instances, waits for the replacements, and repeats, until all old instances are replaced. Once that’s done the ASG size is reduced back to the expected size. Choices:
|
|
Number of instances you’d like to replace at a time. Used with replace_all_instances. Default: 1 |
|
List of instance_ids belonging to the named AutoScalingGroup that you would like to terminate and be replaced with instances matching the current launch configuration. |
|
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. |
|
Register or deregister the instance. Choices:
|
|
A list of scaling processes to suspend. Valid values include:
Full documentation of valid values can be found in the AWS documentation: https://docs.aws.amazon.com/autoscaling/ec2/userguide/as-suspend-resume-processes.html Default: [] |
|
A list of tags to add to the Auto Scale Group. Optional key is propagate_at_launch, which defaults to true. When propagate_at_launch is true the tags will be propagated to the Instances created. |
|
List of target group ARNs to use for the group. Use for application load balancers. |
|
An ordered list of criteria used for selecting instances to be removed from the Auto Scaling group when reducing capacity. Using termination_policies=Default when modifying an existing AutoScalingGroup will result in the existing policy being retained instead of changed to Valid values include: Full documentation of valid values can be found in the AWS documentation: Default: “Default” |
|
When set to “no”, SSL certificates will not be validated for communication with the AWS APIs. Choices:
|
|
List of VPC subnets to use |
|
Wait for the ASG instances to be in a ready state before exiting. If instances are behind an ELB, it will wait until the ELB determines all instances have a lifecycle_state of “InService” and a health_status of “Healthy”. Choices:
|
|
How long to wait for instances to become viable when replaced. If you experience the error “Waited too long for ELB instances to be healthy”, try increasing this value. Default: 300 |
Notes
Note
If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence
AWS_URLorEC2_URL,AWS_PROFILEorAWS_DEFAULT_PROFILE,AWS_ACCESS_KEY_IDorAWS_ACCESS_KEYorEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYorAWS_SECRET_KEYorEC2_SECRET_KEY,AWS_SECURITY_TOKENorEC2_SECURITY_TOKEN,AWS_REGIONorEC2_REGION,AWS_CA_BUNDLEWhen 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_REGIONorEC2_REGIONcan be typically be used to specify the AWS region, when required, but this can also be defined in the configuration files.
Examples
# Basic configuration with Launch Configuration
- community.aws.ec2_asg:
name: special
load_balancers: [ 'lb1', 'lb2' ]
availability_zones: [ 'eu-west-1a', 'eu-west-1b' ]
launch_config_name: 'lc-1'
min_size: 1
max_size: 10
desired_capacity: 5
vpc_zone_identifier: [ 'subnet-abcd1234', 'subnet-1a2b3c4d' ]
tags:
- environment: production
propagate_at_launch: no
# Rolling ASG Updates
# Below is an example of how to assign a new launch config to an ASG and terminate old instances.
#
# All instances in "myasg" that do not have the launch configuration named "my_new_lc" will be terminated in
# a rolling fashion with instances using the current launch configuration, "my_new_lc".
#
# This could also be considered a rolling deploy of a pre-baked AMI.
#
# If this is a newly created group, the instances will not be replaced since all instances
# will have the current launch configuration.
- name: create launch config
community.aws.ec2_lc:
name: my_new_lc
image_id: ami-lkajsf
key_name: mykey
region: us-east-1
security_groups: sg-23423
instance_type: m1.small
assign_public_ip: yes
- community.aws.ec2_asg:
name: myasg
launch_config_name: my_new_lc
health_check_period: 60
health_check_type: ELB
replace_all_instances: yes
min_size: 5
max_size: 5
desired_capacity: 5
region: us-east-1
# To only replace a couple of instances instead of all of them, supply a list
# to "replace_instances":
- community.aws.ec2_asg:
name: myasg
launch_config_name: my_new_lc
health_check_period: 60
health_check_type: ELB
replace_instances:
- i-b345231
- i-24c2931
min_size: 5
max_size: 5
desired_capacity: 5
region: us-east-1
# Basic Configuration with Launch Template
- community.aws.ec2_asg:
name: special
load_balancers: [ 'lb1', 'lb2' ]
availability_zones: [ 'eu-west-1a', 'eu-west-1b' ]
launch_template:
version: '1'
launch_template_name: 'lt-example'
launch_template_id: 'lt-123456'
min_size: 1
max_size: 10
desired_capacity: 5
vpc_zone_identifier: [ 'subnet-abcd1234', 'subnet-1a2b3c4d' ]
tags:
- environment: production
propagate_at_launch: no
# Basic Configuration with Launch Template using mixed instance policy
- community.aws.ec2_asg:
name: special
load_balancers: [ 'lb1', 'lb2' ]
availability_zones: [ 'eu-west-1a', 'eu-west-1b' ]
launch_template:
version: '1'
launch_template_name: 'lt-example'
launch_template_id: 'lt-123456'
mixed_instances_policy:
instance_types:
- t3a.large
- t3.large
- t2.large
instances_distribution:
on_demand_percentage_above_base_capacity: 0
spot_allocation_strategy: capacity-optimized
min_size: 1
max_size: 10
desired_capacity: 5
vpc_zone_identifier: [ 'subnet-abcd1234', 'subnet-1a2b3c4d' ]
tags:
- environment: production
propagate_at_launch: no
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The unique ARN of the autoscaling group Returned: success Sample: “arn:aws:autoscaling:us-east-1:123456789012:autoScalingGroup:6a09ad6d-eeee-1234-b987-ee123ced01ad:autoScalingGroupName/myasg” |
|
The unique name of the auto scaling group Returned: success Sample: “myasg” |
|
The availability zones for the auto scaling group Returned: success Sample: [“us-east-1d”] |
|
Timestamp of create time of the auto scaling group Returned: success Sample: “2017-11-08T14:41:48.272000+00:00” |
|
The default cooldown time in seconds. Returned: success Sample: 300 |
|
The number of EC2 instances that should be running in this group. Returned: success Sample: 3 |
|
Length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking its health. Returned: success Sample: 30 |
|
The service you want the health status from, one of “EC2” or “ELB”. Returned: success Sample: “ELB” |
|
Number of instances in a healthy state Returned: success Sample: 5 |
|
Number of instances in service Returned: success Sample: 3 |
|
Dictionary of EC2 instances and their status as it relates to the ASG. Returned: success Sample: {“i-0123456789012”: {“health_status”: “Healthy”, “launch_config_name”: “public-webapp-production-1”, “lifecycle_state”: “InService”}} |
|
list of instance IDs in the ASG Returned: success Sample: [“i-0123456789012”] |
|
Name of launch configuration associated with the ASG. Same as launch_configuration_name, provided for compatibility with ec2_asg module. Returned: success Sample: “public-webapp-production-1” |
|
List of load balancers names attached to the ASG. Returned: success Sample: [“elb-webapp-prod”] |
|
The maximum amount of time, in seconds, that an instance can be in service. Returned: success Sample: 604800 |
|
Maximum size of group Returned: success Sample: 3 |
|
List of enabled AutosSalingGroup metrics Returned: success Sample: [{“Granularity”: “1Minute”, “Metric”: “GroupInServiceInstances”}] |
|
Minimum size of group Returned: success Sample: 1 |
|
Returns the list of instance types if a mixed instances policy is set. Returned: success Sample: [“t3.micro”, “t3a.micro”] |
|
Returns the full dictionary representation of the mixed instances policy if a mixed instances policy is set. Returned: success Sample: {“instances_distribution”: {“on_demand_allocation_strategy”: “prioritized”, “on_demand_base_capacity”: 0, “on_demand_percentage_above_base_capacity”: 0, “spot_allocation_strategy”: “capacity-optimized”}, “launch_template”: {“launch_template_specification”: {“launch_template_id”: “lt-53c2425cffa544c23”, “launch_template_name”: “random-LaunchTemplate”, “version”: “2”}, “overrides”: [{“instance_type”: “m5.xlarge”}, {“instance_type”: “m5a.xlarge”}]}} |
|
Number of instances in pending state Returned: success Sample: 1 |
|
List of tags for the ASG, and whether or not each tag propagates to instances at launch. Returned: success 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”}] |
|
List of ARNs of the target groups that the ASG populates Returned: success 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”] |
|
List of names of the target groups that the ASG populates Returned: success Sample: [“target-group-host-hello”, “target-group-path-world”] |
|
A list of termination policies for the group. Returned: success Sample: [“Default”] |
|
Number of instances in an unhealthy state Returned: success Sample: 0 |
|
Number of instances in a viable state Returned: success Sample: 1 |
|
VPC zone ID / subnet id for the auto scaling group Returned: success Sample: “subnet-a31ef45f” |
Authors
Gareth Rushgrove (@garethr)