> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/terraform-aws-modules/terraform-aws-eks/llms.txt
> Use this file to discover all available pages before exploring further.

# EKS Managed Node Group

> Input variables and outputs for the eks-managed-node-group sub-module.

The `eks-managed-node-group` sub-module manages [EKS managed node groups](https://docs.aws.amazon.com/eks/latest/userguide/managed-node-groups.html). It is invoked for each entry in the `eks_managed_node_groups` map on the root module.

## Inputs

### General

Determines whether to create EKS managed node group or not.

A map of tags to add to all resources.

Region where the resource(s) will be managed. Defaults to the Region set in the provider configuration.

### Node Group

Name of the EKS managed node group.

Determines whether to use `name` as is or create a unique name beginning with the `name` as the prefix.

Identifiers of EC2 Subnets to associate with the EKS Node Group. These subnets must have the following resource tag: `kubernetes.io/cluster/CLUSTER_NAME`.

Minimum number of instances/nodes.

Maximum number of instances/nodes.

Desired number of instances/nodes.

Kubernetes version. Defaults to EKS Cluster Kubernetes version.

Force version update if existing pods are unable to be drained due to a pod disruption budget issue.

### AMI

Type of Amazon Machine Image (AMI) associated with the EKS Node Group. See the AWS documentation for valid values.

The AMI from which to launch the instance. If not supplied, EKS will use its own default image.

The AMI version. Defaults to latest AMI release version for the given Kubernetes version and AMI type.

Determines whether to use the latest AMI release version for the given `ami_type` (except for `CUSTOM`). Note: `ami_type` and `kubernetes_version` must be supplied in order to enable this feature.

### Instance

Set of instance types associated with the EKS Node Group. Defaults to `["t3.medium"]`.

Type of capacity associated with the EKS Node Group. Valid values: `ON_DEMAND`, `SPOT`.

Disk size in GiB for nodes. Defaults to `20`. Only valid when `use_custom_launch_template` = `false`.

### Labels and Taints

Key-value map of Kubernetes labels. Only labels that are applied with the EKS API are managed by this argument. Other Kubernetes labels applied to the EKS Node Group will not be managed.

The Kubernetes taints to be applied to the nodes in the node group. Maximum of 50 taints per node group.

**taint object fields**

The key of the taint.

The value of the taint.

The effect of the taint. Valid values: `NO_SCHEDULE`, `NO_EXECUTE`, `PREFER_NO_SCHEDULE`.

### Update Config

Configuration block of settings for max unavailable resources during node group updates.

**update\_config fields**

Maximum number of nodes unavailable at once during a version update.

Desired max percentage of unavailable worker nodes during a node group update.

Update strategy for the node group.

The node auto repair configuration for the node group.

**node\_repair\_config fields**

Whether node auto repair is enabled.

Max number of nodes to repair in parallel.

Max percentage of nodes to repair in parallel.

Max unhealthy node count before repair stops.

Max unhealthy node percentage before repair stops.

Per-condition overrides for node repair behavior.

Configuration block with remote access settings. Only valid when `use_custom_launch_template` = `false`.

**remote\_access fields**

EC2 SSH key to use for remote access.

List of security group IDs to allow SSH access from.

Create, update, and delete timeout configurations for the node group.

**timeouts fields**

Create timeout.

Update timeout.

Delete timeout.

### User Data

Determines whether the bootstrap configurations are populated within the user data template. Only valid when using a custom AMI via `ami_id`.

Name of associated EKS cluster.

Endpoint of associated EKS cluster.

Base64 encoded CA of associated EKS cluster.

The CIDR block (IPv4 or IPv6) used by the cluster to assign Kubernetes service IP addresses.

User data that is injected into the user data script ahead of the EKS bootstrap script. Not used when `ami_type` = `BOTTLEROCKET_*`.

User data that is appended to the user data script after of the EKS bootstrap script. Not used when `ami_type` = `BOTTLEROCKET_*`.

Additional arguments passed to the bootstrap script. When `ami_type` = `BOTTLEROCKET_*`, these are additional settings that are provided to the Bottlerocket user data.

Path to a local, custom user data template file to use when rendering user data.

Array of cloud-init document parts that are created before the nodeadm document part.

**cloudinit part fields**

The content of the cloud-init part.

The MIME content type of the part.

The filename for the part.

The merge behavior for the part.

Array of cloud-init document parts that are created after the nodeadm document part.

**cloudinit part fields**

The content of the cloud-init part.

The MIME content type of the part.

The filename for the part.

The merge behavior for the part.

### Launch Template

Determines whether to create a launch template or not. If set to `false`, EKS will use its own default launch template.

Determines whether to use a custom launch template or not. If set to `false`, EKS will use its own default launch template.

The ID of an existing launch template to use. Required when `create_launch_template` = `false` and `use_custom_launch_template` = `true`.

Name of launch template to be created.

Determines whether to use `launch_template_name` as is or create a unique name beginning with the `launch_template_name` as the prefix.

Description of the launch template.

Launch template version number. The default is `$Default`.

Default version of the launch template.

Whether to update the launch templates default version on each update. Conflicts with `launch_template_default_version`.

A map of additional tags to add to the tag\_specifications of launch template created.

The tags to apply to the resources during launch.

If true, the launched EC2 instance(s) will be EBS-optimized.

The key name that should be used for the instance(s).

If true, enables EC2 instance termination protection.

The kernel ID.

The ID of the ram disk.

Specify volumes to attach to the instance besides the volumes specified by the AMI.

**block device mapping fields**

The name of the device to mount.

EBS volume configuration including `delete_on_termination`, `encrypted`, `iops`, `kms_key_id`, `snapshot_id`, `throughput`, `volume_initialization_rate`, `volume_size`, and `volume_type`.

Suppresses the specified device included in the AMI's block device mapping.

The virtual device name (ephemeralN).

Targeting for EC2 capacity reservations.

The CPU options for the instance. Contains `amd_sev_snp`, `core_count`, and `threads_per_core`.

Customize the credit specification of the instance. Contains `cpu_credits`.

Enable Nitro Enclaves on launched instances. Contains `enabled`.

The market (purchasing) option for the instance. Contains `market_type` and `spot_options`.

The maintenance options for the instance. Contains `auto_recovery`.

A list of license specifications to associate with. Each entry contains `license_configuration_arn`.

Customize the metadata options for the instance.

**metadata\_options fields**

Whether the metadata service is available. Valid values: `enabled`, `disabled`.

Whether the IPv6 endpoint for IMDS is enabled.

The desired HTTP PUT response hop limit for instance metadata requests.

Whether tokens are required for metadata requests. Valid values: `optional`, `required`.

Enables access to instance tags from the metadata service.

Enables/disables detailed monitoring.

Determines whether to enable Elastic Fabric Adapter (EFA) support.

Determines whether to enable EFA (`false`, default) or EFA and EFA-only (`true`) network interfaces. Note: requires vpc-cni version `v1.18.4` or later.

The indices of the network interfaces that should be EFA-enabled. Only valid when `enable_efa_support` = `true`.

Customize network interfaces to be attached at instance boot time.

The placement of the instance. Contains `affinity`, `availability_zone`, `group_name`, `host_id`, `host_resource_group_arn`, `partition_number`, `spread_domain`, and `tenancy`.

Determines whether a placement group is created and used by the node group.

The options for the instance hostname. The default values are inherited from the subnet.

A list of security group IDs to associate.

The ID of the EKS cluster primary security group to associate with the instance(s).

### IAM Role

Determines whether an IAM role is created or to use an existing IAM role.

The IP family used to assign Kubernetes pod and service addresses. Valid values are `ipv4` (default) and `ipv6`.

Existing IAM role ARN for the node group. Required if `create_iam_role` is set to `false`.

Name to use on IAM role created.

Determines whether the IAM role name (`iam_role_name`) is used as a prefix.

IAM role path.

Description of the role.

ARN of the policy that is used to set the permissions boundary for the IAM role.

Whether to attach the `AmazonEKS_CNI_Policy`/`AmazonEKS_CNI_IPv6_Policy` IAM policy to the IAM role. WARNING: If set `false` the permissions must be assigned to the `aws-node` DaemonSet pods via another method or nodes will not be able to join the cluster.

Additional policies to be added to the IAM role.

A map of additional tags to add to the IAM role created.

Determines whether an IAM role policy is created or not.

A list of IAM policy statements - used for adding specific IAM permissions as needed.

### Security Group

Determines if a security group is created.

Name to use on security group created.

Determines whether the security group name is used as a prefix.

Description of the security group created.

Security group ingress rules to add to the security group created.

Security group egress rules to add to the security group created.

A map of additional tags to add to the security group created.

***

## Outputs

### Launch Template

**launch\_template\_id** `string`

The ID of the launch template.

**launch\_template\_arn** `string`

The ARN of the launch template.

**launch\_template\_latest\_version** `number`

The latest version of the launch template.

**launch\_template\_name** `string`

The name of the launch template.

### Node Group

**node\_group\_arn** `string`

Amazon Resource Name (ARN) of the EKS Node Group.

**node\_group\_id** `string`

EKS Cluster name and EKS Node Group name separated by a colon (`:`).

**node\_group\_resources** `list`

List of objects containing information about underlying resources.

**node\_group\_autoscaling\_group\_names** `list(string)`

List of the autoscaling group names.

**node\_group\_status** `string`

Status of the EKS Node Group.

**node\_group\_labels** `map(string)`

Map of labels applied to the node group.

**node\_group\_taints** `list`

List of objects containing information about taints applied to the node group.

### IAM Role

**iam\_role\_name** `string`

The name of the IAM role.

**iam\_role\_arn** `string`

The Amazon Resource Name (ARN) specifying the IAM role.

**iam\_role\_unique\_id** `string`

Stable and unique string identifying the IAM role.

### Security Group

**security\_group\_arn** `string`

Amazon Resource Name (ARN) of the security group.

**security\_group\_id** `string`

ID of the security group.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.