Home

Awesome

<!-- markdownlint-disable -->

<a href="https://cpco.io/homepage"><img src="https://github.com/cloudposse/terraform-aws-ec2-autoscale-group/blob/main/.github/banner.png?raw=true" alt="Project Banner"/></a><br/> <p align="right"> <a href="https://github.com/cloudposse/terraform-aws-ec2-autoscale-group/releases/latest"><img src="https://img.shields.io/github/release/cloudposse/terraform-aws-ec2-autoscale-group.svg?style=for-the-badge" alt="Latest Release"/></a><a href="https://github.com/cloudposse/terraform-aws-ec2-autoscale-group/commits"><img src="https://img.shields.io/github/last-commit/cloudposse/terraform-aws-ec2-autoscale-group.svg?style=for-the-badge" alt="Last Updated"/></a><a href="https://slack.cloudposse.com"><img src="https://slack.cloudposse.com/for-the-badge.svg" alt="Slack Community"/></a></p>

<!-- markdownlint-restore --> <!-- ** DO NOT EDIT THIS FILE ** ** This file was automatically generated by the `cloudposse/build-harness`. ** 1) Make all changes to `README.yaml` ** 2) Run `make init` (you only need to do this once) ** 3) Run`make readme` to rebuild this file. ** ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.) ** -->

Terraform module to provision Auto Scaling Group and Launch Template on AWS.

The module also creates AutoScaling Policies and CloudWatch Metric Alarms to monitor CPU utilization on the EC2 instances and scale the number of instance in the AutoScaling Group up or down. If you don't want to use the provided functionality, or want to provide your own policies, disable it by setting the variable autoscaling_policies_enabled to false.

At present, although you can set the created AutoScaling Policy type to any legal value, in practice only SimpleScaling is supported. To use a StepScaling or TargetTrackingScaling policy, create it yourself and then pass it in the alarm_actions field of custom_alarms.

[!TIP]

πŸ‘½ Use Atmos with Terraform

Cloud Posse uses atmos to easily orchestrate multiple environments using Terraform. <br/> Works with Github Actions, Atlantis, or Spacelift.

<details> <summary><strong>Watch demo of using Atmos with Terraform</strong></summary> <img src="https://github.com/cloudposse/atmos/blob/main/docs/demo.gif?raw=true"/><br/> <i>Example of running <a href="https://atmos.tools"><code>atmos</code></a> to manage infrastructure from our <a href="https://atmos.tools/quick-start/">Quick Start</a> tutorial.</i> </detalis>

Usage

locals {
  userdata = <<-USERDATA
    #!/bin/bash
    cat <<"__EOF__" > /home/ec2-user/.ssh/config
    Host *
      StrictHostKeyChecking no
    __EOF__
    chmod 600 /home/ec2-user/.ssh/config
    chown ec2-user:ec2-user /home/ec2-user/.ssh/config
  USERDATA
}

module "autoscale_group" {
  source = "cloudposse/ec2-autoscale-group/aws"
  # Cloud Posse recommends pinning every module to a specific version
  # version = "x.x.x"

  namespace   = var.namespace
  stage       = var.stage
  environment = var.environment
  name        = var.name

  image_id                    = "ami-08cab282f9979fc7a"
  instance_type               = "t2.small"
  security_group_ids          = ["sg-xxxxxxxx"]
  subnet_ids                  = ["subnet-xxxxxxxx", "subnet-yyyyyyyy", "subnet-zzzzzzzz"]
  health_check_type           = "EC2"
  min_size                    = 2
  max_size                    = 3
  wait_for_capacity_timeout   = "5m"
  associate_public_ip_address = true
  user_data_base64            = base64encode(local.userdata)

  # All inputs to `block_device_mappings` have to be defined
  block_device_mappings = [
    {
      device_name  = "/dev/sda1"
      no_device    = "false"
      virtual_name = "root"
      ebs = {
        encrypted             = true
        volume_size           = 200
        delete_on_termination = true
        iops                  = null
        kms_key_id            = null
        snapshot_id           = null
        volume_type           = "standard"
      }
    }
  ]

  tags = {
    Tier              = "1"
    KubernetesCluster = "us-west-2.testing.cloudposse.co"
  }

  # Auto-scaling policies and CloudWatch metric alarms
  autoscaling_policies_enabled           = true
  cpu_utilization_high_threshold_percent = "70"
  cpu_utilization_low_threshold_percent  = "20"
}

To enable custom_alerts the map needs to be defined like so :

alarms = {
    alb_scale_up = {
      alarm_name                = "${module.default_label.id}-alb-target-response-time-for-scale-up"
      comparison_operator       = "GreaterThanThreshold"
      evaluation_periods        = var.alb_target_group_alarms_evaluation_periods
      metric_name               = "TargetResponseTime"
      namespace                 = "AWS/ApplicationELB"
      period                    = var.alb_target_group_alarms_period
      statistic                 = "Average"
      threshold                 = var.alb_target_group_alarms_response_time_max_threshold
      dimensions_name           = "LoadBalancer"
      dimensions_target         = data.alb.arn_suffix
      treat_missing_data        = "missing"
      ok_actions                = var.alb_target_group_alarms_ok_actions
      insufficient_data_actions = var.alb_target_group_alarms_insufficient_data_actions
      alarm_description         = "ALB Target response time is over ${var.alb_target_group_alarms_response_time_max_threshold} for more than ${var.alb_target_group_alarms_period}"
      alarm_actions             = [module.autoscaling.scale_up_policy_arn]
    }
}

All those keys are required to be there so if the alarm you are setting does not requiere one or more keys you can just set to empty but do not remove the keys otherwise you could get a weird merge error due to the maps being of different sizes.

[!IMPORTANT] In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic approach for updating versions to avoid unexpected changes.

<!-- markdownlint-disable -->

Makefile Targets

Available targets:

  help                                Help screen
  help/all                            Display help for all targets
  help/short                          This help short screen
  lint                                Lint terraform code

<!-- markdownlint-restore --> <!-- markdownlint-disable -->

Requirements

NameVersion
<a name="requirement_terraform"></a> terraform>= 1.3
<a name="requirement_aws"></a> aws>= 5.16

Providers

NameVersion
<a name="provider_aws"></a> aws>= 5.16

Modules

NameSourceVersion
<a name="module_this"></a> thiscloudposse/label/null0.25.0

Resources

NameType
aws_autoscaling_group.defaultresource
aws_autoscaling_policy.scale_downresource
aws_autoscaling_policy.scale_upresource
aws_cloudwatch_metric_alarm.all_alarmsresource
aws_launch_template.defaultresource
aws_subnet.thisdata source

Inputs

NameDescriptionTypeDefaultRequired
<a name="input_additional_tag_map"></a> additional_tag_mapAdditional key-value pairs to add to each map in tags_as_list_of_maps. Not added to tags or id.<br/>This is for some rare cases where resources want additional configuration of tags<br/>and therefore take a list of maps with tag key, value, and additional configuration.map(string){}no
<a name="input_associate_public_ip_address"></a> associate_public_ip_addressAssociate a public IP address with an instance in a VPC. If network_interface_id is specified, this can only be false (see here for more info: https://stackoverflow.com/a/76808361).boolfalseno
<a name="input_attributes"></a> attributesID element. Additional attributes (e.g. workers or cluster) to add to id,<br/>in the order they appear in the list. New attributes are appended to the<br/>end of the list. The elements of the list are joined by the delimiter<br/>and treated as a single ID element.list(string)[]no
<a name="input_autoscaling_policies_enabled"></a> autoscaling_policies_enabledWhether to create aws_autoscaling_policy and aws_cloudwatch_metric_alarm resources to control Auto Scalingbooltrueno
<a name="input_block_device_mappings"></a> block_device_mappingsSpecify volumes to attach to the instance besides the volumes specified by the AMI<pre>list(object({<br/> device_name = optional(string)<br/> no_device = optional(bool)<br/> virtual_name = optional(string)<br/> ebs = object({<br/> delete_on_termination = optional(bool)<br/> encrypted = optional(bool)<br/> iops = optional(number)<br/> throughput = optional(number)<br/> kms_key_id = optional(string)<br/> snapshot_id = optional(string)<br/> volume_size = optional(number)<br/> volume_type = optional(string)<br/> })<br/> }))</pre>[]no
<a name="input_capacity_rebalance"></a> capacity_rebalanceIndicates whether capacity rebalance is enabled. Otherwise, capacity rebalance is disabled.boolfalseno
<a name="input_context"></a> contextSingle object for setting entire context at once.<br/>See description of individual variables for details.<br/>Leave string and numeric variables as null to use default value.<br/>Individual variable settings (non-null) override settings in context object,<br/>except for attributes, tags, and additional_tag_map, which are merged.any<pre>{<br/> "additional_tag_map": {},<br/> "attributes": [],<br/> "delimiter": null,<br/> "descriptor_formats": {},<br/> "enabled": true,<br/> "environment": null,<br/> "id_length_limit": null,<br/> "label_key_case": null,<br/> "label_order": [],<br/> "label_value_case": null,<br/> "labels_as_tags": [<br/> "unset"<br/> ],<br/> "name": null,<br/> "namespace": null,<br/> "regex_replace_chars": null,<br/> "stage": null,<br/> "tags": {},<br/> "tenant": null<br/>}</pre>no
<a name="input_cpu_utilization_high_evaluation_periods"></a> cpu_utilization_high_evaluation_periodsThe number of periods over which data is compared to the specified thresholdnumber2no
<a name="input_cpu_utilization_high_period_seconds"></a> cpu_utilization_high_period_secondsThe period in seconds over which the specified statistic is appliednumber300no
<a name="input_cpu_utilization_high_statistic"></a> cpu_utilization_high_statisticThe statistic to apply to the alarm's associated metric. Either of the following is supported: SampleCount, Average, Sum, Minimum, Maximumstring"Average"no
<a name="input_cpu_utilization_high_threshold_percent"></a> cpu_utilization_high_threshold_percentThe value against which the specified statistic is comparednumber90no
<a name="input_cpu_utilization_low_evaluation_periods"></a> cpu_utilization_low_evaluation_periodsThe number of periods over which data is compared to the specified thresholdnumber2no
<a name="input_cpu_utilization_low_period_seconds"></a> cpu_utilization_low_period_secondsThe period in seconds over which the specified statistic is appliednumber300no
<a name="input_cpu_utilization_low_statistic"></a> cpu_utilization_low_statisticThe statistic to apply to the alarm's associated metric. Either of the following is supported: SampleCount, Average, Sum, Minimum, Maximumstring"Average"no
<a name="input_cpu_utilization_low_threshold_percent"></a> cpu_utilization_low_threshold_percentThe value against which the specified statistic is comparednumber10no
<a name="input_credit_specification"></a> credit_specificationCustomize the credit specification of the instances<pre>object({<br/> cpu_credits = string<br/> })</pre>nullno
<a name="input_custom_alarms"></a> custom_alarmsMap of custom CloudWatch alarms configurations<pre>map(object({<br/> alarm_name = string<br/> comparison_operator = string<br/> evaluation_periods = string<br/> metric_name = string<br/> namespace = string<br/> period = string<br/> statistic = string<br/> extended_statistic = string<br/> threshold = string<br/> treat_missing_data = string<br/> ok_actions = list(string)<br/> insufficient_data_actions = list(string)<br/> dimensions_name = string<br/> dimensions_target = string<br/> alarm_description = string<br/> alarm_actions = list(string)<br/> }))</pre>{}no
<a name="input_default_alarms_enabled"></a> default_alarms_enabledEnable or disable cpu and memory Cloudwatch alarmsbooltrueno
<a name="input_default_cooldown"></a> default_cooldownThe amount of time, in seconds, after a scaling activity completes before another scaling activity can startnumber300no
<a name="input_delimiter"></a> delimiterDelimiter to be used between ID elements.<br/>Defaults to - (hyphen). Set to "" to use no delimiter at all.stringnullno
<a name="input_descriptor_formats"></a> descriptor_formatsDescribe additional descriptors to be output in the descriptors output map.<br/>Map of maps. Keys are names of descriptors. Values are maps of the form<br/>{<br/> format = string<br/> labels = list(string)<br/>}<br/>(Type is any so the map values can later be enhanced to provide additional options.)<br/>format is a Terraform format string to be passed to the format() function.<br/>labels is a list of labels, in order, to pass to format() function.<br/>Label values will be normalized before being passed to format() so they will be<br/>identical to how they appear in id.<br/>Default is {} (descriptors output will be empty).any{}no
<a name="input_desired_capacity"></a> desired_capacityThe number of Amazon EC2 instances that should be running in the group, if not set will use min_size as valuenumbernullno
<a name="input_disable_api_termination"></a> disable_api_terminationIf true, enables EC2 Instance Termination Protectionboolfalseno
<a name="input_ebs_optimized"></a> ebs_optimizedIf true, the launched EC2 instance will be EBS-optimizedboolfalseno
<a name="input_elastic_gpu_specifications"></a> elastic_gpu_specificationsSpecifications of Elastic GPU to attach to the instances<pre>object({<br/> type = string<br/> })</pre>nullno
<a name="input_enable_monitoring"></a> enable_monitoringEnable/disable detailed monitoringbooltrueno
<a name="input_enabled"></a> enabledSet to false to prevent the module from creating any resourcesboolnullno
<a name="input_enabled_metrics"></a> enabled_metricsA list of metrics to collect. The allowed values are GroupMinSize, GroupMaxSize, GroupDesiredCapacity, GroupInServiceInstances, GroupPendingInstances, GroupStandbyInstances, GroupTerminatingInstances, GroupTotalInstanceslist(string)<pre>[<br/> "GroupMinSize",<br/> "GroupMaxSize",<br/> "GroupDesiredCapacity",<br/> "GroupInServiceInstances",<br/> "GroupPendingInstances",<br/> "GroupStandbyInstances",<br/> "GroupTerminatingInstances",<br/> "GroupTotalInstances"<br/>]</pre>no
<a name="input_environment"></a> environmentID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT'stringnullno
<a name="input_force_delete"></a> force_deleteAllows deleting the autoscaling group without waiting for all instances in the pool to terminate. You can force an autoscaling group to delete even if it's in the process of scaling a resource. Normally, Terraform drains all the instances before deleting the group. This bypasses that behavior and potentially leaves resources danglingboolfalseno
<a name="input_health_check_grace_period"></a> health_check_grace_periodTime (in seconds) after instance comes into service before checking healthnumber300no
<a name="input_health_check_type"></a> health_check_typeControls how health checking is done. Valid values are EC2 or ELBstring"EC2"no
<a name="input_iam_instance_profile_name"></a> iam_instance_profile_nameThe IAM instance profile name to associate with launched instancesstring""no
<a name="input_id_length_limit"></a> id_length_limitLimit id to this many characters (minimum 6).<br/>Set to 0 for unlimited length.<br/>Set to null for keep the existing setting, which defaults to 0.<br/>Does not affect id_full.numbernullno
<a name="input_image_id"></a> image_idThe EC2 image ID to launchstring""no
<a name="input_instance_initiated_shutdown_behavior"></a> instance_initiated_shutdown_behaviorShutdown behavior for the instances. Can be stop or terminatestring"terminate"no
<a name="input_instance_market_options"></a> instance_market_optionsThe market (purchasing) option for the instances<pre>object({<br/> market_type = string<br/> spot_options = optional(object({<br/> block_duration_minutes = optional(number)<br/> instance_interruption_behavior = optional(string)<br/> max_price = optional(number)<br/> spot_instance_type = optional(string)<br/> valid_until = optional(string)<br/> }))<br/> })</pre>nullno
<a name="input_instance_refresh"></a> instance_refreshThe instance refresh definition<pre>object({<br/> strategy = string<br/> preferences = optional(object({<br/> instance_warmup = optional(number, null)<br/> min_healthy_percentage = optional(number, null)<br/> skip_matching = optional(bool, null)<br/> auto_rollback = optional(bool, null)<br/> scale_in_protected_instances = optional(string, null)<br/> standby_instances = optional(string, null)<br/> }), null)<br/> triggers = optional(list(string), [])<br/> })</pre>nullno
<a name="input_instance_reuse_policy"></a> instance_reuse_policyIf warm pool and this block are configured, instances in the Auto Scaling group can be returned to the warm pool on scale in. The default is to terminate instances in the Auto Scaling group when the group scales in.<pre>object({<br/> reuse_on_scale_in = bool<br/> })</pre>nullno
<a name="input_instance_type"></a> instance_typeInstance type to launchstringn/ayes
<a name="input_key_name"></a> key_nameThe SSH key name that should be used for the instancestring""no
<a name="input_label_key_case"></a> label_key_caseControls the letter case of the tags keys (label names) for tags generated by this module.<br/>Does not affect keys of tags passed in via the tags input.<br/>Possible values: lower, title, upper.<br/>Default value: title.stringnullno
<a name="input_label_order"></a> label_orderThe order in which the labels (ID elements) appear in the id.<br/>Defaults to ["namespace", "environment", "stage", "name", "attributes"].<br/>You can omit any of the 6 labels ("tenant" is the 6th), but at least one must be present.list(string)nullno
<a name="input_label_value_case"></a> label_value_caseControls the letter case of ID elements (labels) as included in id,<br/>set as tag values, and output by this module individually.<br/>Does not affect values of tags passed in via the tags input.<br/>Possible values: lower, title, upper and none (no transformation).<br/>Set this to title and set delimiter to "" to yield Pascal Case IDs.<br/>Default value: lower.stringnullno
<a name="input_labels_as_tags"></a> labels_as_tagsSet of labels (ID elements) to include as tags in the tags output.<br/>Default is to include all labels.<br/>Tags with empty values will not be included in the tags output.<br/>Set to [] to suppress all generated tags.<br/>Notes:<br/> The value of the name tag, if included, will be the id, not the name.<br/> Unlike other null-label inputs, the initial setting of labels_as_tags cannot be<br/> changed in later chained modules. Attempts to change it will be silently ignored.set(string)<pre>[<br/> "default"<br/>]</pre>no
<a name="input_launch_template_version"></a> launch_template_versionLaunch template version. Can be version number, $Latest or $Defaultstring"$Latest"no
<a name="input_load_balancers"></a> load_balancersA list of elastic load balancer names to add to the autoscaling group names. Only valid for classic load balancers. For ALBs, use target_group_arns insteadlist(string)[]no
<a name="input_max_instance_lifetime"></a> max_instance_lifetimeThe maximum amount of time, in seconds, that an instance can be in service, values must be either equal to 0 or between 604800 and 31536000 secondsnumbernullno
<a name="input_max_size"></a> max_sizeThe maximum size of the autoscale groupnumbern/ayes
<a name="input_metadata_http_endpoint_enabled"></a> metadata_http_endpoint_enabledSet false to disable the Instance Metadata Service.booltrueno
<a name="input_metadata_http_protocol_ipv6_enabled"></a> metadata_http_protocol_ipv6_enabledSet true to enable IPv6 in the launch template.boolfalseno
<a name="input_metadata_http_put_response_hop_limit"></a> metadata_http_put_response_hop_limitThe desired HTTP PUT response hop limit (between 1 and 64) for Instance Metadata Service requests.<br/>The default is 2 to support containerized workloads.number2no
<a name="input_metadata_http_tokens_required"></a> metadata_http_tokens_requiredSet true to require IMDS session tokens, disabling Instance Metadata Service Version 1.booltrueno
<a name="input_metadata_instance_metadata_tags_enabled"></a> metadata_instance_metadata_tags_enabledSet true to enable metadata tags in the launch template.boolfalseno
<a name="input_metrics_granularity"></a> metrics_granularityThe granularity to associate with the metrics to collect. The only valid value is 1Minutestring"1Minute"no
<a name="input_min_elb_capacity"></a> min_elb_capacitySetting this causes Terraform to wait for this number of instances to show up healthy in the ELB only on creation. Updates will not wait on ELB instance number changesnumber0no
<a name="input_min_size"></a> min_sizeThe minimum size of the autoscale groupnumbern/ayes
<a name="input_mixed_instances_policy"></a> mixed_instances_policypolicy to used mixed group of on demand/spot of differing types. Launch template is automatically generated. https://www.terraform.io/docs/providers/aws/r/autoscaling_group.html#mixed_instances_policy-1<pre>object({<br/> instances_distribution = optional(object({<br/> on_demand_allocation_strategy = string<br/> on_demand_base_capacity = number<br/> on_demand_percentage_above_base_capacity = number<br/> spot_allocation_strategy = string<br/> spot_instance_pools = number<br/> spot_max_price = string<br/> }))<br/> override = optional(list(object({<br/> instance_type = string<br/> weighted_capacity = number<br/> })))<br/> })</pre>nullno
<a name="input_name"></a> nameID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.<br/>This is the only ID element not also included as a tag.<br/>The "name" tag is set to the full id string. There is no tag with the value of the name input.stringnullno
<a name="input_namespace"></a> namespaceID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally uniquestringnullno
<a name="input_network_interface_id"></a> network_interface_idThe ID of the network interface to attach. If specified, all the other network_interface block arguments are ignored.stringnullno
<a name="input_placement"></a> placementThe placement specifications of the instances<pre>object({<br/> affinity = string<br/> availability_zone = string<br/> group_name = string<br/> host_id = string<br/> tenancy = string<br/> })</pre>nullno
<a name="input_placement_group"></a> placement_groupThe name of the placement group into which you'll launch your instances, if anystring""no
<a name="input_protect_from_scale_in"></a> protect_from_scale_inAllows setting instance protection. The autoscaling group will not select instances with this setting for terminination during scale in eventsboolfalseno
<a name="input_regex_replace_chars"></a> regex_replace_charsTerraform regular expression (regex) string.<br/>Characters matching the regex will be removed from the ID elements.<br/>If not set, "/[^a-zA-Z0-9-]/" is used to remove all characters other than hyphens, letters and digits.stringnullno
<a name="input_scale_down_adjustment_type"></a> scale_down_adjustment_typeSpecifies whether the adjustment is an absolute number or a percentage of the current capacity. Valid values are ChangeInCapacity, ExactCapacity and PercentChangeInCapacitystring"ChangeInCapacity"no
<a name="input_scale_down_cooldown_seconds"></a> scale_down_cooldown_secondsThe amount of time, in seconds, after a scaling activity completes and before the next scaling activity can startnumber300no
<a name="input_scale_down_policy_type"></a> scale_down_policy_typeThe scaling policy type. Currently only SimpleScaling is supportedstring"SimpleScaling"no
<a name="input_scale_down_scaling_adjustment"></a> scale_down_scaling_adjustmentThe number of instances by which to scale. scale_down_scaling_adjustment determines the interpretation of this number (e.g. as an absolute number or as a percentage of the existing Auto Scaling group size). A positive increment adds to the current capacity and a negative value removes from the current capacitynumber-1no
<a name="input_scale_up_adjustment_type"></a> scale_up_adjustment_typeSpecifies whether the adjustment is an absolute number or a percentage of the current capacity. Valid values are ChangeInCapacity, ExactCapacity and PercentChangeInCapacitystring"ChangeInCapacity"no
<a name="input_scale_up_cooldown_seconds"></a> scale_up_cooldown_secondsThe amount of time, in seconds, after a scaling activity completes and before the next scaling activity can startnumber300no
<a name="input_scale_up_policy_type"></a> scale_up_policy_typeThe scaling policy type. Currently only SimpleScaling is supportedstring"SimpleScaling"no
<a name="input_scale_up_scaling_adjustment"></a> scale_up_scaling_adjustmentThe number of instances by which to scale. scale_up_adjustment_type determines the interpretation of this number (e.g. as an absolute number or as a percentage of the existing Auto Scaling group size). A positive increment adds to the current capacity and a negative value removes from the current capacitynumber1no
<a name="input_security_group_ids"></a> security_group_idsA list of associated security group IDslist(string)[]no
<a name="input_service_linked_role_arn"></a> service_linked_role_arnThe ARN of the service-linked role that the ASG will use to call other AWS servicesstring""no
<a name="input_stage"></a> stageID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release'stringnullno
<a name="input_subnet_ids"></a> subnet_idsA list of subnet IDs to launch resources inlist(string)n/ayes
<a name="input_suspended_processes"></a> suspended_processesA list of processes to suspend for the AutoScaling Group. The allowed values are Launch, Terminate, HealthCheck, ReplaceUnhealthy, AZRebalance, AlarmNotification, ScheduledActions, AddToLoadBalancer. Note that if you suspend either the Launch or Terminate process types, it can prevent your autoscaling group from functioning properly.list(string)[]no
<a name="input_tag_specifications_resource_types"></a> tag_specifications_resource_typesList of tag specification resource types to tag. Valid values are instance, volume, elastic-gpu and spot-instances-request.set(string)<pre>[<br/> "instance",<br/> "volume"<br/>]</pre>no
<a name="input_tags"></a> tagsAdditional tags (e.g. {'BusinessUnit': 'XYZ'}).<br/>Neither the tag keys nor the tag values will be modified by this module.map(string){}no
<a name="input_target_group_arns"></a> target_group_arnsA list of aws_alb_target_group ARNs, for use with Application Load Balancinglist(string)[]no
<a name="input_tenant"></a> tenantID element _(Rarely used, not included by default)_. A customer identifier, indicating who this instance of a resource is forstringnullno
<a name="input_termination_policies"></a> termination_policiesA list of policies to decide how the instances in the auto scale group should be terminated. The allowed values are OldestInstance, NewestInstance, OldestLaunchConfiguration, ClosestToNextInstanceHour, Defaultlist(string)<pre>[<br/> "Default"<br/>]</pre>no
<a name="input_update_default_version"></a> update_default_versionWhether to update Default version of Launch template each updateboolfalseno
<a name="input_user_data_base64"></a> user_data_base64The Base64-encoded user data to provide when launching the instancesstring""no
<a name="input_wait_for_capacity_timeout"></a> wait_for_capacity_timeoutA maximum duration that Terraform should wait for ASG instances to be healthy before timing out. Setting this to '0' causes Terraform to skip all Capacity Waiting behaviorstring"10m"no
<a name="input_wait_for_elb_capacity"></a> wait_for_elb_capacitySetting this will cause Terraform to wait for exactly this number of healthy instances in all attached load balancers on both create and update operations. Takes precedence over min_elb_capacity behaviornumber0no
<a name="input_warm_pool"></a> warm_poolIf this block is configured, add a Warm Pool to the specified Auto Scaling group. See warm_pool.<pre>object({<br/> pool_state = string<br/> min_size = number<br/> max_group_prepared_capacity = number<br/> })</pre>nullno

Outputs

NameDescription
<a name="output_autoscaling_group_arn"></a> autoscaling_group_arnARN of the AutoScaling Group
<a name="output_autoscaling_group_default_cooldown"></a> autoscaling_group_default_cooldownTime between a scaling activity and the succeeding scaling activity
<a name="output_autoscaling_group_desired_capacity"></a> autoscaling_group_desired_capacityThe number of Amazon EC2 instances that should be running in the group
<a name="output_autoscaling_group_health_check_grace_period"></a> autoscaling_group_health_check_grace_periodTime after instance comes into service before checking health
<a name="output_autoscaling_group_health_check_type"></a> autoscaling_group_health_check_typeEC2 or ELB. Controls how health checking is done
<a name="output_autoscaling_group_id"></a> autoscaling_group_idThe AutoScaling Group id
<a name="output_autoscaling_group_max_size"></a> autoscaling_group_max_sizeThe maximum size of the autoscale group
<a name="output_autoscaling_group_min_size"></a> autoscaling_group_min_sizeThe minimum size of the autoscale group
<a name="output_autoscaling_group_name"></a> autoscaling_group_nameThe AutoScaling Group name
<a name="output_autoscaling_group_tags"></a> autoscaling_group_tagsA list of tag settings associated with the AutoScaling Group
<a name="output_autoscaling_policy_scale_down_arn"></a> autoscaling_policy_scale_down_arnARN of the AutoScaling policy scale down
<a name="output_autoscaling_policy_scale_up_arn"></a> autoscaling_policy_scale_up_arnARN of the AutoScaling policy scale up
<a name="output_launch_template_arn"></a> launch_template_arnThe ARN of the launch template
<a name="output_launch_template_id"></a> launch_template_idThe ID of the launch template
<!-- markdownlint-restore -->

Related Projects

Check out these related projects.

[!TIP]

Use Terraform Reference Architectures for AWS

Use Cloud Posse's ready-to-go terraform architecture blueprints for AWS to get up and running quickly.

βœ… We build it together with your team.<br/> βœ… Your team owns everything.<br/> βœ… 100% Open Source and backed by fanatical support.<br/>

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-autoscale-group&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

<details><summary>πŸ“š <strong>Learn More</strong></summary> <br/>

Cloud Posse is the leading DevOps Accelerator for funded startups and enterprises.

Your team can operate like a pro today.

Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.

Day-0: Your Foundation for Success

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-autoscale-group&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

Day-2: Your Operational Mastery

<a href="https://cpco.io/commercial-support?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-autoscale-group&utm_content=commercial_support"><img alt="Request Quote" src="https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge"/></a>

</details>

✨ Contributing

This project is under active development, and we encourage contributions from our community.

Many thanks to our outstanding contributors:

<a href="https://github.com/cloudposse/terraform-aws-ec2-autoscale-group/graphs/contributors"> <img src="https://contrib.rocks/image?repo=cloudposse/terraform-aws-ec2-autoscale-group&max=24" /> </a>

For πŸ› bug reports & feature requests, please use the issue tracker.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

  1. Review our Code of Conduct and Contributor Guidelines.
  2. Fork the repo on GitHub
  3. Clone the project to your own machine
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

🌎 Slack Community

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

πŸ“° Newsletter

Sign up for our newsletter and join 3,000+ DevOps engineers, CTOs, and founders who get insider access to the latest DevOps trends, so you can always stay in the know. Dropped straight into your Inbox every week β€” and usually a 5-minute read.

πŸ“† Office Hours <a href="https://cloudposse.com/office-hours?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-autoscale-group&utm_content=office_hours"><img src="https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png" align="right" /></a>

Join us every Wednesday via Zoom for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a live Q&A that you can’t find anywhere else. It's FREE for everyone!

License

<a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge" alt="License"></a>

<details> <summary>Preamble to the Apache License, Version 2.0</summary> <br/> <br/>

Complete license is available in the LICENSE file.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.
</details>

Trademarks

All other trademarks referenced herein are the property of their respective owners.


Copyright Β© 2017-2024 Cloud Posse, LLC

<a href="https://cloudposse.com/readme/footer/link?utm_source=github&utm_medium=readme&utm_campaign=cloudposse/terraform-aws-ec2-autoscale-group&utm_content=readme_footer_link"><img alt="README footer" src="https://cloudposse.com/readme/footer/img"/></a>

<img alt="Beacon" width="0" src="https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/terraform-aws-ec2-autoscale-group?pixel&cs=github&cm=readme&an=terraform-aws-ec2-autoscale-group"/>