github.com/erriapo/terraform@v0.6.12-0.20160203182612-0340ea72354f/website/source/docs/providers/aws/r/autoscaling_group.html.markdown (about) 1 --- 2 layout: "aws" 3 page_title: "AWS: aws_autoscaling_group" 4 sidebar_current: "docs-aws-resource-autoscaling-group" 5 description: |- 6 Provides an AutoScaling Group resource. 7 --- 8 9 # aws\_autoscaling\_group 10 11 Provides an AutoScaling Group resource. 12 13 ## Example Usage 14 15 ``` 16 resource "aws_placement_group" "test" { 17 name = "test" 18 strategy = "cluster" 19 } 20 21 resource "aws_autoscaling_group" "bar" { 22 availability_zones = ["us-east-1a"] 23 name = "foobar3-terraform-test" 24 max_size = 5 25 min_size = 2 26 health_check_grace_period = 300 27 health_check_type = "ELB" 28 desired_capacity = 4 29 force_delete = true 30 placement_group = "${aws_placement_group.test.id}" 31 launch_configuration = "${aws_launch_configuration.foobar.name}" 32 33 tag { 34 key = "foo" 35 value = "bar" 36 propagate_at_launch = true 37 } 38 tag { 39 key = "lorem" 40 value = "ipsum" 41 propagate_at_launch = false 42 } 43 } 44 ``` 45 46 ## Argument Reference 47 48 The following arguments are supported: 49 50 * `name` - (Optional) The name of the auto scale group. By default generated by terraform. 51 * `max_size` - (Required) The maximum size of the auto scale group. 52 * `min_size` - (Required) The minimum size of the auto scale group. 53 (See also [Waiting for Capacity](#waiting-for-capacity) below.) 54 * `availability_zones` - (Optional) A list of AZs to launch resources in. 55 Required only if you do not specify any `vpc_zone_identifier` 56 * `launch_configuration` - (Required) The name of the launch configuration to use. 57 * `health_check_grace_period` - (Optional) Time after instance comes into service before checking health. 58 * `health_check_type` - (Optional) "EC2" or "ELB". Controls how health checking is done. 59 * `desired_capacity` - (Optional) The number of Amazon EC2 instances that 60 should be running in the group. (See also [Waiting for 61 Capacity](#waiting-for-capacity) below.) 62 * `force_delete` - (Optional) Allows deleting the autoscaling group without waiting 63 for all instances in the pool to terminate. You can force an autoscaling group to delete 64 even if it's in the process of scaling a resource. Normally, Terraform 65 drains all the instances before deleting the group. This bypasses that 66 behavior and potentially leaves resources dangling. 67 * `load_balancers` (Optional) A list of load balancer names to add to the autoscaling 68 group names. 69 * `vpc_zone_identifier` (Optional) A list of subnet IDs to launch resources in. 70 * `termination_policies` (Optional) A list of policies to decide how the instances in the auto scale group should be terminated. 71 * `tag` (Optional) A list of tag blocks. Tags documented below. 72 * `placement_group` (Optional) The name of the placement group into which you'll launch your instances, if any. 73 * `wait_for_capacity_timeout` (Default: "10m") A maximum 74 [duration](https://golang.org/pkg/time/#ParseDuration) that Terraform should 75 wait for ASG instances to be healthy before timing out. (See also [Waiting 76 for Capacity](#waiting-for-capacity) below.) Setting this to "0" causes 77 Terraform to skip all Capacity Waiting behavior. 78 * `min_elb_capacity` - (Optional) Setting this causes Terraform to wait for 79 this number of instances to show up healthy in the ELB only on creation. 80 Updates will not wait on ELB instance number changes. 81 (See also [Waiting for Capacity](#waiting-for-capacity) below.) 82 * `wait_for_elb_capacity` - (Optional) Setting this will cause Terraform to wait 83 for exactly this number of healthy instances in all attached load balancers 84 on both create and update operations. (Takes precedence over 85 `min_elb_capacity` behavior.) 86 (See also [Waiting for Capacity](#waiting-for-capacity) below.) 87 88 Tags support the following: 89 90 * `key` - (Required) Key 91 * `value` - (Required) Value 92 * `propagate_at_launch` - (Required) Enables propagation of the tag to 93 Amazon EC2 instances launched via this ASG 94 95 ## Attributes Reference 96 97 The following attributes are exported: 98 99 * `id` - The autoscaling group name. 100 * `availability_zones` - The availability zones of the autoscale group. 101 * `min_size` - The minimum size of the autoscale group 102 * `max_size` - The maximum size of the autoscale group 103 * `default_cooldown` - Time between a scaling activity and the succeeding scaling activity. 104 * `name` - The name of the autoscale group 105 * `health_check_grace_period` - Time after instance comes into service before checking health. 106 * `health_check_type` - "EC2" or "ELB". Controls how health checking is done. 107 * `desired_capacity` -The number of Amazon EC2 instances that should be running in the group. 108 * `launch_configuration` - The launch configuration of the autoscale group 109 * `vpc_zone_identifier` - The VPC zone identifier 110 * `load_balancers` (Optional) The load balancer names associated with the 111 autoscaling group. 112 113 ~> **NOTE:** When using `ELB` as the health_check_type, `health_check_grace_period` is required. 114 115 <a id="waiting-for-capacity"></a> 116 ## Waiting for Capacity 117 118 A newly-created ASG is initially empty and begins to scale to `min_size` (or 119 `desired_capacity`, if specified) by launching instances using the provided 120 Launch Configuration. These instances take time to launch and boot. 121 122 On ASG Update, changes to these values also take time to result in the target 123 number of instances providing service. 124 125 Terraform provides two mechanisms to help consistently manage ASG scale up 126 time across dependent resources. 127 128 #### Waiting for ASG Capacity 129 130 The first is default behavior. Terraform waits after ASG creation for 131 `min_size` (or `desired_capacity`, if specified) healthy instances to show up 132 in the ASG before continuing. 133 134 If `min_size` or `desired_capacity` are changed in a subsequent update, 135 Terraform will also wait for the correct number of healthy instances before 136 continuing. 137 138 Terraform considers an instance "healthy" when the ASG reports `HealthStatus: 139 "Healthy"` and `LifecycleState: "InService"`. See the [AWS AutoScaling 140 Docs](https://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html) 141 for more information on an ASG's lifecycle. 142 143 Terraform will wait for healthy instances for up to 144 `wait_for_capacity_timeout`. If ASG creation is taking more than a few minutes, 145 it's worth investigating for scaling activity errors, which can be caused by 146 problems with the selected Launch Configuration. 147 148 Setting `wait_for_capacity_timeout` to `"0"` disables ASG Capacity waiting. 149 150 #### Waiting for ELB Capacity 151 152 The second mechanism is optional, and affects ASGs with attached ELBs specified 153 via the `load_balancers` attribute. 154 155 The `min_elb_capacity` parameter causes Terraform to wait for at least the 156 requested number of instances to show up `"InService"` in all attached ELBs 157 during ASG creation. It has no effect on ASG updates. 158 159 If `wait_for_elb_capacity` is set, Terraform will wait for exactly that number 160 of Instances to be `"InService"` in all attached ELBs on both creation and 161 updates. 162 163 These parameters can be used to ensure that service is being provided before 164 Terraform moves on. If new instances don't pass the ELB's health checks for any 165 reason, the Terraform apply will time out, and the ASG will be marked as 166 tainted (i.e. marked to be destroyed in a follow up run). 167 168 As with ASG Capacity, Terraform will wait for up to `wait_for_capacity_timeout` 169 for the proper number of instances to be healthy. 170 171 #### Troubleshooting Capacity Waiting Timeouts 172 173 If ASG creation takes more than a few minutes, this could indicate one of a 174 number of configuration problems. See the [AWS Docs on Load Balancer 175 Troubleshooting](https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-troubleshooting.html) 176 for more information.