{"id":15155975,"url":"https://github.com/cloudposse/terraform-aws-eks-node-group","last_synced_at":"2025-04-12T19:45:45.702Z","repository":{"id":38303559,"uuid":"226152588","full_name":"cloudposse/terraform-aws-eks-node-group","owner":"cloudposse","description":"Terraform module to provision a fully managed AWS EKS Node Group","archived":false,"fork":false,"pushed_at":"2025-02-09T18:26:55.000Z","size":3495,"stargazers_count":97,"open_issues_count":5,"forks_count":131,"subscribers_count":18,"default_branch":"main","last_synced_at":"2025-04-03T22:11:10.764Z","etag":null,"topics":["aws","eks","hcl2","k8s","kubernetes","node-pool","terraform","terraform-module","terratest"],"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":"security-group.tf","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-12-05T17:15:59.000Z","updated_at":"2025-04-02T20:29:34.000Z","dependencies_parsed_at":"2023-02-01T08:31:04.875Z","dependency_job_id":"5a66c65f-27fc-45e7-8d0c-cf43e8b110a3","html_url":"https://github.com/cloudposse/terraform-aws-eks-node-group","commit_stats":{"total_commits":101,"total_committers":37,"mean_commits":2.72972972972973,"dds":0.8415841584158416,"last_synced_commit":"dd31dae6c25838be1f4feb383e72568984ca4584"},"previous_names":[],"tags_count":83,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-eks-node-group","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-eks-node-group/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-eks-node-group/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cloudposse%2Fterraform-aws-eks-node-group/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cloudposse","download_url":"https://codeload.github.com/cloudposse/terraform-aws-eks-node-group/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248625490,"owners_count":21135513,"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","eks","hcl2","k8s","kubernetes","node-pool","terraform","terraform-module","terratest"],"created_at":"2024-09-26T19:00:42.783Z","updated_at":"2025-04-12T19:45:45.678Z","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-node-group/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-node-group/releases/latest\"\u003e\u003cimg src=\"https://img.shields.io/github/release/cloudposse/terraform-aws-eks-node-group.svg?style=for-the-badge\" alt=\"Latest Release\"/\u003e\u003c/a\u003e\u003ca href=\"https://github.com/cloudposse/terraform-aws-eks-node-group/commits\"\u003e\u003cimg src=\"https://img.shields.io/github/last-commit/cloudposse/terraform-aws-eks-node-group.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 an EKS Managed Node Group for [Elastic Kubernetes Service](https://aws.amazon.com/eks/).\n\nInstantiate it multiple times to create EKS Managed Node Groups with specific settings such as GPUs, EC2 instance types, or autoscale parameters.\n\n**IMPORTANT:** When SSH access is enabled without specifying a source security group, this module provisions `EKS Node Group` nodes that are globally accessible by SSH (22) port. Normally, AWS recommends that no security group allows unrestricted ingress access to port 22 .\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/main/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\nThis module creates an [EKS Managed Node Group](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html)\nfor an [EKS](https://aws.amazon.com/eks/) cluster.\nIt assumes you have already created an EKS cluster, but you can create the cluster and the node group in the\nsame Terraform configuration. See our\n[full-featured root module (a.k.a. component) `eks/cluster`](https://github.com/cloudposse/terraform-aws-components/tree/main/modules/eks/cluster)\nfor an example of how to do that.\n\n### Launch Templates\n\nThis module always uses a [launch template](https://docs.aws.amazon.com/autoscaling/ec2/userguide/launch-templates.html)\nto create the node group. You can create your own launch template and\npass in its ID, or else this module will create one for you.\n\nThe AWS default for EKS is that if the launch template is updated, the existing nodes will not be affected. Only\nnew instances added to the node group would get the changes specified in the new launch template. In contrast,\nwhen the launch template changes, this module can immediately create a new node group from the new launch template\nto replace the old one.\n\nSee the inputs `create_before_destroy` and `immediately_apply_lt_changes` for details about how to control this behavior.\n\n### Operating system differences\n\nCurrently, EKS supports 4 Operating Systems: Amazon Linux 2, Amazon Linux 2023, Bottlerocket, and Windows Server.\nThis module supports all 4 OSes, but support for detailed configuration of the nodes varies by OS. The 4 inputs:\n\n1. `before_cluster_joining_userdata`\n2. `kubelet_additional_options`\n3. `bootstrap_additional_options`\n4. `after_cluster_joining_userdata`\n\nare fully supported for Amazon Linux 2 and Windows, and take advantage of the [bootstrap.sh](https://github.com/awslabs/amazon-eks-ami/blob/main/templates/al2/runtime/bootstrap.sh)\nsupplied on those AMIs. **NONE** of these inputs are supported on Bottlerocket. On AL2023, only the first 2 are supported.\n\nNote that for all OSes, you can supply the complete `userdata` contents, which will be untouched by this module, via `userdata_override_base64`.\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-node-group\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-node-group\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-node-group\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-node-group\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\n## Usage\n\n\n### Major Changes (breaking and otherwise)\n\nWith the v3.0.0 release of this module, support for Amazon Linux 2023 (AL2023) has\nbeen added, and some breaking changes have been made. Please see the\n[release notes](https://github.com/cloudposse/terraform-aws-eks-node-group/releases/tag/3.0.0)\nfor details.\n\nWith the v2.0.0 (a.k.a. v0.25.0) release of this module, it has undergone major breaking\nchanges and added new features. Please see the [migration](docs/migration-v1-v2.md)\ndocument for details.\n\n\nFor a complete example, see [examples/complete](examples/complete).\n\nFor automated tests of the complete example using [bats](https://github.com/bats-core/bats-core) and [Terratest](https://github.com/gruntwork-io/terratest) (which tests and deploys the example on AWS),\nsee [test](test).\n\n### Sources of Information\n\n- The code examples below are manually updated and have a tendency to fall out of sync with actual code,\nparticularly with respect to usage of other modules. Do not rely on them.\n- The documentation on this page about this module's inputs, outputs, and compliance is all automatically\ngenerated and is up-to-date as of the release date. After the code itself, this is your best source of information.\n- The code in [examples/complete](examples/complete) is automatically tested before every release,\nso that is a good place to look for verified example code. Keep in mind, however, it is code for testing, so\nit may not represent average use cases or best practices.\n- Of course, the READMEs and `examples/complete` directories in the other modules' GitHub repos\nare more authoritative with respect to how to use those modules than this README is.\n\n#### Example Code\n\n```hcl\nprovider \"aws\" {\n  region = var.region\n}\n\nmodule \"label\" {\n  source = \"cloudposse/label/null\"\n  # Cloud Posse recommends pinning every module to a specific version\n  # version  = \"x.x.x\"\n\n  namespace  = var.namespace\n  name       = var.name\n  stage      = var.stage\n  delimiter  = var.delimiter\n  attributes = [\"cluster\"]\n  tags       = var.tags\n}\n\nlocals {\n  # Prior to Kubernetes 1.19, 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 = { \"kubernetes.io/cluster/${module.label.id}\" = \"shared\" }\n}\n\nmodule \"vpc\" {\n  source = \"cloudposse/vpc/aws\"\n  # Cloud Posse recommends pinning every module to a specific version\n  # version = \"1.x.x\"\n\n  cidr_block = \"172.16.0.0/16\"\n\n  tags    = local.tags\n  context = module.label.context\n}\n\nmodule \"subnets\" {\n  source = \"cloudposse/dynamic-subnets/aws\"\n  # Cloud Posse recommends pinning every module to a specific version\n  # version = \"2.x.x\"\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  = true\n  nat_instance_enabled = false\n\n  tags    = local.tags\n  context = module.label.context\n}\n\nmodule \"eks_cluster\" {\n  source = \"cloudposse/eks-cluster/aws\"\n  # Cloud Posse recommends pinning every module to a specific version\n  # version = \"4.x.x\"\n\n  vpc_id     = module.vpc.vpc_id\n  subnet_ids = module.subnets.public_subnet_ids\n\n  kubernetes_version    = var.kubernetes_version\n  oidc_provider_enabled = true\n\n  context = module.label.context\n}\n\nmodule \"eks_node_group\" {\n  source = \"cloudposse/eks-node-group/aws\"\n  # Cloud Posse recommends pinning every module to a specific version\n  # version     = \"3.x.x\"\n\n  instance_types        = [var.instance_type]\n  subnet_ids            = module.subnets.public_subnet_ids\n  min_size              = var.min_size\n  max_size              = var.max_size\n  cluster_name          = module.eks_cluster.eks_cluster_id\n  create_before_destroy = true\n  kubernetes_version    = var.kubernetes_version == null || var.kubernetes_version == \"\" ? [] : [var.kubernetes_version]\n\n  # Enable the Kubernetes cluster auto-scaler to find the auto-scaling group\n  cluster_autoscaler_enabled = var.autoscaling_policies_enabled\n\n  context = module.label.context\n\n  # Ensure the cluster is fully created before trying to add the node group\n  module_depends_on = [module.eks_cluster.kubernetes_config_map_id]\n}\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## Windows Managed Node groups\n\nWindows managed node-groups have a few pre-requisites.\n\n* Your cluster must contain at least one linux based worker node\n* Your EKS Cluster must have the `AmazonEKSVPCResourceController` and `AmazonEKSClusterPolicy` policies attached\n* Your cluster must have a config-map called amazon-vpc-cni with the following content\n\n```yaml\napiVersion: v1\nkind: ConfigMap\nmetadata:\nname: amazon-vpc-cni\nnamespace: kube-system\ndata:\nenable-windows-ipam: \"true\"\n```\n\n* Windows nodes will automatically be tainted\n\n```yaml\nkubernetes_taints = [{\n  key    = \"WINDOWS\"\n  value  = \"true\"\n  effect = \"NO_SCHEDULE\"\n}]\n```\n* Any pods that target Windows will need to have the following attributes set in their manifest\n\n```yaml\n  nodeSelector:\n    kubernetes.io/os: windows\n    kubernetes.io/arch: amd64\n```\n\nhttps://docs.aws.amazon.com/eks/latest/userguide/windows-support.html\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.3.0 |\n| \u003ca name=\"requirement_aws\"\u003e\u003c/a\u003e [aws](#requirement\\_aws) | \u003e= 5.8 |\n| \u003ca name=\"requirement_null\"\u003e\u003c/a\u003e [null](#requirement\\_null) | \u003e= 3.0 |\n| \u003ca name=\"requirement_random\"\u003e\u003c/a\u003e [random](#requirement\\_random) | \u003e= 2.0 |\n\n## Providers\n\n| Name | Version |\n|------|---------|\n| \u003ca name=\"provider_aws\"\u003e\u003c/a\u003e [aws](#provider\\_aws) | \u003e= 5.8 |\n| \u003ca name=\"provider_null\"\u003e\u003c/a\u003e [null](#provider\\_null) | \u003e= 3.0 |\n| \u003ca name=\"provider_random\"\u003e\u003c/a\u003e [random](#provider\\_random) | \u003e= 2.0 |\n\n## Modules\n\n| Name | Source | Version |\n|------|--------|---------|\n| \u003ca name=\"module_label\"\u003e\u003c/a\u003e [label](#module\\_label) | cloudposse/label/null | 0.25.0 |\n| \u003ca name=\"module_ssh_access\"\u003e\u003c/a\u003e [ssh\\_access](#module\\_ssh\\_access) | cloudposse/security-group/aws | 2.2.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_eks_node_group.cbd](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/eks_node_group) | resource |\n| [aws_eks_node_group.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/eks_node_group) | resource |\n| [aws_iam_policy.ipv6_eks_cni_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_policy) | 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_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_for_eks_workers_role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |\n| [aws_iam_role_policy_attachment.ipv6_eks_cni_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |\n| [aws_launch_template.default](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/launch_template) | resource |\n| [null_resource.seq](https://registry.terraform.io/providers/hashicorp/null/latest/docs/resources/resource) | resource |\n| [random_pet.cbd](https://registry.terraform.io/providers/hashicorp/random/latest/docs/resources/pet) | resource |\n| [aws_ami.windows_ami](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ami) | data source |\n| [aws_eks_cluster.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/eks_cluster) | 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_iam_policy_document.ipv6_eks_cni_policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/iam_policy_document) | data source |\n| [aws_launch_template.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/launch_template) | data source |\n| [aws_partition.current](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/partition) | data source |\n| [aws_ssm_parameter.ami_id](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/ssm_parameter) | data source |\n\n## Inputs\n\n| Name | Description | Type | Default | Required |\n|------|-------------|------|---------|:--------:|\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 `bash` commands to execute on each worker node after joining the EKS cluster (after executing the `bootstrap.sh` script). For more info, see https://kubedex.com/90-days-of-aws-eks-in-production | `list(string)` | `[]` | no |\n| \u003ca name=\"input_ami_image_id\"\u003e\u003c/a\u003e [ami\\_image\\_id](#input\\_ami\\_image\\_id) | AMI to use, overriding other AMI specifications, but must match `ami_type`. Ignored if `launch_template_id` is supplied. | `list(string)` | `[]` | no |\n| \u003ca name=\"input_ami_release_version\"\u003e\u003c/a\u003e [ami\\_release\\_version](#input\\_ami\\_release\\_version) | The EKS AMI \"release version\" to use. Defaults to the latest recommended version.\u003cbr/\u003eFor Amazon Linux, it is the \"Release version\" from [Amazon AMI Releases](https://github.com/awslabs/amazon-eks-ami/releases)\u003cbr/\u003eFor Bottlerocket, it is the release tag from [Bottlerocket Releases](https://github.com/bottlerocket-os/bottlerocket/releases) without the \"v\" prefix.\u003cbr/\u003eFor Windows, it is \"AMI version\" from [AWS docs](https://docs.aws.amazon.com/eks/latest/userguide/eks-ami-versions-windows.html).\u003cbr/\u003eNote that unlike AMI names, release versions never include the \"v\" prefix.\u003cbr/\u003eExamples:\u003cbr/\u003e  AL2: 1.29.3-20240531\u003cbr/\u003e  Bottlerocket: 1.2.0 or 1.2.0-ccf1b754\u003cbr/\u003e  Windows: 1.29-2024.04.09 | `list(string)` | `[]` | no |\n| \u003ca name=\"input_ami_type\"\u003e\u003c/a\u003e [ami\\_type](#input\\_ami\\_type) | Type of Amazon Machine Image (AMI) associated with the EKS Node Group.\u003cbr/\u003eDefaults to `AL2_x86_64`. Valid values: `AL2_x86_64, AL2_x86_64_GPU, AL2_ARM_64, CUSTOM, BOTTLEROCKET_ARM_64, BOTTLEROCKET_x86_64, BOTTLEROCKET_ARM_64_NVIDIA, BOTTLEROCKET_x86_64_NVIDIA, WINDOWS_CORE_2019_x86_64, WINDOWS_FULL_2019_x86_64, WINDOWS_CORE_2022_x86_64, WINDOWS_FULL_2022_x86_64, AL2023_x86_64_STANDARD, AL2023_ARM_64_STANDARD, AL2023_x86_64_NEURON, AL2023_x86_64_NVIDIA`. | `string` | `\"AL2_x86_64\"` | no |\n| \u003ca name=\"input_associate_cluster_security_group\"\u003e\u003c/a\u003e [associate\\_cluster\\_security\\_group](#input\\_associate\\_cluster\\_security\\_group) | When true, associate the default cluster security group to the nodes. If disabled the EKS managed security group will not\u003cbr/\u003ebe associated to the nodes and you will need to provide another security group that allows the nodes to communicate with\u003cbr/\u003ethe EKS control plane. Be aware that if no `associated_security_group_ids` or `ssh_access_security_group_ids` are provided,\u003cbr/\u003ethen the nodes will have no inbound or outbound rules. | `bool` | `true` | no |\n| \u003ca name=\"input_associated_security_group_ids\"\u003e\u003c/a\u003e [associated\\_security\\_group\\_ids](#input\\_associated\\_security\\_group\\_ids) | A list of IDs of Security Groups to associate the node group with, in addition to the EKS' created security group.\u003cbr/\u003eThese security groups will not be modified. | `list(string)` | `[]` | 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_before_cluster_joining_userdata\"\u003e\u003c/a\u003e [before\\_cluster\\_joining\\_userdata](#input\\_before\\_cluster\\_joining\\_userdata) | Additional `bash` commands to execute on each worker node before joining the EKS cluster (before executing the `bootstrap.sh` script). For more info, see https://kubedex.com/90-days-of-aws-eks-in-production | `list(string)` | `[]` | no |\n| \u003ca name=\"input_block_device_map\"\u003e\u003c/a\u003e [block\\_device\\_map](#input\\_block\\_device\\_map) | Map of block device name specification, see [launch\\_template.block-devices](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/launch_template#block-devices). | \u003cpre\u003emap(object({\u003cbr/\u003e    no_device    = optional(bool, null)\u003cbr/\u003e    virtual_name = optional(string, null)\u003cbr/\u003e    ebs = optional(object({\u003cbr/\u003e      delete_on_termination = optional(bool, true)\u003cbr/\u003e      encrypted             = optional(bool, true)\u003cbr/\u003e      iops                  = optional(number, null)\u003cbr/\u003e      kms_key_id            = optional(string, null)\u003cbr/\u003e      snapshot_id           = optional(string, null)\u003cbr/\u003e      throughput            = optional(number, null)\u003cbr/\u003e      volume_size           = optional(number, 20)\u003cbr/\u003e      volume_type           = optional(string, \"gp3\")\u003cbr/\u003e    }))\u003cbr/\u003e  }))\u003c/pre\u003e | \u003cpre\u003e{\u003cbr/\u003e  \"/dev/xvda\": {\u003cbr/\u003e    \"ebs\": {}\u003cbr/\u003e  }\u003cbr/\u003e}\u003c/pre\u003e | no |\n| \u003ca name=\"input_block_device_mappings\"\u003e\u003c/a\u003e [block\\_device\\_mappings](#input\\_block\\_device\\_mappings) | DEPRECATED: Use `block_device_map` instead.\u003cbr/\u003eList of block device mappings for the launch template.\u003cbr/\u003eEach list element is an object with a `device_name` key and\u003cbr/\u003eany keys supported by the `ebs` block of `launch_template`. | `list(any)` | `null` | no |\n| \u003ca name=\"input_bootstrap_additional_options\"\u003e\u003c/a\u003e [bootstrap\\_additional\\_options](#input\\_bootstrap\\_additional\\_options) | Additional options to bootstrap.sh. DO NOT include `--kubelet-additional-args`, use `kubelet_additional_options` var instead. Not used with AL2023 AMI types. | `list(string)` | `[]` | no |\n| \u003ca name=\"input_capacity_type\"\u003e\u003c/a\u003e [capacity\\_type](#input\\_capacity\\_type) | Type of capacity associated with the EKS Node Group. Valid values: \"ON\\_DEMAND\", \"SPOT\", or `null`.\u003cbr/\u003eTerraform will only perform drift detection if a configuration value is provided. | `string` | `null` | no |\n| \u003ca name=\"input_cluster_autoscaler_enabled\"\u003e\u003c/a\u003e [cluster\\_autoscaler\\_enabled](#input\\_cluster\\_autoscaler\\_enabled) | OBSOLETE. Used to add support for the Kubernetes Cluster Autoscaler, but additional support is no longer needed. | `bool` | `null` | no |\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_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_options\"\u003e\u003c/a\u003e [cpu\\_options](#input\\_cpu\\_options) | Configuration for the [`cpu_options` Configuration Block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/launch_template#cpu_options) of the launch template.\u003cbr/\u003eLeave list empty for defaults. Pass list with single object with attributes matching the `cpu_options` block to configure it.\u003cbr/\u003eNote that this configures the launch template only. Some elements will be ignored by the Auto Scaling Group\u003cbr/\u003ethat actually launches instances. Consult AWS documentation for details. | `list(any)` | `[]` | no |\n| \u003ca name=\"input_create_before_destroy\"\u003e\u003c/a\u003e [create\\_before\\_destroy](#input\\_create\\_before\\_destroy) | If `true` (default), a new node group will be created before destroying the old one.\u003cbr/\u003eIf `false`, the old node group will be destroyed first, causing downtime.\u003cbr/\u003eChanging this setting will always cause node group to be replaced. | `bool` | `true` | 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_desired_size\"\u003e\u003c/a\u003e [desired\\_size](#input\\_desired\\_size) | Initial desired number of worker nodes (external changes ignored) | `number` | n/a | yes |\n| \u003ca name=\"input_detailed_monitoring_enabled\"\u003e\u003c/a\u003e [detailed\\_monitoring\\_enabled](#input\\_detailed\\_monitoring\\_enabled) | The launched EC2 instance will have detailed monitoring enabled. Defaults to false | `bool` | `false` | no |\n| \u003ca name=\"input_ebs_optimized\"\u003e\u003c/a\u003e [ebs\\_optimized](#input\\_ebs\\_optimized) | Set `false` to disable EBS optimization | `bool` | `true` | no |\n| \u003ca name=\"input_ec2_ssh_key_name\"\u003e\u003c/a\u003e [ec2\\_ssh\\_key\\_name](#input\\_ec2\\_ssh\\_key\\_name) | SSH key pair name to use to access the worker nodes | `list(string)` | `[]` | 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_enclave_enabled\"\u003e\u003c/a\u003e [enclave\\_enabled](#input\\_enclave\\_enabled) | Set to `true` to enable Nitro Enclaves on the instance. | `bool` | `false` | 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_update_version\"\u003e\u003c/a\u003e [force\\_update\\_version](#input\\_force\\_update\\_version) | When updating the Kubernetes version, force Pods to be removed even if PodDisruptionBudget or taint/toleration issues would otherwise prevent them from being removed (and cause the update to fail) | `bool` | `false` | 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_immediately_apply_lt_changes\"\u003e\u003c/a\u003e [immediately\\_apply\\_lt\\_changes](#input\\_immediately\\_apply\\_lt\\_changes) | When `true`, any change to the launch template will be applied immediately.\u003cbr/\u003eWhen `false`, the changes will only affect new nodes when they are launched.\u003cbr/\u003eWhen `null` (default) this input takes the value of `create_before_destroy`.\u003cbr/\u003e**NOTE:** Setting this to `false` does not guarantee that other changes,\u003cbr/\u003esuch as `ami_type`, will not cause changes to be applied immediately. | `bool` | `null` | no |\n| \u003ca name=\"input_instance_types\"\u003e\u003c/a\u003e [instance\\_types](#input\\_instance\\_types) | Instance types to use for this node group (up to 20). Defaults to [\"t3.medium\"].\u003cbr/\u003eMust be empty if the launch template configured by `launch_template_id` specifies an instance type. | `list(string)` | \u003cpre\u003e[\u003cbr/\u003e  \"t3.medium\"\u003cbr/\u003e]\u003c/pre\u003e | no |\n| \u003ca name=\"input_kubelet_additional_options\"\u003e\u003c/a\u003e [kubelet\\_additional\\_options](#input\\_kubelet\\_additional\\_options) | Additional flags to pass to kubelet.\u003cbr/\u003eDO NOT include `--node-labels` or `--node-taints`,\u003cbr/\u003euse `kubernetes_labels` and `kubernetes_taints` to specify those.\" | `list(string)` | `[]` | no |\n| \u003ca name=\"input_kubernetes_labels\"\u003e\u003c/a\u003e [kubernetes\\_labels](#input\\_kubernetes\\_labels) | Key-value mapping of Kubernetes labels. Only labels that are applied with the EKS API are managed by this argument.\u003cbr/\u003eOther Kubernetes labels applied to the EKS Node Group will not be managed. | `map(string)` | `{}` | no |\n| \u003ca name=\"input_kubernetes_taints\"\u003e\u003c/a\u003e [kubernetes\\_taints](#input\\_kubernetes\\_taints) | List of `key`, `value`, `effect` objects representing Kubernetes taints.\u003cbr/\u003e`effect` must be one of `NO_SCHEDULE`, `NO_EXECUTE`, or `PREFER_NO_SCHEDULE`.\u003cbr/\u003e`key` and `effect` are required, `value` may be null. | \u003cpre\u003elist(object({\u003cbr/\u003e    key    = string\u003cbr/\u003e    value  = optional(string)\u003cbr/\u003e    effect = string\u003cbr/\u003e  }))\u003c/pre\u003e | `[]` | no |\n| \u003ca name=\"input_kubernetes_version\"\u003e\u003c/a\u003e [kubernetes\\_version](#input\\_kubernetes\\_version) | Kubernetes version. Defaults to EKS Cluster Kubernetes version. Terraform will only perform drift detection if a configuration value is provided | `list(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_launch_template_id\"\u003e\u003c/a\u003e [launch\\_template\\_id](#input\\_launch\\_template\\_id) | The ID (not name) of a custom launch template to use for the EKS node group. If provided, it must specify the AMI image ID. | `list(string)` | `[]` | no |\n| \u003ca name=\"input_launch_template_version\"\u003e\u003c/a\u003e [launch\\_template\\_version](#input\\_launch\\_template\\_version) | The version of the specified launch template to use. Defaults to latest version. | `list(string)` | `[]` | no |\n| \u003ca name=\"input_max_size\"\u003e\u003c/a\u003e [max\\_size](#input\\_max\\_size) | Maximum number of worker nodes | `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 allows containerized workloads assuming the instance profile, but it's not really recomended. You should use OIDC service accounts instead. | `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_min_size\"\u003e\u003c/a\u003e [min\\_size](#input\\_min\\_size) | Minimum number of worker nodes | `number` | n/a | yes |\n| \u003ca name=\"input_module_depends_on\"\u003e\u003c/a\u003e [module\\_depends\\_on](#input\\_module\\_depends\\_on) | Can be any value desired. Module will wait for this value to be computed before creating node group. | `any` | `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_node_group_terraform_timeouts\"\u003e\u003c/a\u003e [node\\_group\\_terraform\\_timeouts](#input\\_node\\_group\\_terraform\\_timeouts) | Configuration for the Terraform [`timeouts` Configuration Block](https://www.terraform.io/docs/language/resources/syntax.html#operation-timeouts) of the node group resource.\u003cbr/\u003eLeave list empty for defaults. Pass list with single object with attributes matching the `timeouts` block to configure it.\u003cbr/\u003eLeave attribute values `null` to preserve individual defaults while setting others. | \u003cpre\u003elist(object({\u003cbr/\u003e    create = optional(string)\u003cbr/\u003e    update = optional(string)\u003cbr/\u003e    delete = optional(string)\u003cbr/\u003e  }))\u003c/pre\u003e | `[]` | no |\n| \u003ca name=\"input_node_repair_enabled\"\u003e\u003c/a\u003e [node\\_repair\\_enabled](#input\\_node\\_repair\\_enabled) | The node auto-repair configuration for the node group will be enabled. Defaults to false | `bool` | `false` | no |\n| \u003ca name=\"input_node_role_arn\"\u003e\u003c/a\u003e [node\\_role\\_arn](#input\\_node\\_role\\_arn) | If provided, assign workers the given role, which this module will not modify | `list(string)` | `[]` | no |\n| \u003ca name=\"input_node_role_cni_policy_enabled\"\u003e\u003c/a\u003e [node\\_role\\_cni\\_policy\\_enabled](#input\\_node\\_role\\_cni\\_policy\\_enabled) | When true, the `AmazonEKS_CNI_Policy` will be attached to the node IAM role.\u003cbr/\u003eThis used to be required, but it is [now recommended](https://docs.aws.amazon.com/eks/latest/userguide/create-node-role.html) that this policy be\u003cbr/\u003eattached only to the `aws-node` Kubernetes service account. However, that\u003cbr/\u003eis difficult to do with Terraform, so this module defaults to the old pattern. | `bool` | `true` | no |\n| \u003ca name=\"input_node_role_permissions_boundary\"\u003e\u003c/a\u003e [node\\_role\\_permissions\\_boundary](#input\\_node\\_role\\_permissions\\_boundary) | If provided, all IAM roles will be created with this permissions boundary attached. | `string` | `null` | no |\n| \u003ca name=\"input_node_role_policy_arns\"\u003e\u003c/a\u003e [node\\_role\\_policy\\_arns](#input\\_node\\_role\\_policy\\_arns) | List of policy ARNs to attach to the worker role this module creates in addition to the default ones | `list(string)` | `[]` | no |\n| \u003ca name=\"input_placement\"\u003e\u003c/a\u003e [placement](#input\\_placement) | Configuration for the [`placement` Configuration Block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/launch_template#placement) of the launch template.\u003cbr/\u003eLeave list empty for defaults. Pass list with single object with attributes matching the `placement` block to configure it.\u003cbr/\u003eNote that this configures the launch template only. Some elements will be ignored by the Auto Scaling Group\u003cbr/\u003ethat actually launches instances. Consult AWS documentation for details. | `list(any)` | `[]` | no |\n| \u003ca name=\"input_random_pet_length\"\u003e\u003c/a\u003e [random\\_pet\\_length](#input\\_random\\_pet\\_length) | In order to support \"create before destroy\" behavior, this module uses the `random_pet`\u003cbr/\u003eresource to generate a unique pet name for the node group, since the node group name\u003cbr/\u003emust be unique, meaning the new node group must have a different name than the old one.\u003cbr/\u003eThis variable controls the length of the pet name, meaning the number of pet names\u003cbr/\u003econcatenated together. This module defaults to 1, but there are only 452 names available,\u003cbr/\u003eso users with large numbers of node groups may want to increase this value. | `number` | `1` | 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_replace_node_group_on_version_update\"\u003e\u003c/a\u003e [replace\\_node\\_group\\_on\\_version\\_update](#input\\_replace\\_node\\_group\\_on\\_version\\_update) | Force Node Group replacement when updating to a new Kubernetes version. If set to `false` (the default), the Node Groups will be updated in-place | `bool` | `false` | no |\n| \u003ca name=\"input_resources_to_tag\"\u003e\u003c/a\u003e [resources\\_to\\_tag](#input\\_resources\\_to\\_tag) | List of auto-launched resource types to tag. Valid types are \"instance\", \"volume\", \"elastic-gpu\", \"spot-instances-request\", \"network-interface\". | `list(string)` | \u003cpre\u003e[\u003cbr/\u003e  \"instance\",\u003cbr/\u003e  \"volume\",\u003cbr/\u003e  \"network-interface\"\u003cbr/\u003e]\u003c/pre\u003e | no |\n| \u003ca name=\"input_ssh_access_security_group_ids\"\u003e\u003c/a\u003e [ssh\\_access\\_security\\_group\\_ids](#input\\_ssh\\_access\\_security\\_group\\_ids) | Set of EC2 Security Group IDs to allow SSH access (port 22) to the worker nodes. If you specify `ec2_ssh_key`, but do not specify this configuration when you create an EKS Node Group, port 22 on the worker nodes is opened to the Internet (0.0.0.0/0) | `list(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_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_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_update_config\"\u003e\u003c/a\u003e [update\\_config](#input\\_update\\_config) | Configuration for the `eks_node_group` [`update_config` Configuration Block](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/eks_node_group#update_config-configuration-block).\u003cbr/\u003eSpecify exactly one of `max_unavailable` (node count) or `max_unavailable_percentage` (percentage of nodes). | `list(map(number))` | `[]` | no |\n| \u003ca name=\"input_userdata_override_base64\"\u003e\u003c/a\u003e [userdata\\_override\\_base64](#input\\_userdata\\_override\\_base64) | Many features of this module rely on the `bootstrap.sh` provided with Amazon Linux, and this module\u003cbr/\u003emay generate \"user data\" that expects to find that script. If you want to use an AMI that is not\u003cbr/\u003ecompatible with the userdata generated by this module, then use `userdata_override_base64` to provide\u003cbr/\u003eyour own (Base64 encoded) user data. Use \"\" to prevent any user data from being set.\u003cbr/\u003e\u003cbr/\u003eSetting `userdata_override_base64` disables `kubernetes_taints`, `kubelet_additional_options`,\u003cbr/\u003e`before_cluster_joining_userdata`, `after_cluster_joining_userdata`, and `bootstrap_additional_options`. | `list(string)` | `[]` | no |\n\n## Outputs\n\n| Name | Description |\n|------|-------------|\n| \u003ca name=\"output_WARNING_cluster_autoscaler_enabled\"\u003e\u003c/a\u003e [WARNING\\_cluster\\_autoscaler\\_enabled](#output\\_WARNING\\_cluster\\_autoscaler\\_enabled) | WARNING |\n| \u003ca name=\"output_eks_node_group_ami_id\"\u003e\u003c/a\u003e [eks\\_node\\_group\\_ami\\_id](#output\\_eks\\_node\\_group\\_ami\\_id) | The ID of the AMI used for the worker nodes, if specified |\n| \u003ca name=\"output_eks_node_group_arn\"\u003e\u003c/a\u003e [eks\\_node\\_group\\_arn](#output\\_eks\\_node\\_group\\_arn) | Amazon Resource Name (ARN) of the EKS Node Group |\n| \u003ca name=\"output_eks_node_group_cbd_pet_name\"\u003e\u003c/a\u003e [eks\\_node\\_group\\_cbd\\_pet\\_name](#output\\_eks\\_node\\_group\\_cbd\\_pet\\_name) | The pet name of this node group, if this module generated one |\n| \u003ca name=\"output_eks_node_group_id\"\u003e\u003c/a\u003e [eks\\_node\\_group\\_id](#output\\_eks\\_node\\_group\\_id) | EKS Cluster name and EKS Node Group name separated by a colon |\n| \u003ca name=\"output_eks_node_group_launch_template_id\"\u003e\u003c/a\u003e [eks\\_node\\_group\\_launch\\_template\\_id](#output\\_eks\\_node\\_group\\_launch\\_template\\_id) | The ID of the launch template used for this node group |\n| \u003ca name=\"output_eks_node_group_launch_template_name\"\u003e\u003c/a\u003e [eks\\_node\\_group\\_launch\\_template\\_name](#output\\_eks\\_node\\_group\\_launch\\_template\\_name) | The name of the launch template used for this node group |\n| \u003ca name=\"output_eks_node_group_remote_access_security_group_id\"\u003e\u003c/a\u003e [eks\\_node\\_group\\_remote\\_access\\_security\\_group\\_id](#output\\_eks\\_node\\_group\\_remote\\_access\\_security\\_group\\_id) | The ID of the security group generated to allow SSH access to the nodes, if this module generated one |\n| \u003ca name=\"output_eks_node_group_resources\"\u003e\u003c/a\u003e [eks\\_node\\_group\\_resources](#output\\_eks\\_node\\_group\\_resources) | List of objects containing information about underlying resources of the EKS Node Group |\n| \u003ca name=\"output_eks_node_group_role_arn\"\u003e\u003c/a\u003e [eks\\_node\\_group\\_role\\_arn](#output\\_eks\\_node\\_group\\_role\\_arn) | ARN of the worker nodes IAM role |\n| \u003ca name=\"output_eks_node_group_role_name\"\u003e\u003c/a\u003e [eks\\_node\\_group\\_role\\_name](#output\\_eks\\_node\\_group\\_role\\_name) | Name of the worker nodes IAM role |\n| \u003ca name=\"output_eks_node_group_status\"\u003e\u003c/a\u003e [eks\\_node\\_group\\_status](#output\\_eks\\_node\\_group\\_status) | Status of the EKS Node Group |\n| \u003ca name=\"output_eks_node_group_tags_all\"\u003e\u003c/a\u003e [eks\\_node\\_group\\_tags\\_all](#output\\_eks\\_node\\_group\\_tags\\_all) | A map of tags assigned to the resource, including those inherited from the provider default\\_tags configuration block. |\n\u003c!-- markdownlint-restore --\u003e\n\n\n## Related Projects\n\nCheck out these related projects.\n\n- [terraform-aws-eks-cluster](https://github.com/cloudposse/terraform-aws-eks-cluster) - Terraform module to provision an EKS cluster on AWS\n- [terraform-aws-eks-workers](https://github.com/cloudposse/terraform-aws-eks-workers) - Terraform module to provision an AWS AutoScaling Group, IAM Role, and Security Group for EKS Workers\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\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-node-group/graphs/contributors\"\u003e\n  \u003cimg src=\"https://contrib.rocks/image?repo=cloudposse/terraform-aws-eks-node-group\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-node-group/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-node-group/?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-node-group\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-node-group\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-node-group\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-node-group\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-2025 [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-node-group\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-node-group?pixel\u0026cs=github\u0026cm=readme\u0026an=terraform-aws-eks-node-group\"/\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudposse%2Fterraform-aws-eks-node-group","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcloudposse%2Fterraform-aws-eks-node-group","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcloudposse%2Fterraform-aws-eks-node-group/lists"}