github.com/atsaki/terraform@v0.4.3-0.20150919165407-25bba5967654/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_autoscaling_group" "bar" {
    17    availability_zones = ["us-east-1a"]
    18    name = "foobar3-terraform-test"
    19    max_size = 5
    20    min_size = 2
    21    health_check_grace_period = 300
    22    health_check_type = "ELB"
    23    desired_capacity = 4
    24    force_delete = true
    25    launch_configuration = "${aws_launch_configuration.foobar.name}"
    26  
    27    tag {
    28      key = "foo"
    29      value = "bar"
    30      propagate_at_launch = true
    31    }
    32    tag {
    33      key = "lorem"
    34      value = "ipsum"
    35      propagate_at_launch = false
    36    }
    37  }
    38  ```
    39  
    40  ## Argument Reference
    41  
    42  The following arguments are supported:
    43  
    44  * `name` - (Required) The name of the auto scale group.
    45  * `max_size` - (Required) The maximum size of the auto scale group.
    46  * `min_size` - (Required) The minimum size of the auto scale group.
    47      (See also [Waiting for Capacity](#waiting-for-capacity) below.)
    48  * `availability_zones` - (Optional) A list of AZs to launch resources in.
    49     Required only if you do not specify any `vpc_zone_identifier`
    50  * `launch_configuration` - (Required) The name of the launch configuration to use.
    51  * `health_check_grace_period` - (Optional) Time after instance comes into service before checking health.
    52  * `health_check_type` - (Optional) "EC2" or "ELB". Controls how health checking is done.
    53  * `desired_capacity` - (Optional) The number of Amazon EC2 instances that
    54      should be running in the group. (See also [Waiting for
    55      Capacity](#waiting-for-capacity) below.)
    56  * `min_elb_capacity` - (Optional) Setting this will cause Terraform to wait
    57      for this number of healthy instances all attached load balancers.
    58      (See also [Waiting for Capacity](#waiting-for-capacity) below.)
    59  * `force_delete` - (Optional) Allows deleting the autoscaling group without waiting
    60     for all instances in the pool to terminate.
    61  * `load_balancers` (Optional) A list of load balancer names to add to the autoscaling
    62     group names.
    63  * `vpc_zone_identifier` (Optional) A list of subnet IDs to launch resources in.
    64  * `termination_policies` (Optional) A list of policies to decide how the instances in the auto scale group should be terminated.
    65  * `tag` (Optional) A list of tag blocks. Tags documented below.
    66  
    67  Tags support the following:
    68  
    69  * `key` - (Required) Key
    70  * `value` - (Required) Value
    71  * `propagate_at_launch` - (Required) Enables propagation of the tag to
    72     Amazon EC2 instances launched via this ASG
    73  
    74  ## Attributes Reference
    75  
    76  The following attributes are exported:
    77  
    78  * `id` - The autoscaling group name.
    79  * `availability_zones` - The availability zones of the autoscale group.
    80  * `min_size` - The minimum size of the autoscale group
    81  * `max_size` - The maximum size of the autoscale group
    82  * `default_cooldown` - Time between a scaling activity and the succeeding scaling activity.
    83  * `name` - The name of the autoscale group
    84  * `health_check_grace_period` - Time after instance comes into service before checking health.
    85  * `health_check_type` - "EC2" or "ELB". Controls how health checking is done.
    86  * `desired_capacity` -The number of Amazon EC2 instances that should be running in the group.
    87  * `launch_configuration` - The launch configuration of the autoscale group
    88  * `vpc_zone_identifier` - The VPC zone identifier
    89  * `load_balancers` (Optional) The load balancer names associated with the
    90     autoscaling group.
    91  
    92  <a id="waiting-for-capacity"></a>
    93  ## Waiting for Capacity
    94  
    95  A newly-created ASG is initially empty and begins to scale to `min_size` (or
    96  `desired_capacity`, if specified) by launching instances using the provided
    97  Launch Configuration. These instances take time to launch and boot.
    98  
    99  Terraform provides two mechanisms to help consistently manage ASG scale up
   100  time across dependent resources.
   101  
   102  #### Waiting for ASG Capacity
   103  
   104  The first is default behavior. Terraform waits after ASG creation for
   105  `min_size` (or `desired_capacity`, if specified) healthy instances to show up
   106  in the ASG before continuing.
   107  
   108  Terraform considers an instance "healthy" when the ASG reports `HealthStatus:
   109  "Healthy"` and `LifecycleState: "InService"`. See the [AWS AutoScaling
   110  Docs](https://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html)
   111  for more information on an ASG's lifecycle.
   112  
   113  Terraform will wait for healthy instances for up to 10 minutes. If ASG creation
   114  is taking more than a few minutes, it's worth investigating for scaling activity
   115  errors, which can be caused by problems with the selected Launch Configuration.
   116  
   117  #### Waiting for ELB Capacity
   118  
   119  The second mechanism is optional, and affects ASGs with attached Load
   120  Balancers. If `min_elb_capacity` is set, Terraform will wait for that number of
   121  Instances to be `"InService"` in all attached `load_balancers`. This can be
   122  used to ensure that service is being provided before Terraform moves on.
   123  
   124  As with ASG Capacity, Terraform will wait for up to 10 minutes for
   125  `"InService"` instances. If ASG creation takes more than a few minutes, this
   126  could indicate one of a number of configuration problems. See the [AWS Docs on
   127  Load Balancer Troubleshooting](https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-troubleshooting.html)
   128  for more information.