Parameter |
Choices/Defaults |
Comments |
availability_zones
|
|
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.
|
aws_access_key
|
|
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.
aliases: ec2_access_key, access_key
|
aws_secret_key
|
|
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.
aliases: ec2_secret_key, secret_key
|
default_cooldown
(added in 2.0) |
Default:
300 seconds
|
The number of seconds after a scaling activity completes before another can begin.
|
desired_capacity
|
|
Desired number of instances in group, if unspecified then the current group value will be used.
|
ec2_url
|
|
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.
|
health_check_period
(added in 1.7) |
Default:
500 seconds
|
Length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking its health.
|
health_check_type
(added in 1.7) |
|
The service you want the health status from, Amazon EC2 or Elastic Load Balancer.
|
launch_config_name
required |
|
Name of the Launch configuration to use for the group. See the ec2_lc module for managing these. If unspecified then the current group value will be used.
|
lc_check
(added in 1.8) |
Default:
yes
|
Check to make sure instances that are being replaced with replace_instances do not already have the current launch_config.
|
load_balancers
|
|
List of ELB names to use for the group. Use for classic load balancers.
|
max_size
|
|
Maximum number of instances in group, if unspecified then the current group value will be used.
|
metrics_collection
bool
(added in 2.6) |
|
Enable ASG metrics collection
|
metrics_granularity
(added in 2.6) |
Default:
1minute
|
When metrics_collection is enabled this will determine granularity of metrics collected by CloudWatch
|
metrics_list
(added in 2.6) |
Default:
['GroupMinSize', 'GroupMaxSize', 'GroupDesiredCapacity', 'GroupInServiceInstances', 'GroupPendingInstances', 'GroupStandbyInstances', 'GroupTerminatingInstances', 'GroupTotalInstances']
|
List of autoscaling metrics to collect when enabling metrics_collection
|
min_size
|
|
Minimum number of instances in group, if unspecified then the current group value will be used.
|
name
required |
|
Unique name for group to be created or deleted
|
notification_topic
(added in 2.2) |
|
A SNS topic ARN to send auto scaling notifications to.
|
notification_types
(added in 2.2) |
Default:
['autoscaling:EC2_INSTANCE_LAUNCH', 'autoscaling:EC2_INSTANCE_LAUNCH_ERROR', 'autoscaling:EC2_INSTANCE_TERMINATE', 'autoscaling:EC2_INSTANCE_TERMINATE_ERROR']
|
A list of auto scaling events to trigger notifications on.
|
placement_group
(added in 2.3) |
|
Physical location of your cluster placement group created in Amazon EC2.
|
profile
(added in 1.6) |
|
Uses a boto profile. Only works with boto >= 2.24.0.
|
region
|
|
aliases: aws_region, ec2_region
|
replace_all_instances
(added in 1.8) |
Default:
no
|
In a rolling fashion, replace all instances with an old launch configuration with one from the current launch configuration.
|
replace_batch_size
(added in 1.8) |
Default:
1
|
Number of instances you'd like to replace at a time. Used with replace_all_instances.
|
replace_instances
(added in 1.8) |
|
List of instance_ids belonging to the named ASG that you would like to terminate and be replaced with instances matching the current launch configuration.
|
security_token
(added in 1.6) |
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.
aliases: access_token
|
state
|
Choices:
present ←
- absent
|
register or deregister the instance
|
suspend_processes
(added in 2.3) |
Choices:
- Launch
- Terminate
- HealthCheck
- ReplaceUnhealthy
- AZRebalance
- AlarmNotification
- ScheduledActions
- AddToLoadBalancer
Default:
[]
|
A list of scaling processes to suspend.
|
tags
(added in 1.7) |
|
A list of tags to add to the Auto Scale Group. Optional key is 'propagate_at_launch', which defaults to true.
|
target_group_arns
(added in 2.4) |
|
List of target group ARNs to use for the group. Use for application load balancers.
|
termination_policies
(added in 2.0) |
Choices:
- OldestInstance
- NewestInstance
- OldestLaunchConfiguration
- ClosestToNextInstanceHour
Default ←
|
An ordered list of criteria used for selecting instances to be removed from the Auto Scaling group when reducing capacity.
For 'Default', when used to create a new autoscaling group, the "Default"i value is used. When used to change an existent autoscaling group, the current termination policies are maintained.
|
validate_certs
bool
(added in 1.5) |
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
vpc_zone_identifier
|
|
List of VPC subnets to use
|
wait_for_instances
(added in 1.9) |
Default:
yes
|
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".
|
wait_timeout
(added in 1.8) |
Default:
300
|
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.
|