github.com/jrasell/terraform@v0.6.17-0.20160523115548-2652f5232949/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, Default: 300) Time (in seconds) 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. The allowed values are `OldestInstance`, `NewestInstance`, `OldestLaunchConfiguration`, `ClosestToNextInstanceHour`, `Default`.
    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  * `metrics_granularity` - (Optional) The granularity to associate with the metrics to collect. The only valid value is `1Minute`. Default is `1Minute`.
    74  * `enabled_metrics` - (Optional) A list of metrics to collect. The allowed values are `GroupMinSize`, `GroupMaxSize`, `GroupDesiredCapacity`, `GroupInServiceInstances`, `GroupPendingInstances`, `GroupStandbyInstances`, `GroupTerminatingInstances`, `GroupTotalInstances`.
    75  * `wait_for_capacity_timeout` (Default: "10m") A maximum
    76    [duration](https://golang.org/pkg/time/#ParseDuration) that Terraform should
    77    wait for ASG instances to be healthy before timing out.  (See also [Waiting
    78    for Capacity](#waiting-for-capacity) below.) Setting this to "0" causes
    79    Terraform to skip all Capacity Waiting behavior.
    80  * `min_elb_capacity` - (Optional) Setting this causes Terraform to wait for
    81    this number of instances to show up healthy in the ELB only on creation.
    82    Updates will not wait on ELB instance number changes.
    83    (See also [Waiting for Capacity](#waiting-for-capacity) below.)
    84  * `wait_for_elb_capacity` - (Optional) Setting this will cause Terraform to wait
    85    for exactly this number of healthy instances in all attached load balancers
    86    on both create and update operations. (Takes precedence over
    87    `min_elb_capacity` behavior.)
    88    (See also [Waiting for Capacity](#waiting-for-capacity) below.)
    89  
    90  Tags support the following:
    91  
    92  * `key` - (Required) Key
    93  * `value` - (Required) Value
    94  * `propagate_at_launch` - (Required) Enables propagation of the tag to
    95     Amazon EC2 instances launched via this ASG
    96  
    97  ## Attributes Reference
    98  
    99  The following attributes are exported:
   100  
   101  * `id` - The autoscaling group name.
   102  * `availability_zones` - The availability zones of the autoscale group.
   103  * `min_size` - The minimum size of the autoscale group
   104  * `max_size` - The maximum size of the autoscale group
   105  * `default_cooldown` - Time between a scaling activity and the succeeding scaling activity.
   106  * `name` - The name of the autoscale group
   107  * `health_check_grace_period` - Time after instance comes into service before checking health.
   108  * `health_check_type` - "EC2" or "ELB". Controls how health checking is done.
   109  * `desired_capacity` -The number of Amazon EC2 instances that should be running in the group.
   110  * `launch_configuration` - The launch configuration of the autoscale group
   111  * `vpc_zone_identifier` (Optional) - The VPC zone identifier
   112  * `load_balancers` (Optional) The load balancer names associated with the
   113     autoscaling group.
   114  
   115  ~> **NOTE:** When using `ELB` as the health_check_type, `health_check_grace_period` is required.
   116  
   117  ## Waiting for Capacity
   118  
   119  A newly-created ASG is initially empty and begins to scale to `min_size` (or
   120  `desired_capacity`, if specified) by launching instances using the provided
   121  Launch Configuration. These instances take time to launch and boot.
   122  
   123  On ASG Update, changes to these values also take time to result in the target
   124  number of instances providing service.
   125  
   126  Terraform provides two mechanisms to help consistently manage ASG scale up
   127  time across dependent resources.
   128  
   129  #### Waiting for ASG Capacity
   130  
   131  The first is default behavior. Terraform waits after ASG creation for
   132  `min_size` (or `desired_capacity`, if specified) healthy instances to show up
   133  in the ASG before continuing.
   134  
   135  If `min_size` or `desired_capacity` are changed in a subsequent update,
   136  Terraform will also wait for the correct number of healthy instances before
   137  continuing.
   138  
   139  Terraform considers an instance "healthy" when the ASG reports `HealthStatus:
   140  "Healthy"` and `LifecycleState: "InService"`. See the [AWS AutoScaling
   141  Docs](https://docs.aws.amazon.com/AutoScaling/latest/DeveloperGuide/AutoScalingGroupLifecycle.html)
   142  for more information on an ASG's lifecycle.
   143  
   144  Terraform will wait for healthy instances for up to
   145  `wait_for_capacity_timeout`. If ASG creation is taking more than a few minutes,
   146  it's worth investigating for scaling activity errors, which can be caused by
   147  problems with the selected Launch Configuration.
   148  
   149  Setting `wait_for_capacity_timeout` to `"0"` disables ASG Capacity waiting.
   150  
   151  #### Waiting for ELB Capacity
   152  
   153  The second mechanism is optional, and affects ASGs with attached ELBs specified
   154  via the `load_balancers` attribute.
   155  
   156  The `min_elb_capacity` parameter causes Terraform to wait for at least the
   157  requested number of instances to show up `"InService"` in all attached ELBs
   158  during ASG creation.  It has no effect on ASG updates.
   159  
   160  If `wait_for_elb_capacity` is set, Terraform will wait for exactly that number
   161  of Instances to be `"InService"` in all attached ELBs on both creation and
   162  updates.
   163  
   164  These parameters can be used to ensure that service is being provided before
   165  Terraform moves on. If new instances don't pass the ELB's health checks for any
   166  reason, the Terraform apply will time out, and the ASG will be marked as
   167  tainted (i.e. marked to be destroyed in a follow up run).
   168  
   169  As with ASG Capacity, Terraform will wait for up to `wait_for_capacity_timeout`
   170  for the proper number of instances to be healthy.
   171  
   172  #### Troubleshooting Capacity Waiting Timeouts
   173  
   174  If ASG creation takes more than a few minutes, this could indicate one of a
   175  number of configuration problems. See the [AWS Docs on Load Balancer
   176  Troubleshooting](https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/elb-troubleshooting.html)
   177  for more information.