Nodegroup - Amazon EKS
ContentsSee Also

Nodegroup

An object representing an Amazon EKS managed node group.

Contents

amiType

If the node group was deployed using a launch template with a custom AMI, then this is CUSTOM. For node groups that weren't deployed using a launch template, this is the AMI type that was specified in the node group configuration.

Type: String

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

Required: No

capacityType

The capacity type of your managed node group.

Type: String

Valid Values: ON_DEMAND | SPOT | CAPACITY_BLOCK

Required: No

clusterName

The name of your cluster.

Type: String

Required: No

createdAt

The Unix epoch timestamp at object creation.

Type: Timestamp

Required: No

diskSize

If the node group wasn't deployed with a launch template, then this is the disk size in the node group configuration. If the node group was deployed with a launch template, then this is null.

Type: Integer

Required: No

health

The health status of the node group. If there are issues with your node group's health, they are listed here.

Type: NodegroupHealth object

Required: No

instanceTypes

If the node group wasn't deployed with a launch template, then this is the instance type that is associated with the node group. If the node group was deployed with a launch template, then this is null.

Type: Array of strings

Required: No

labels

The Kubernetes labels applied to the nodes in the node group.

Note

Only labels that are applied with the Amazon EKS API are shown here. There may be other Kubernetes labels applied to the nodes in this group.

Type: String to string map

Key Length Constraints: Minimum length of 1. Maximum length of 63.

Value Length Constraints: Minimum length of 1. Maximum length of 63.

Required: No

launchTemplate

If a launch template was used to create the node group, then this is the launch template that was used.

Type: LaunchTemplateSpecification object

Required: No

modifiedAt

The Unix epoch timestamp for the last modification to the object.

Type: Timestamp

Required: No

nodegroupArn

The Amazon Resource Name (ARN) associated with the managed node group.

Type: String

Required: No

nodegroupName

The name associated with an Amazon EKS managed node group.

Type: String

Required: No

nodeRepairConfig

The node auto repair configuration for the node group.

Type: NodeRepairConfig object

Required: No

nodeRole

The IAM role associated with your node group. The Amazon EKS node kubelet daemon makes calls to AWS APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies.

Type: String

Required: No

releaseVersion

If the node group was deployed using a launch template with a custom AMI, then this is the AMI ID that was specified in the launch template. For node groups that weren't deployed using a launch template, this is the version of the Amazon EKS optimized AMI that the node group was deployed with.

Type: String

Required: No

remoteAccess

If the node group wasn't deployed with a launch template, then this is the remote access configuration that is associated with the node group. If the node group was deployed with a launch template, then this is null.

Type: RemoteAccessConfig object

Required: No

resources

The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.

Type: NodegroupResources object

Required: No

scalingConfig

The scaling configuration details for the Auto Scaling group that is associated with your node group.

Type: NodegroupScalingConfig object

Required: No

status

The current status of the managed node group.

Type: String

Valid Values: CREATING | ACTIVE | UPDATING | DELETING | CREATE_FAILED | DELETE_FAILED | DEGRADED

Required: No

subnets

The subnets that were specified for the Auto Scaling group that is associated with your node group.

Type: Array of strings

Required: No

tags

Metadata that assists with categorization and organization. Each tag consists of a key and an optional value. You define both. Tags don't propagate to any other cluster or AWS resources.

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No

taints

The Kubernetes taints to be applied to the nodes in the node group when they are created. Effect is one of No_Schedule, Prefer_No_Schedule, or No_Execute. Kubernetes taints can be used together with tolerations to control how workloads are scheduled to your nodes. For more information, see Node taints on managed node groups.

Type: Array of Taint objects

Required: No

updateConfig

The node group update configuration.

Type: NodegroupUpdateConfig object

Required: No

version

The Kubernetes version of the managed node group.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: