github.com/leeprovoost/terraform@v0.6.10-0.20160119085442-96f3f76118e7/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  * `wait_for_elb_capacity` - (Optional) Setting this will cause Terraform to wait
    79    for this number of healthy instances all attached load balancers.
    80    (See also [Waiting for Capacity](#waiting-for-capacity) below.)
    81  
    82  Tags support the following:
    83  
    84  * `key` - (Required) Key
    85  * `value` - (Required) Value
    86  * `propagate_at_launch` - (Required) Enables propagation of the tag to
    87     Amazon EC2 instances launched via this ASG
    88  
    89  The following fields are deprecated:
    90  
    91  * `min_elb_capacity` - Please use `wait_for_elb_capacity` instead.
    92  
    93  ## Attributes Reference
    94  
    95  The following attributes are exported:
    96  
    97  * `id` - The autoscaling group name.
    98  * `availability_zones` - The availability zones of the autoscale group.
    99  * `min_size` - The minimum size of the autoscale group
   100  * `max_size` - The maximum size of the autoscale group
   101  * `default_cooldown` - Time between a scaling activity and the succeeding scaling activity.
   102  * `name` - The name of the autoscale group
   103  * `health_check_grace_period` - Time after instance comes into service before checking health.
   104  * `health_check_type` - "EC2" or "ELB". Controls how health checking is done.
   105  * `desired_capacity` -The number of Amazon EC2 instances that should be running in the group.
   106  * `launch_configuration` - The launch configuration of the autoscale group
   107  * `vpc_zone_identifier` - The VPC zone identifier
   108  * `load_balancers` (Optional) The load balancer names associated with the
   109     autoscaling group.
   110  
   111  ~> **NOTE:** When using `ELB` as the health_check_type, `health_check_grace_period` is required.
   112  
   113  <a id="waiting-for-capacity"></a>
   114  ## Waiting for Capacity
   115  
   116  A newly-created ASG is initially empty and begins to scale to `min_size` (or
   117  `desired_capacity`, if specified) by launching instances using the provided
   118  Launch Configuration. These instances take time to launch and boot.
   119  
   120  Terraform provides two mechanisms to help consistently manage ASG scale up
   121  time across dependent resources.
   122  
   123  #### Waiting for ASG Capacity
   124  
   125  The first is default behavior. Terraform waits after ASG creation for
   126  `min_size` (or `desired_capacity`, if specified) healthy instances to show up
   127  in the ASG before continuing.
   128  
   129  If `min_size` or `desired_capacity` are changed in a subsequent update,
   130  Terraform will also wait for the correct number of healthy instances before
   131  continuing.
   132  
   133  Terraform considers an instance "healthy" when the ASG reports `HealthStatus:
   134  "Healthy"` and `LifecycleState: "InService"`. See the [AWS AutoScaling
   135  Docs](https://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html)
   136  for more information on an ASG's lifecycle.
   137  
   138  Terraform will wait for healthy instances for up to
   139  `wait_for_capacity_timeout`. If ASG creation is taking more than a few minutes,
   140  it's worth investigating for scaling activity errors, which can be caused by
   141  problems with the selected Launch Configuration.
   142  
   143  Setting `wait_for_capacity_timeout` to `"0"` disables ASG Capacity waiting.
   144  
   145  #### Waiting for ELB Capacity
   146  
   147  The second mechanism is optional, and affects ASGs with attached Load
   148  Balancers. If `wait_for_elb_capacity` is set, Terraform will wait for that
   149  number of Instances to be `"InService"` in all attached `load_balancers`. This
   150  can be used to ensure that service is being provided before Terraform moves on.
   151  
   152  As with ASG Capacity, Terraform will wait for up to `wait_for_capacity_timeout`
   153  (for `"InService"` instances. If ASG creation takes more than a few minutes,
   154  this could indicate one of a number of configuration problems. See the [AWS
   155  Docs on Load Balancer
   156  Troubleshooting](https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-troubleshooting.html)
   157  for more information.