{"id":14957886,"url":"https://github.com/cloudposse/terraform-aws-eks-workers","last_synced_at":"2025-04-04T14:09:07.948Z","repository":{"id":34481330,"uuid":"140049828","full_name":"cloudposse/terraform-aws-eks-workers","owner":"cloudposse","description":"Terraform module to provision an AWS AutoScaling Group, IAM Role, and Security Group for EKS Workers","archived":false,"fork":false,"pushed_at":"2025-03-12T22:24:18.000Z","size":4549,"stargazers_count":92,"open_issues_count":7,"forks_count":75,"subscribers_count":18,"default_branch":"main","last_synced_at":"2025-03-28T13:11:03.772Z","etag":null,"topics":["aws","cluster","ec2","eks","hcl2","k8s","kubernetes","nodes","terraform","terraform-module","workers"],"latest_commit_sha":null,"homepage":"https://cloudposse.com/accelerate","language":"HCL","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cloudposse.png","metadata":{"funding":{"github":"cloudposse"},"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-07-07T03:34:16.000Z","updated_at":"2025-03-27T13:00:11.000Z","dependencies_parsed_at":"2024-01-01T04:27:45.621Z","dependency_job_id":"cb1dfd72-4417-4802-ba9b-108cec2769e7","html_url":"https://github.com/cloudposse/terraform-aws-eks-workers","commit_stats":{"total_commits":78,"total_committers":24,"mean_commits":3.25,"dds":0.7692307692307692,"last_synced_commit":"6b13f43e3d4a821b2d7e5392457b7ab752feb39a"},"previous_names":[],"tags_count":58,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-eks-workers","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-eks-workers/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-eks-workers/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-eks-workers/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudposse","download_url":"https://codeload.github.com/cloudposse/terraform-aws-eks-workers/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247190252,"owners_count":20898702,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","cluster","ec2","eks","hcl2","k8s","kubernetes","nodes","terraform","terraform-module","workers"],"created_at":"2024-09-24T13:15:46.346Z","updated_at":"2025-04-04T14:09:07.926Z","avatar_url":"https://github.com/cloudposse.png","language":"HCL","funding_links":["https://github.com/sponsors/cloudposse"],"categories":[],"sub_categories":[],"readme":"\n\n\u003c!-- markdownlint-disable --\u003e\n\u003ca href=\"https://cpco.io/homepage\"\u003e\u003cimg src=\"https://github.com/cloudposse/terraform-aws-eks-workers/blob/main/.github/banner.png?raw=true\" alt=\"Project Banner\"/\u003e\u003c/a\u003e\u003cbr/\u003e\n    \u003cp align=\"right\"\u003e\n\u003ca href=\"https://github.com/cloudposse/terraform-aws-eks-workers/releases/latest\"\u003e\u003cimg src=\"https://img.shields.io/github/release/cloudposse/terraform-aws-eks-workers.svg?style=for-the-badge\" alt=\"Latest Release\"/\u003e\u003c/a\u003e\u003ca href=\"https://github.com/cloudposse/terraform-aws-eks-workers/commits\"\u003e\u003cimg src=\"https://img.shields.io/github/last-commit/cloudposse/terraform-aws-eks-workers.svg?style=for-the-badge\" alt=\"Last Updated\"/\u003e\u003c/a\u003e\u003ca href=\"https://slack.cloudposse.com\"\u003e\u003cimg src=\"https://slack.cloudposse.com/for-the-badge.svg\" alt=\"Slack Community\"/\u003e\u003c/a\u003e\u003c/p\u003e\n\u003c!-- markdownlint-restore --\u003e\n\n\u003c!--\n\n\n\n\n  ** DO NOT EDIT THIS FILE\n  **\n  ** This file was automatically generated by the `cloudposse/build-harness`.\n  ** 1) Make all changes to `README.yaml`\n  ** 2) Run `make init` (you only need to do this once)\n  ** 3) Run`make readme` to rebuild this file.\n  **\n  ** (We maintain HUNDREDS of open source projects. This is how we maintain our sanity.)\n  **\n\n\n\n\n\n--\u003e\n\nTerraform module to provision AWS resources to run EC2 worker nodes for [Elastic Kubernetes Service](https://aws.amazon.com/eks/).\n\nInstantiate it multiple times to create many EKS worker node pools with specific settings such as GPUs, EC2 instance types, or autoscale parameters.\n\n\n\u003e [!TIP]\n\u003e #### 👽 Use Atmos with Terraform\n\u003e Cloud Posse uses [`atmos`](https://atmos.tools) to easily orchestrate multiple environments using Terraform. \u003cbr/\u003e\n\u003e Works with [Github Actions](https://atmos.tools/integrations/github-actions/), [Atlantis](https://atmos.tools/integrations/atlantis), or [Spacelift](https://atmos.tools/integrations/spacelift).\n\u003e\n\u003e \u003cdetails\u003e\n\u003e \u003csummary\u003e\u003cstrong\u003eWatch demo of using Atmos with Terraform\u003c/strong\u003e\u003c/summary\u003e\n\u003e \u003cimg src=\"https://github.com/cloudposse/atmos/blob/master/docs/demo.gif?raw=true\"/\u003e\u003cbr/\u003e\n\u003e \u003ci\u003eExample of running \u003ca href=\"https://atmos.tools\"\u003e\u003ccode\u003eatmos\u003c/code\u003e\u003c/a\u003e to manage infrastructure from our \u003ca href=\"https://atmos.tools/quick-start/\"\u003eQuick Start\u003c/a\u003e tutorial.\u003c/i\u003e\n\u003e \u003c/detalis\u003e\n\n\n## Introduction\n\nThe module provisions the following resources:\n\n- IAM Role and Instance Profile to allow Kubernetes nodes to access other AWS services\n- Security Group with rules for EKS workers to allow networking traffic\n- AutoScaling Group with Launch Template to configure and launch worker instances\n- 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.\nIf 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\"`.\n\n\n\n\n## Usage\n\n\nFor a complete example, see [examples/complete](examples/complete)\n\n```hcl\n  provider \"aws\" {\n    region = var.region\n  }\n\n  locals {\n    # The usage of the specific kubernetes.io/cluster/* resource tags below are required\n    # for EKS and Kubernetes to discover and manage networking resources\n    # https://www.terraform.io/docs/providers/aws/guides/eks-getting-started.html#base-vpc-networking\n    tags = merge(var.tags, map(\"kubernetes.io/cluster/${var.cluster_name}\", \"shared\"))\n  }\n\n  module \"vpc\" {\n    source  = \"cloudposse/vpc/aws\"\n    version = \"2.1.1\"\n\n    namespace = var.namespace\n    stage     = var.stage\n    name      = var.name\n\n    ipv4_primary_cidr_block = \"172.16.0.0/16\"\n    tags                    = local.tags\n  }\n\n  module \"subnets\" {\n    source  = \"cloudposse/dynamic-subnets/aws\"\n    version = \"2.4.1\"\n\n    namespace = var.namespace\n    stage     = var.stage\n    name      = var.name\n\n    availability_zones   = var.availability_zones\n    vpc_id               = module.vpc.vpc_id\n    igw_id               = [module.vpc.igw_id]\n    ipv4_cidr_block      = [module.vpc.vpc_cidr_block]\n    nat_gateway_enabled  = false\n    nat_instance_enabled = false\n    tags                 = local.tags\n  }\n\n  module \"eks_workers\" {\n    source = \"cloudposse/eks-workers/aws\"\n    # Cloud Posse recommends pinning every module to a specific version\n    # version     = \"x.x.x\"\n    namespace                          = var.namespace\n    stage                              = var.stage\n    name                               = var.name\n    instance_type                      = var.instance_type\n    vpc_id                             = module.vpc.vpc_id\n    subnet_ids                         = module.subnets.public_subnet_ids\n    health_check_type                  = var.health_check_type\n    min_size                           = var.min_size\n    max_size                           = var.max_size\n    wait_for_capacity_timeout          = var.wait_for_capacity_timeout\n    cluster_name                       = var.cluster_name\n    cluster_endpoint                   = var.cluster_endpoint\n    cluster_certificate_authority_data = var.cluster_certificate_authority_data\n    cluster_security_group_id          = var.cluster_security_group_id\n\n    # Auto-scaling policies and CloudWatch metric alarms\n    autoscaling_policies_enabled           = var.autoscaling_policies_enabled\n    cpu_utilization_high_threshold_percent = var.cpu_utilization_high_threshold_percent\n    cpu_utilization_low_threshold_percent  = var.cpu_utilization_low_threshold_percent\n  }\n```\n\n\u003e [!IMPORTANT]\n\u003e In Cloud Posse's examples, we avoid pinning modules to specific versions to prevent discrepancies between the documentation\n\u003e and the latest released versions. However, for your own projects, we strongly advise pinning each module to the exact version\n\u003e you're using. This practice ensures the stability of your infrastructure. Additionally, we recommend implementing a systematic\n\u003e approach for updating versions to avoid unexpected changes.\n\n\n\n\n\n\n\n\n\u003c!-- markdownlint-disable --\u003e\n## Makefile Targets\n```text\nAvailable targets:\n\n  help                                Help screen\n  help/all                            Display help for all targets\n  help/short                          This help short screen\n  lint                                Lint terraform code\n\n```\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- markdownlint-disable --\u003e\n## Requirements\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"requirement_terraform\"\u003e\u003c/a\u003e [terraform](#requirement\\_terraform) | \u003e= 1.0 |\n| \u003ca name=\"requirement_aws\"\u003e\u003c/a\u003e [aws](#requirement\\_aws) | \u003e= 5.16.0 |\n\n## Providers\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"provider_aws\"\u003e\u003c/a\u003e [aws](#provider\\_aws) | \u003e= 5.16.0 |\n\n## Modules\n\n| Name | Source | Version |\n|------|--------|---------|\n| \u003ca name=\"module_autoscale_group\"\u003e\u003c/a\u003e [autoscale\\_group](#module\\_autoscale\\_group) | cloudposse/ec2-autoscale-group/aws | 0.40.0 |\n| \u003ca name=\"module_label\"\u003e\u003c/a\u003e [label](#module\\_label) | cloudposse/label/null | 0.25.0 |\n| \u003ca name=\"module_this\"\u003e\u003c/a\u003e [this](#module\\_this) | cloudposse/label/null | 0.25.0 |\n\n## Resources\n\n| Name | Type |\n|------|------|\n| [aws_iam_instance_profile.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_instance_profile) | resource |\n| [aws_iam_role.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |\n| [aws_iam_role_policy_attachment.amazon_ec2_container_registry_read_only](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |\n| [aws_iam_role_policy_attachment.amazon_eks_cni_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |\n| [aws_iam_role_policy_attachment.amazon_eks_worker_node_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |\n| [aws_iam_role_policy_attachment.existing_policies_attach_to_eks_workers_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |\n| [aws_security_group.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group) | resource |\n| [aws_security_group_rule.egress](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |\n| [aws_security_group_rule.ingress_cidr_blocks](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |\n| [aws_security_group_rule.ingress_cluster](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |\n| [aws_security_group_rule.ingress_security_groups](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |\n| [aws_security_group_rule.ingress_self](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/security_group_rule) | resource |\n| [aws_ami.eks_worker](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) | data source |\n| [aws_iam_instance_profile.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_instance_profile) | data source |\n| [aws_iam_policy_document.assume_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |\n| [aws_partition.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/partition) | data source |\n\n## Inputs\n\n| Name | Description | Type | Default | Required |\n|------|-------------|------|---------|:--------:|\n| \u003ca name=\"input_additional_security_group_ids\"\u003e\u003c/a\u003e [additional\\_security\\_group\\_ids](#input\\_additional\\_security\\_group\\_ids) | Additional list of security groups that will be attached to the autoscaling group | `list(string)` | `[]` | no |\n| \u003ca name=\"input_additional_tag_map\"\u003e\u003c/a\u003e [additional\\_tag\\_map](#input\\_additional\\_tag\\_map) | Additional key-value pairs to add to each map in `tags_as_list_of_maps`. Not added to `tags` or `id`.\u003cbr/\u003eThis is for some rare cases where resources want additional configuration of tags\u003cbr/\u003eand therefore take a list of maps with tag key, value, and additional configuration. | `map(string)` | `{}` | no |\n| \u003ca name=\"input_after_cluster_joining_userdata\"\u003e\u003c/a\u003e [after\\_cluster\\_joining\\_userdata](#input\\_after\\_cluster\\_joining\\_userdata) | Additional commands to execute on each worker node after joining the EKS cluster (after executing the `bootstrap.sh` script). For mot info, see https://kubedex.com/90-days-of-aws-eks-in-production | `string` | `\"\"` | no |\n| \u003ca name=\"input_allowed_cidr_blocks\"\u003e\u003c/a\u003e [allowed\\_cidr\\_blocks](#input\\_allowed\\_cidr\\_blocks) | List of CIDR blocks to be allowed to connect to the worker nodes | `list(string)` | `[]` | no |\n| \u003ca name=\"input_allowed_security_groups\"\u003e\u003c/a\u003e [allowed\\_security\\_groups](#input\\_allowed\\_security\\_groups) | List of Security Group IDs to be allowed to connect to the worker nodes | `list(string)` | `[]` | no |\n| \u003ca name=\"input_associate_public_ip_address\"\u003e\u003c/a\u003e [associate\\_public\\_ip\\_address](#input\\_associate\\_public\\_ip\\_address) | Associate a public IP address with an instance in a VPC | `bool` | `false` | no |\n| \u003ca name=\"input_attributes\"\u003e\u003c/a\u003e [attributes](#input\\_attributes) | ID element. Additional attributes (e.g. `workers` or `cluster`) to add to `id`,\u003cbr/\u003ein the order they appear in the list. New attributes are appended to the\u003cbr/\u003eend of the list. The elements of the list are joined by the `delimiter`\u003cbr/\u003eand treated as a single ID element. | `list(string)` | `[]` | no |\n| \u003ca name=\"input_autoscaling_group_tags\"\u003e\u003c/a\u003e [autoscaling\\_group\\_tags](#input\\_autoscaling\\_group\\_tags) | Additional tags only for the autoscaling group, e.g. \"k8s.io/cluster-autoscaler/node-template/taint/dedicated\" = \"ci-cd:NoSchedule\". | `map(string)` | `{}` | no |\n| \u003ca name=\"input_autoscaling_policies_enabled\"\u003e\u003c/a\u003e [autoscaling\\_policies\\_enabled](#input\\_autoscaling\\_policies\\_enabled) | Whether to create `aws_autoscaling_policy` and `aws_cloudwatch_metric_alarm` resources to control Auto Scaling | `bool` | `true` | no |\n| \u003ca name=\"input_aws_iam_instance_profile_name\"\u003e\u003c/a\u003e [aws\\_iam\\_instance\\_profile\\_name](#input\\_aws\\_iam\\_instance\\_profile\\_name) | The name of the existing instance profile that will be used in autoscaling group for EKS workers. If empty will create a new instance profile. | `string` | `\"\"` | no |\n| \u003ca name=\"input_before_cluster_joining_userdata\"\u003e\u003c/a\u003e [before\\_cluster\\_joining\\_userdata](#input\\_before\\_cluster\\_joining\\_userdata) | Additional commands to execute on each worker node before joining the EKS cluster (before executing the `bootstrap.sh` script). For mot info, see https://kubedex.com/90-days-of-aws-eks-in-production | `string` | `\"\"` | no |\n| \u003ca name=\"input_block_device_mappings\"\u003e\u003c/a\u003e [block\\_device\\_mappings](#input\\_block\\_device\\_mappings) | Specify volumes to attach to the instance besides the volumes specified by the AMI | \u003cpre\u003elist(object({\u003cbr/\u003e    device_name  = string\u003cbr/\u003e    no_device    = bool\u003cbr/\u003e    virtual_name = string\u003cbr/\u003e    ebs = object({\u003cbr/\u003e      delete_on_termination = bool\u003cbr/\u003e      encrypted             = bool\u003cbr/\u003e      iops                  = number\u003cbr/\u003e      kms_key_id            = string\u003cbr/\u003e      snapshot_id           = string\u003cbr/\u003e      volume_size           = number\u003cbr/\u003e      volume_type           = string\u003cbr/\u003e    })\u003cbr/\u003e  }))\u003c/pre\u003e | `[]` | no |\n| \u003ca name=\"input_bootstrap_extra_args\"\u003e\u003c/a\u003e [bootstrap\\_extra\\_args](#input\\_bootstrap\\_extra\\_args) | Extra arguments to the `bootstrap.sh` script to enable `--enable-docker-bridge` or `--use-max-pods` | `string` | `\"\"` | no |\n| \u003ca name=\"input_cluster_certificate_authority_data\"\u003e\u003c/a\u003e [cluster\\_certificate\\_authority\\_data](#input\\_cluster\\_certificate\\_authority\\_data) | The base64 encoded certificate data required to communicate with the cluster | `string` | n/a | yes |\n| \u003ca name=\"input_cluster_endpoint\"\u003e\u003c/a\u003e [cluster\\_endpoint](#input\\_cluster\\_endpoint) | EKS cluster endpoint | `string` | n/a | yes |\n| \u003ca name=\"input_cluster_name\"\u003e\u003c/a\u003e [cluster\\_name](#input\\_cluster\\_name) | The name of the EKS cluster | `string` | n/a | yes |\n| \u003ca name=\"input_cluster_security_group_id\"\u003e\u003c/a\u003e [cluster\\_security\\_group\\_id](#input\\_cluster\\_security\\_group\\_id) | Security Group ID of the EKS cluster | `string` | n/a | yes |\n| \u003ca name=\"input_cluster_security_group_ingress_enabled\"\u003e\u003c/a\u003e [cluster\\_security\\_group\\_ingress\\_enabled](#input\\_cluster\\_security\\_group\\_ingress\\_enabled) | Whether to enable the EKS cluster Security Group as ingress to workers Security Group | `bool` | `true` | no |\n| \u003ca name=\"input_context\"\u003e\u003c/a\u003e [context](#input\\_context) | Single object for setting entire context at once.\u003cbr/\u003eSee description of individual variables for details.\u003cbr/\u003eLeave string and numeric variables as `null` to use default value.\u003cbr/\u003eIndividual variable settings (non-null) override settings in context object,\u003cbr/\u003eexcept for attributes, tags, and additional\\_tag\\_map, which are merged. | `any` | \u003cpre\u003e{\u003cbr/\u003e  \"additional_tag_map\": {},\u003cbr/\u003e  \"attributes\": [],\u003cbr/\u003e  \"delimiter\": null,\u003cbr/\u003e  \"descriptor_formats\": {},\u003cbr/\u003e  \"enabled\": true,\u003cbr/\u003e  \"environment\": null,\u003cbr/\u003e  \"id_length_limit\": null,\u003cbr/\u003e  \"label_key_case\": null,\u003cbr/\u003e  \"label_order\": [],\u003cbr/\u003e  \"label_value_case\": null,\u003cbr/\u003e  \"labels_as_tags\": [\u003cbr/\u003e    \"unset\"\u003cbr/\u003e  ],\u003cbr/\u003e  \"name\": null,\u003cbr/\u003e  \"namespace\": null,\u003cbr/\u003e  \"regex_replace_chars\": null,\u003cbr/\u003e  \"stage\": null,\u003cbr/\u003e  \"tags\": {},\u003cbr/\u003e  \"tenant\": null\u003cbr/\u003e}\u003c/pre\u003e | no |\n| \u003ca name=\"input_cpu_utilization_high_evaluation_periods\"\u003e\u003c/a\u003e [cpu\\_utilization\\_high\\_evaluation\\_periods](#input\\_cpu\\_utilization\\_high\\_evaluation\\_periods) | The number of periods over which data is compared to the specified threshold | `number` | `2` | no |\n| \u003ca name=\"input_cpu_utilization_high_period_seconds\"\u003e\u003c/a\u003e [cpu\\_utilization\\_high\\_period\\_seconds](#input\\_cpu\\_utilization\\_high\\_period\\_seconds) | The period in seconds over which the specified statistic is applied | `number` | `300` | no |\n| \u003ca name=\"input_cpu_utilization_high_statistic\"\u003e\u003c/a\u003e [cpu\\_utilization\\_high\\_statistic](#input\\_cpu\\_utilization\\_high\\_statistic) | The statistic to apply to the alarm's associated metric. Either of the following is supported: `SampleCount`, `Average`, `Sum`, `Minimum`, `Maximum` | `string` | `\"Average\"` | no |\n| \u003ca name=\"input_cpu_utilization_high_threshold_percent\"\u003e\u003c/a\u003e [cpu\\_utilization\\_high\\_threshold\\_percent](#input\\_cpu\\_utilization\\_high\\_threshold\\_percent) | The value against which the specified statistic is compared | `number` | `90` | no |\n| \u003ca name=\"input_cpu_utilization_low_evaluation_periods\"\u003e\u003c/a\u003e [cpu\\_utilization\\_low\\_evaluation\\_periods](#input\\_cpu\\_utilization\\_low\\_evaluation\\_periods) | The number of periods over which data is compared to the specified threshold | `number` | `2` | no |\n| \u003ca name=\"input_cpu_utilization_low_period_seconds\"\u003e\u003c/a\u003e [cpu\\_utilization\\_low\\_period\\_seconds](#input\\_cpu\\_utilization\\_low\\_period\\_seconds) | The period in seconds over which the specified statistic is applied | `number` | `300` | no |\n| \u003ca name=\"input_cpu_utilization_low_statistic\"\u003e\u003c/a\u003e [cpu\\_utilization\\_low\\_statistic](#input\\_cpu\\_utilization\\_low\\_statistic) | The statistic to apply to the alarm's associated metric. Either of the following is supported: `SampleCount`, `Average`, `Sum`, `Minimum`, `Maximum` | `string` | `\"Average\"` | no |\n| \u003ca name=\"input_cpu_utilization_low_threshold_percent\"\u003e\u003c/a\u003e [cpu\\_utilization\\_low\\_threshold\\_percent](#input\\_cpu\\_utilization\\_low\\_threshold\\_percent) | The value against which the specified statistic is compared | `number` | `10` | no |\n| \u003ca name=\"input_credit_specification\"\u003e\u003c/a\u003e [credit\\_specification](#input\\_credit\\_specification) | Customize the credit specification of the instances | \u003cpre\u003eobject({\u003cbr/\u003e    cpu_credits = string\u003cbr/\u003e  })\u003c/pre\u003e | `null` | no |\n| \u003ca name=\"input_default_cooldown\"\u003e\u003c/a\u003e [default\\_cooldown](#input\\_default\\_cooldown) | The amount of time, in seconds, after a scaling activity completes before another scaling activity can start | `number` | `300` | no |\n| \u003ca name=\"input_delimiter\"\u003e\u003c/a\u003e [delimiter](#input\\_delimiter) | Delimiter to be used between ID elements.\u003cbr/\u003eDefaults to `-` (hyphen). Set to `\"\"` to use no delimiter at all. | `string` | `null` | no |\n| \u003ca name=\"input_descriptor_formats\"\u003e\u003c/a\u003e [descriptor\\_formats](#input\\_descriptor\\_formats) | Describe additional descriptors to be output in the `descriptors` output map.\u003cbr/\u003eMap of maps. Keys are names of descriptors. Values are maps of the form\u003cbr/\u003e`{\u003cbr/\u003e   format = string\u003cbr/\u003e   labels = list(string)\u003cbr/\u003e}`\u003cbr/\u003e(Type is `any` so the map values can later be enhanced to provide additional options.)\u003cbr/\u003e`format` is a Terraform format string to be passed to the `format()` function.\u003cbr/\u003e`labels` is a list of labels, in order, to pass to `format()` function.\u003cbr/\u003eLabel values will be normalized before being passed to `format()` so they will be\u003cbr/\u003eidentical to how they appear in `id`.\u003cbr/\u003eDefault is `{}` (`descriptors` output will be empty). | `any` | `{}` | no |\n| \u003ca name=\"input_disable_api_termination\"\u003e\u003c/a\u003e [disable\\_api\\_termination](#input\\_disable\\_api\\_termination) | If `true`, enables EC2 Instance Termination Protection | `bool` | `false` | no |\n| \u003ca name=\"input_ebs_optimized\"\u003e\u003c/a\u003e [ebs\\_optimized](#input\\_ebs\\_optimized) | If true, the launched EC2 instance will be EBS-optimized | `bool` | `false` | no |\n| \u003ca name=\"input_eks_worker_ami_name_filter\"\u003e\u003c/a\u003e [eks\\_worker\\_ami\\_name\\_filter](#input\\_eks\\_worker\\_ami\\_name\\_filter) | AMI name filter to lookup the most recent EKS AMI if `image_id` is not provided | `string` | `\"amazon-eks-node-*\"` | no |\n| \u003ca name=\"input_eks_worker_ami_name_regex\"\u003e\u003c/a\u003e [eks\\_worker\\_ami\\_name\\_regex](#input\\_eks\\_worker\\_ami\\_name\\_regex) | A regex string to apply to the AMI list returned by AWS | `string` | `\"^amazon-eks-node-[0-9,.]+-v[0-9]{8}$\"` | no |\n| \u003ca name=\"input_elastic_gpu_specifications\"\u003e\u003c/a\u003e [elastic\\_gpu\\_specifications](#input\\_elastic\\_gpu\\_specifications) | Specifications of Elastic GPU to attach to the instances | \u003cpre\u003eobject({\u003cbr/\u003e    type = string\u003cbr/\u003e  })\u003c/pre\u003e | `null` | no |\n| \u003ca name=\"input_enable_monitoring\"\u003e\u003c/a\u003e [enable\\_monitoring](#input\\_enable\\_monitoring) | Enable/disable detailed monitoring | `bool` | `true` | no |\n| \u003ca name=\"input_enabled\"\u003e\u003c/a\u003e [enabled](#input\\_enabled) | Set to false to prevent the module from creating any resources | `bool` | `null` | no |\n| \u003ca name=\"input_enabled_metrics\"\u003e\u003c/a\u003e [enabled\\_metrics](#input\\_enabled\\_metrics) | A list of metrics to collect. The allowed values are `GroupMinSize`, `GroupMaxSize`, `GroupDesiredCapacity`, `GroupInServiceInstances`, `GroupPendingInstances`, `GroupStandbyInstances`, `GroupTerminatingInstances`, `GroupTotalInstances` | `list(string)` | \u003cpre\u003e[\u003cbr/\u003e  \"GroupMinSize\",\u003cbr/\u003e  \"GroupMaxSize\",\u003cbr/\u003e  \"GroupDesiredCapacity\",\u003cbr/\u003e  \"GroupInServiceInstances\",\u003cbr/\u003e  \"GroupPendingInstances\",\u003cbr/\u003e  \"GroupStandbyInstances\",\u003cbr/\u003e  \"GroupTerminatingInstances\",\u003cbr/\u003e  \"GroupTotalInstances\"\u003cbr/\u003e]\u003c/pre\u003e | no |\n| \u003ca name=\"input_environment\"\u003e\u003c/a\u003e [environment](#input\\_environment) | ID element. Usually used for region e.g. 'uw2', 'us-west-2', OR role 'prod', 'staging', 'dev', 'UAT' | `string` | `null` | no |\n| \u003ca name=\"input_force_delete\"\u003e\u003c/a\u003e [force\\_delete](#input\\_force\\_delete) | Allows 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 dangling | `bool` | `false` | no |\n| \u003ca name=\"input_health_check_grace_period\"\u003e\u003c/a\u003e [health\\_check\\_grace\\_period](#input\\_health\\_check\\_grace\\_period) | Time (in seconds) after instance comes into service before checking health | `number` | `300` | no |\n| \u003ca name=\"input_health_check_type\"\u003e\u003c/a\u003e [health\\_check\\_type](#input\\_health\\_check\\_type) | Controls how health checking is done. Valid values are `EC2` or `ELB` | `string` | `\"EC2\"` | no |\n| \u003ca name=\"input_id_length_limit\"\u003e\u003c/a\u003e [id\\_length\\_limit](#input\\_id\\_length\\_limit) | Limit `id` to this many characters (minimum 6).\u003cbr/\u003eSet to `0` for unlimited length.\u003cbr/\u003eSet to `null` for keep the existing setting, which defaults to `0`.\u003cbr/\u003eDoes not affect `id_full`. | `number` | `null` | no |\n| \u003ca name=\"input_image_id\"\u003e\u003c/a\u003e [image\\_id](#input\\_image\\_id) | EC2 image ID to launch. If not provided, the module will lookup the most recent EKS AMI. See https://docs.aws.amazon.com/eks/latest/userguide/eks-optimized-ami.html for more details on EKS-optimized images | `string` | `\"\"` | no |\n| \u003ca name=\"input_instance_initiated_shutdown_behavior\"\u003e\u003c/a\u003e [instance\\_initiated\\_shutdown\\_behavior](#input\\_instance\\_initiated\\_shutdown\\_behavior) | Shutdown behavior for the instances. Can be `stop` or `terminate` | `string` | `\"terminate\"` | no |\n| \u003ca name=\"input_instance_market_options\"\u003e\u003c/a\u003e [instance\\_market\\_options](#input\\_instance\\_market\\_options) | The market (purchasing) option for the instances | \u003cpre\u003eobject({\u003cbr/\u003e    market_type = string\u003cbr/\u003e    spot_options = object({\u003cbr/\u003e      block_duration_minutes         = number\u003cbr/\u003e      instance_interruption_behavior = string\u003cbr/\u003e      max_price                      = number\u003cbr/\u003e      spot_instance_type             = string\u003cbr/\u003e      valid_until                    = string\u003cbr/\u003e    })\u003cbr/\u003e  })\u003c/pre\u003e | `null` | no |\n| \u003ca name=\"input_instance_type\"\u003e\u003c/a\u003e [instance\\_type](#input\\_instance\\_type) | Instance type to launch | `string` | n/a | yes |\n| \u003ca name=\"input_key_name\"\u003e\u003c/a\u003e [key\\_name](#input\\_key\\_name) | SSH key name that should be used for the instance | `string` | `\"\"` | no |\n| \u003ca name=\"input_kubelet_extra_args\"\u003e\u003c/a\u003e [kubelet\\_extra\\_args](#input\\_kubelet\\_extra\\_args) | Extra arguments to pass to kubelet, like \"--register-with-taints=dedicated=ci-cd:NoSchedule --node-labels=purpose=ci-worker\" | `string` | `\"\"` | no |\n| \u003ca name=\"input_label_key_case\"\u003e\u003c/a\u003e [label\\_key\\_case](#input\\_label\\_key\\_case) | Controls the letter case of the `tags` keys (label names) for tags generated by this module.\u003cbr/\u003eDoes not affect keys of tags passed in via the `tags` input.\u003cbr/\u003ePossible values: `lower`, `title`, `upper`.\u003cbr/\u003eDefault value: `title`. | `string` | `null` | no |\n| \u003ca name=\"input_label_order\"\u003e\u003c/a\u003e [label\\_order](#input\\_label\\_order) | The order in which the labels (ID elements) appear in the `id`.\u003cbr/\u003eDefaults to [\"namespace\", \"environment\", \"stage\", \"name\", \"attributes\"].\u003cbr/\u003eYou can omit any of the 6 labels (\"tenant\" is the 6th), but at least one must be present. | `list(string)` | `null` | no |\n| \u003ca name=\"input_label_value_case\"\u003e\u003c/a\u003e [label\\_value\\_case](#input\\_label\\_value\\_case) | Controls the letter case of ID elements (labels) as included in `id`,\u003cbr/\u003eset as tag values, and output by this module individually.\u003cbr/\u003eDoes not affect values of tags passed in via the `tags` input.\u003cbr/\u003ePossible values: `lower`, `title`, `upper` and `none` (no transformation).\u003cbr/\u003eSet this to `title` and set `delimiter` to `\"\"` to yield Pascal Case IDs.\u003cbr/\u003eDefault value: `lower`. | `string` | `null` | no |\n| \u003ca name=\"input_labels_as_tags\"\u003e\u003c/a\u003e [labels\\_as\\_tags](#input\\_labels\\_as\\_tags) | Set of labels (ID elements) to include as tags in the `tags` output.\u003cbr/\u003eDefault is to include all labels.\u003cbr/\u003eTags with empty values will not be included in the `tags` output.\u003cbr/\u003eSet to `[]` to suppress all generated tags.\u003cbr/\u003e**Notes:**\u003cbr/\u003e  The value of the `name` tag, if included, will be the `id`, not the `name`.\u003cbr/\u003e  Unlike other `null-label` inputs, the initial setting of `labels_as_tags` cannot be\u003cbr/\u003e  changed in later chained modules. Attempts to change it will be silently ignored. | `set(string)` | \u003cpre\u003e[\u003cbr/\u003e  \"default\"\u003cbr/\u003e]\u003c/pre\u003e | no |\n| \u003ca name=\"input_load_balancers\"\u003e\u003c/a\u003e [load\\_balancers](#input\\_load\\_balancers) | A list of elastic load balancer names to add to the autoscaling group. Only valid for classic load balancers. For ALBs, use `target_group_arns` instead | `list(string)` | `[]` | no |\n| \u003ca name=\"input_max_instance_lifetime\"\u003e\u003c/a\u003e [max\\_instance\\_lifetime](#input\\_max\\_instance\\_lifetime) | The 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 seconds | `number` | `null` | no |\n| \u003ca name=\"input_max_size\"\u003e\u003c/a\u003e [max\\_size](#input\\_max\\_size) | The maximum size of the autoscale group | `number` | n/a | yes |\n| \u003ca name=\"input_metadata_http_endpoint_enabled\"\u003e\u003c/a\u003e [metadata\\_http\\_endpoint\\_enabled](#input\\_metadata\\_http\\_endpoint\\_enabled) | Set false to disable the Instance Metadata Service. | `bool` | `true` | no |\n| \u003ca name=\"input_metadata_http_put_response_hop_limit\"\u003e\u003c/a\u003e [metadata\\_http\\_put\\_response\\_hop\\_limit](#input\\_metadata\\_http\\_put\\_response\\_hop\\_limit) | The desired HTTP PUT response hop limit (between 1 and 64) for Instance Metadata Service requests.\u003cbr/\u003eThe default is `2` to support containerized workloads. | `number` | `2` | no |\n| \u003ca name=\"input_metadata_http_tokens_required\"\u003e\u003c/a\u003e [metadata\\_http\\_tokens\\_required](#input\\_metadata\\_http\\_tokens\\_required) | Set true to require IMDS session tokens, disabling Instance Metadata Service Version 1. | `bool` | `true` | no |\n| \u003ca name=\"input_metrics_granularity\"\u003e\u003c/a\u003e [metrics\\_granularity](#input\\_metrics\\_granularity) | The granularity to associate with the metrics to collect. The only valid value is 1Minute | `string` | `\"1Minute\"` | no |\n| \u003ca name=\"input_min_elb_capacity\"\u003e\u003c/a\u003e [min\\_elb\\_capacity](#input\\_min\\_elb\\_capacity) | Setting 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 changes | `number` | `0` | no |\n| \u003ca name=\"input_min_size\"\u003e\u003c/a\u003e [min\\_size](#input\\_min\\_size) | The minimum size of the autoscale group | `number` | n/a | yes |\n| \u003ca name=\"input_mixed_instances_policy\"\u003e\u003c/a\u003e [mixed\\_instances\\_policy](#input\\_mixed\\_instances\\_policy) | policy 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 | \u003cpre\u003eobject({\u003cbr/\u003e    instances_distribution = object({\u003cbr/\u003e      on_demand_allocation_strategy            = string\u003cbr/\u003e      on_demand_base_capacity                  = number\u003cbr/\u003e      on_demand_percentage_above_base_capacity = number\u003cbr/\u003e      spot_allocation_strategy                 = string\u003cbr/\u003e      spot_instance_pools                      = number\u003cbr/\u003e      spot_max_price                           = string\u003cbr/\u003e    })\u003cbr/\u003e    override = list(object({\u003cbr/\u003e      instance_type     = string\u003cbr/\u003e      weighted_capacity = number\u003cbr/\u003e    }))\u003cbr/\u003e  })\u003c/pre\u003e | `null` | no |\n| \u003ca name=\"input_name\"\u003e\u003c/a\u003e [name](#input\\_name) | ID element. Usually the component or solution name, e.g. 'app' or 'jenkins'.\u003cbr/\u003eThis is the only ID element not also included as a `tag`.\u003cbr/\u003eThe \"name\" tag is set to the full `id` string. There is no tag with the value of the `name` input. | `string` | `null` | no |\n| \u003ca name=\"input_namespace\"\u003e\u003c/a\u003e [namespace](#input\\_namespace) | ID element. Usually an abbreviation of your organization name, e.g. 'eg' or 'cp', to help ensure generated IDs are globally unique | `string` | `null` | no |\n| \u003ca name=\"input_placement\"\u003e\u003c/a\u003e [placement](#input\\_placement) | The placement specifications of the instances | \u003cpre\u003eobject({\u003cbr/\u003e    affinity          = string\u003cbr/\u003e    availability_zone = string\u003cbr/\u003e    group_name        = string\u003cbr/\u003e    host_id           = string\u003cbr/\u003e    tenancy           = string\u003cbr/\u003e  })\u003c/pre\u003e | `null` | no |\n| \u003ca name=\"input_placement_group\"\u003e\u003c/a\u003e [placement\\_group](#input\\_placement\\_group) | The name of the placement group into which you'll launch your instances, if any | `string` | `\"\"` | no |\n| \u003ca name=\"input_protect_from_scale_in\"\u003e\u003c/a\u003e [protect\\_from\\_scale\\_in](#input\\_protect\\_from\\_scale\\_in) | Allows setting instance protection. The autoscaling group will not select instances with this setting for terminination during scale in events | `bool` | `false` | no |\n| \u003ca name=\"input_regex_replace_chars\"\u003e\u003c/a\u003e [regex\\_replace\\_chars](#input\\_regex\\_replace\\_chars) | Terraform regular expression (regex) string.\u003cbr/\u003eCharacters matching the regex will be removed from the ID elements.\u003cbr/\u003eIf not set, `\"/[^a-zA-Z0-9-]/\"` is used to remove all characters other than hyphens, letters and digits. | `string` | `null` | no |\n| \u003ca name=\"input_scale_down_adjustment_type\"\u003e\u003c/a\u003e [scale\\_down\\_adjustment\\_type](#input\\_scale\\_down\\_adjustment\\_type) | Specifies whether the adjustment is an absolute number or a percentage of the current capacity. Valid values are `ChangeInCapacity`, `ExactCapacity` and `PercentChangeInCapacity` | `string` | `\"ChangeInCapacity\"` | no |\n| \u003ca name=\"input_scale_down_cooldown_seconds\"\u003e\u003c/a\u003e [scale\\_down\\_cooldown\\_seconds](#input\\_scale\\_down\\_cooldown\\_seconds) | The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start | `number` | `300` | no |\n| \u003ca name=\"input_scale_down_policy_type\"\u003e\u003c/a\u003e [scale\\_down\\_policy\\_type](#input\\_scale\\_down\\_policy\\_type) | The scalling policy type, either `SimpleScaling`, `StepScaling` or `TargetTrackingScaling` | `string` | `\"SimpleScaling\"` | no |\n| \u003ca name=\"input_scale_down_scaling_adjustment\"\u003e\u003c/a\u003e [scale\\_down\\_scaling\\_adjustment](#input\\_scale\\_down\\_scaling\\_adjustment) | The 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 capacity | `number` | `-1` | no |\n| \u003ca name=\"input_scale_up_adjustment_type\"\u003e\u003c/a\u003e [scale\\_up\\_adjustment\\_type](#input\\_scale\\_up\\_adjustment\\_type) | Specifies whether the adjustment is an absolute number or a percentage of the current capacity. Valid values are `ChangeInCapacity`, `ExactCapacity` and `PercentChangeInCapacity` | `string` | `\"ChangeInCapacity\"` | no |\n| \u003ca name=\"input_scale_up_cooldown_seconds\"\u003e\u003c/a\u003e [scale\\_up\\_cooldown\\_seconds](#input\\_scale\\_up\\_cooldown\\_seconds) | The amount of time, in seconds, after a scaling activity completes and before the next scaling activity can start | `number` | `300` | no |\n| \u003ca name=\"input_scale_up_policy_type\"\u003e\u003c/a\u003e [scale\\_up\\_policy\\_type](#input\\_scale\\_up\\_policy\\_type) | The scalling policy type, either `SimpleScaling`, `StepScaling` or `TargetTrackingScaling` | `string` | `\"SimpleScaling\"` | no |\n| \u003ca name=\"input_scale_up_scaling_adjustment\"\u003e\u003c/a\u003e [scale\\_up\\_scaling\\_adjustment](#input\\_scale\\_up\\_scaling\\_adjustment) | The 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 capacity | `number` | `1` | no |\n| \u003ca name=\"input_service_linked_role_arn\"\u003e\u003c/a\u003e [service\\_linked\\_role\\_arn](#input\\_service\\_linked\\_role\\_arn) | The ARN of the service-linked role that the ASG will use to call other AWS services | `string` | `\"\"` | no |\n| \u003ca name=\"input_stage\"\u003e\u003c/a\u003e [stage](#input\\_stage) | ID element. Usually used to indicate role, e.g. 'prod', 'staging', 'source', 'build', 'test', 'deploy', 'release' | `string` | `null` | no |\n| \u003ca name=\"input_subnet_ids\"\u003e\u003c/a\u003e [subnet\\_ids](#input\\_subnet\\_ids) | A list of subnet IDs to launch resources in | `list(string)` | n/a | yes |\n| \u003ca name=\"input_suspended_processes\"\u003e\u003c/a\u003e [suspended\\_processes](#input\\_suspended\\_processes) | A 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 |\n| \u003ca name=\"input_tags\"\u003e\u003c/a\u003e [tags](#input\\_tags) | Additional tags (e.g. `{'BusinessUnit': 'XYZ'}`).\u003cbr/\u003eNeither the tag keys nor the tag values will be modified by this module. | `map(string)` | `{}` | no |\n| \u003ca name=\"input_target_group_arns\"\u003e\u003c/a\u003e [target\\_group\\_arns](#input\\_target\\_group\\_arns) | A list of aws\\_alb\\_target\\_group ARNs, for use with Application Load Balancing | `list(string)` | `[]` | no |\n| \u003ca name=\"input_tenant\"\u003e\u003c/a\u003e [tenant](#input\\_tenant) | ID element \\_(Rarely used, not included by default)\\_. A customer identifier, indicating who this instance of a resource is for | `string` | `null` | no |\n| \u003ca name=\"input_termination_policies\"\u003e\u003c/a\u003e [termination\\_policies](#input\\_termination\\_policies) | 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` | `list(string)` | \u003cpre\u003e[\u003cbr/\u003e  \"Default\"\u003cbr/\u003e]\u003c/pre\u003e | no |\n| \u003ca name=\"input_use_custom_image_id\"\u003e\u003c/a\u003e [use\\_custom\\_image\\_id](#input\\_use\\_custom\\_image\\_id) | If set to `true`, will use variable `image_id` for the EKS workers inside autoscaling group | `bool` | `false` | no |\n| \u003ca name=\"input_use_existing_aws_iam_instance_profile\"\u003e\u003c/a\u003e [use\\_existing\\_aws\\_iam\\_instance\\_profile](#input\\_use\\_existing\\_aws\\_iam\\_instance\\_profile) | If set to `true`, will use variable `aws_iam_instance_profile_name` to run EKS workers using an existing AWS instance profile that was created outside of this module, workaround for error like `count cannot be computed` | `bool` | `false` | no |\n| \u003ca name=\"input_use_existing_security_group\"\u003e\u003c/a\u003e [use\\_existing\\_security\\_group](#input\\_use\\_existing\\_security\\_group) | If set to `true`, will use variable `workers_security_group_id` to run EKS workers using an existing security group that was created outside of this module, workaround for errors like `count cannot be computed` | `bool` | `false` | no |\n| \u003ca name=\"input_vpc_id\"\u003e\u003c/a\u003e [vpc\\_id](#input\\_vpc\\_id) | VPC ID for the EKS cluster | `string` | n/a | yes |\n| \u003ca name=\"input_wait_for_capacity_timeout\"\u003e\u003c/a\u003e [wait\\_for\\_capacity\\_timeout](#input\\_wait\\_for\\_capacity\\_timeout) | A 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 behavior | `string` | `\"10m\"` | no |\n| \u003ca name=\"input_wait_for_elb_capacity\"\u003e\u003c/a\u003e [wait\\_for\\_elb\\_capacity](#input\\_wait\\_for\\_elb\\_capacity) | Setting 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` behavior | `number` | `0` | no |\n| \u003ca name=\"input_workers_role_policy_arns\"\u003e\u003c/a\u003e [workers\\_role\\_policy\\_arns](#input\\_workers\\_role\\_policy\\_arns) | List of policy ARNs that will be attached to the workers default role on creation | `list(string)` | `[]` | no |\n| \u003ca name=\"input_workers_role_policy_arns_count\"\u003e\u003c/a\u003e [workers\\_role\\_policy\\_arns\\_count](#input\\_workers\\_role\\_policy\\_arns\\_count) | Count of policy ARNs that will be attached to the workers default role on creation. Needed to prevent Terraform error `count can't be computed` | `number` | `0` | no |\n| \u003ca name=\"input_workers_security_group_id\"\u003e\u003c/a\u003e [workers\\_security\\_group\\_id](#input\\_workers\\_security\\_group\\_id) | The name of the existing security group that will be used in autoscaling group for EKS workers. If empty, a new security group will be created | `string` | `\"\"` | no |\n\n## Outputs\n\n| Name | Description |\n|------|-------------|\n| \u003ca name=\"output_autoscaling_group_arn\"\u003e\u003c/a\u003e [autoscaling\\_group\\_arn](#output\\_autoscaling\\_group\\_arn) | ARN of the AutoScaling Group |\n| \u003ca name=\"output_autoscaling_group_default_cooldown\"\u003e\u003c/a\u003e [autoscaling\\_group\\_default\\_cooldown](#output\\_autoscaling\\_group\\_default\\_cooldown) | Time between a scaling activity and the succeeding scaling activity |\n| \u003ca name=\"output_autoscaling_group_desired_capacity\"\u003e\u003c/a\u003e [autoscaling\\_group\\_desired\\_capacity](#output\\_autoscaling\\_group\\_desired\\_capacity) | The number of Amazon EC2 instances that should be running in the group |\n| \u003ca name=\"output_autoscaling_group_health_check_grace_period\"\u003e\u003c/a\u003e [autoscaling\\_group\\_health\\_check\\_grace\\_period](#output\\_autoscaling\\_group\\_health\\_check\\_grace\\_period) | Time after instance comes into service before checking health |\n| \u003ca name=\"output_autoscaling_group_health_check_type\"\u003e\u003c/a\u003e [autoscaling\\_group\\_health\\_check\\_type](#output\\_autoscaling\\_group\\_health\\_check\\_type) | `EC2` or `ELB`. Controls how health checking is done |\n| \u003ca name=\"output_autoscaling_group_id\"\u003e\u003c/a\u003e [autoscaling\\_group\\_id](#output\\_autoscaling\\_group\\_id) | The AutoScaling Group ID |\n| \u003ca name=\"output_autoscaling_group_max_size\"\u003e\u003c/a\u003e [autoscaling\\_group\\_max\\_size](#output\\_autoscaling\\_group\\_max\\_size) | The maximum size of the AutoScaling Group |\n| \u003ca name=\"output_autoscaling_group_min_size\"\u003e\u003c/a\u003e [autoscaling\\_group\\_min\\_size](#output\\_autoscaling\\_group\\_min\\_size) | The minimum size of the AutoScaling Group |\n| \u003ca name=\"output_autoscaling_group_name\"\u003e\u003c/a\u003e [autoscaling\\_group\\_name](#output\\_autoscaling\\_group\\_name) | The AutoScaling Group name |\n| \u003ca name=\"output_autoscaling_group_tags\"\u003e\u003c/a\u003e [autoscaling\\_group\\_tags](#output\\_autoscaling\\_group\\_tags) | A list of tag settings associated with the AutoScaling Group |\n| \u003ca name=\"output_launch_template_arn\"\u003e\u003c/a\u003e [launch\\_template\\_arn](#output\\_launch\\_template\\_arn) | ARN of the launch template |\n| \u003ca name=\"output_launch_template_id\"\u003e\u003c/a\u003e [launch\\_template\\_id](#output\\_launch\\_template\\_id) | The ID of the launch template |\n| \u003ca name=\"output_security_group_arn\"\u003e\u003c/a\u003e [security\\_group\\_arn](#output\\_security\\_group\\_arn) | ARN of the worker nodes Security Group |\n| \u003ca name=\"output_security_group_id\"\u003e\u003c/a\u003e [security\\_group\\_id](#output\\_security\\_group\\_id) | ID of the worker nodes Security Group |\n| \u003ca name=\"output_security_group_name\"\u003e\u003c/a\u003e [security\\_group\\_name](#output\\_security\\_group\\_name) | Name of the worker nodes Security Group |\n| \u003ca name=\"output_workers_role_arn\"\u003e\u003c/a\u003e [workers\\_role\\_arn](#output\\_workers\\_role\\_arn) | ARN of the worker nodes IAM role |\n| \u003ca name=\"output_workers_role_name\"\u003e\u003c/a\u003e [workers\\_role\\_name](#output\\_workers\\_role\\_name) | Name of the worker nodes IAM role |\n\u003c!-- markdownlint-restore --\u003e\n\n\n## Related Projects\n\nCheck out these related projects.\n\n- [terraform-aws-ec2-autoscale-group](https://github.com/cloudposse/terraform-aws-ec2-autoscale-group) - Terraform module to provision Auto Scaling Group and Launch Template on AWS\n- [terraform-aws-ecs-container-definition](https://github.com/cloudposse/terraform-aws-ecs-container-definition) - Terraform module to generate well-formed JSON documents (container definitions) that are passed to the  aws_ecs_task_definition Terraform resource\n- [terraform-aws-ecs-alb-service-task](https://github.com/cloudposse/terraform-aws-ecs-alb-service-task) - Terraform module which implements an ECS service which exposes a web service via ALB\n- [terraform-aws-ecs-web-app](https://github.com/cloudposse/terraform-aws-ecs-web-app) - Terraform module that implements a web app on ECS and supports autoscaling, CI/CD, monitoring, ALB integration, and much more\n- [terraform-aws-ecs-codepipeline](https://github.com/cloudposse/terraform-aws-ecs-codepipeline) - Terraform module for CI/CD with AWS Code Pipeline and Code Build for ECS\n- [terraform-aws-ecs-cloudwatch-autoscaling](https://github.com/cloudposse/terraform-aws-ecs-cloudwatch-autoscaling) - Terraform module to autoscale ECS Service based on CloudWatch metrics\n- [terraform-aws-ecs-cloudwatch-sns-alarms](https://github.com/cloudposse/terraform-aws-ecs-cloudwatch-sns-alarms) - Terraform module to create CloudWatch Alarms on ECS Service level metrics\n- [terraform-aws-ec2-instance](https://github.com/cloudposse/terraform-aws-ec2-instance) - Terraform module for providing a general purpose EC2 instance\n- [terraform-aws-ec2-instance-group](https://github.com/cloudposse/terraform-aws-ec2-instance-group) - Terraform module for provisioning multiple general purpose EC2 hosts for stateful applications\n\n\n\u003e [!TIP]\n\u003e #### Use Terraform Reference Architectures for AWS\n\u003e\n\u003e Use Cloud Posse's ready-to-go [terraform architecture blueprints](https://cloudposse.com/reference-architecture/) for AWS to get up and running quickly.\n\u003e\n\u003e ✅ We build it together with your team.\u003cbr/\u003e\n\u003e ✅ Your team owns everything.\u003cbr/\u003e\n\u003e ✅ 100% Open Source and backed by fanatical support.\u003cbr/\u003e\n\u003e\n\u003e \u003ca href=\"https://cpco.io/commercial-support?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-eks-workers\u0026utm_content=commercial_support\"\u003e\u003cimg alt=\"Request Quote\" src=\"https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge\"/\u003e\u003c/a\u003e\n\u003e \u003cdetails\u003e\u003csummary\u003e📚 \u003cstrong\u003eLearn More\u003c/strong\u003e\u003c/summary\u003e\n\u003e\n\u003e \u003cbr/\u003e\n\u003e\n\u003e Cloud Posse is the leading [**DevOps Accelerator**](https://cpco.io/commercial-support?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-eks-workers\u0026utm_content=commercial_support) for funded startups and enterprises.\n\u003e\n\u003e *Your team can operate like a pro today.*\n\u003e\n\u003e Ensure that your team succeeds by using Cloud Posse's proven process and turnkey blueprints. Plus, we stick around until you succeed.\n\u003e #### Day-0:  Your Foundation for Success\n\u003e - **Reference Architecture.** You'll get everything you need from the ground up built using 100% infrastructure as code.\n\u003e - **Deployment Strategy.** Adopt a proven deployment strategy with GitHub Actions, enabling automated, repeatable, and reliable software releases.\n\u003e - **Site Reliability Engineering.** Gain total visibility into your applications and services with Datadog, ensuring high availability and performance.\n\u003e - **Security Baseline.** Establish a secure environment from the start, with built-in governance, accountability, and comprehensive audit logs, safeguarding your operations.\n\u003e - **GitOps.** Empower your team to manage infrastructure changes confidently and efficiently through Pull Requests, leveraging the full power of GitHub Actions.\n\u003e\n\u003e \u003ca href=\"https://cpco.io/commercial-support?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-eks-workers\u0026utm_content=commercial_support\"\u003e\u003cimg alt=\"Request Quote\" src=\"https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge\"/\u003e\u003c/a\u003e\n\u003e\n\u003e #### Day-2: Your Operational Mastery\n\u003e - **Training.** Equip your team with the knowledge and skills to confidently manage the infrastructure, ensuring long-term success and self-sufficiency.\n\u003e - **Support.** Benefit from a seamless communication over Slack with our experts, ensuring you have the support you need, whenever you need it.\n\u003e - **Troubleshooting.** Access expert assistance to quickly resolve any operational challenges, minimizing downtime and maintaining business continuity.\n\u003e - **Code Reviews.** Enhance your team’s code quality with our expert feedback, fostering continuous improvement and collaboration.\n\u003e - **Bug Fixes.** Rely on our team to troubleshoot and resolve any issues, ensuring your systems run smoothly.\n\u003e - **Migration Assistance.** Accelerate your migration process with our dedicated support, minimizing disruption and speeding up time-to-value.\n\u003e - **Customer Workshops.** Engage with our team in weekly workshops, gaining insights and strategies to continuously improve and innovate.\n\u003e\n\u003e \u003ca href=\"https://cpco.io/commercial-support?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-eks-workers\u0026utm_content=commercial_support\"\u003e\u003cimg alt=\"Request Quote\" src=\"https://img.shields.io/badge/request%20quote-success.svg?style=for-the-badge\"/\u003e\u003c/a\u003e\n\u003e \u003c/details\u003e\n\n## ✨ Contributing\n\nThis project is under active development, and we encourage contributions from our community.\n\n\n\nMany thanks to our outstanding contributors:\n\n\u003ca href=\"https://github.com/cloudposse/terraform-aws-eks-workers/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=cloudposse/terraform-aws-eks-workers\u0026max=24\" /\u003e\n\u003c/a\u003e\n\nFor 🐛 bug reports \u0026 feature requests, please use the [issue tracker](https://github.com/cloudposse/terraform-aws-eks-workers/issues).\n\nIn general, PRs are welcome. We follow the typical \"fork-and-pull\" Git workflow.\n 1. Review our [Code of Conduct](https://github.com/cloudposse/terraform-aws-eks-workers/?tab=coc-ov-file#code-of-conduct) and [Contributor Guidelines](https://github.com/cloudposse/.github/blob/main/CONTRIBUTING.md).\n 2. **Fork** the repo on GitHub\n 3. **Clone** the project to your own machine\n 4. **Commit** changes to your own branch\n 5. **Push** your work back up to your fork\n 6. Submit a **Pull Request** so that we can review your changes\n\n**NOTE:** Be sure to merge the latest changes from \"upstream\" before making a pull request!\n\n### 🌎 Slack Community\n\nJoin our [Open Source Community](https://cpco.io/slack?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-eks-workers\u0026utm_content=slack) 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.\n\n### 📰 Newsletter\n\nSign up for [our newsletter](https://cpco.io/newsletter?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-eks-workers\u0026utm_content=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.\nDropped straight into your Inbox every week — and usually a 5-minute read.\n\n### 📆 Office Hours \u003ca href=\"https://cloudposse.com/office-hours?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-eks-workers\u0026utm_content=office_hours\"\u003e\u003cimg src=\"https://img.cloudposse.com/fit-in/200x200/https://cloudposse.com/wp-content/uploads/2019/08/Powered-by-Zoom.png\" align=\"right\" /\u003e\u003c/a\u003e\n\n[Join us every Wednesday via Zoom](https://cloudposse.com/office-hours?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-eks-workers\u0026utm_content=office_hours) for your weekly dose of insider DevOps trends, AWS news and Terraform insights, all sourced from our SweetOps community, plus a _live Q\u0026A_ that you can’t find anywhere else.\nIt's **FREE** for everyone!\n## License\n\n\u003ca href=\"https://opensource.org/licenses/Apache-2.0\"\u003e\u003cimg src=\"https://img.shields.io/badge/License-Apache%202.0-blue.svg?style=for-the-badge\" alt=\"License\"\u003e\u003c/a\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003ePreamble to the Apache License, Version 2.0\u003c/summary\u003e\n\u003cbr/\u003e\n\u003cbr/\u003e\n\nComplete license is available in the [`LICENSE`](LICENSE) file.\n\n```text\nLicensed to the Apache Software Foundation (ASF) under one\nor more contributor license agreements.  See the NOTICE file\ndistributed with this work for additional information\nregarding copyright ownership.  The ASF licenses this file\nto you under the Apache License, Version 2.0 (the\n\"License\"); you may not use this file except in compliance\nwith the License.  You may obtain a copy of the License at\n\n  https://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing,\nsoftware distributed under the License is distributed on an\n\"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\nKIND, either express or implied.  See the License for the\nspecific language governing permissions and limitations\nunder the License.\n```\n\u003c/details\u003e\n\n## Trademarks\n\nAll other trademarks referenced herein are the property of their respective owners.\n\n\n---\nCopyright © 2017-2024 [Cloud Posse, LLC](https://cpco.io/copyright)\n\n\n\u003ca href=\"https://cloudposse.com/readme/footer/link?utm_source=github\u0026utm_medium=readme\u0026utm_campaign=cloudposse/terraform-aws-eks-workers\u0026utm_content=readme_footer_link\"\u003e\u003cimg alt=\"README footer\" src=\"https://cloudposse.com/readme/footer/img\"/\u003e\u003c/a\u003e\n\n\u003cimg alt=\"Beacon\" width=\"0\" src=\"https://ga-beacon.cloudposse.com/UA-76589703-4/cloudposse/terraform-aws-eks-workers?pixel\u0026cs=github\u0026cm=readme\u0026an=terraform-aws-eks-workers\"/\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudposse%2Fterraform-aws-eks-workers","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudposse%2Fterraform-aws-eks-workers","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudposse%2Fterraform-aws-eks-workers/lists"}