Documentation

An object representing an Amazon EKS managed node group.

See: newNodegroup smart constructor.

Create a value of Nodegroup with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:amiType:Nodegroup', nodegroup_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.

$sel:capacityType:Nodegroup', nodegroup_capacityType - The capacity type of your managed node group.

$sel:clusterName:Nodegroup', nodegroup_clusterName - The name of the cluster that the managed node group resides in.

$sel:createdAt:Nodegroup', nodegroup_createdAt - The Unix epoch timestamp in seconds for when the managed node group was created.

$sel:diskSize:Nodegroup', nodegroup_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.

$sel:health:Nodegroup', nodegroup_health - The health status of the node group. If there are issues with your node group's health, they are listed here.

$sel:instanceTypes:Nodegroup', nodegroup_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.

$sel:labels:Nodegroup', nodegroup_labels - The Kubernetes labels applied to the nodes in the node group.

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.

$sel:launchTemplate:Nodegroup', nodegroup_launchTemplate - If a launch template was used to create the node group, then this is the launch template that was used.

$sel:modifiedAt:Nodegroup', nodegroup_modifiedAt - The Unix epoch timestamp in seconds for when the managed node group was last modified.

$sel:nodeRole:Nodegroup', nodegroup_nodeRole - The IAM role associated with your node group. The Amazon EKS node kubelet daemon makes calls to Amazon Web Services APIs on your behalf. Nodes receive permissions for these API calls through an IAM instance profile and associated policies.

$sel:nodegroupArn:Nodegroup', nodegroup_nodegroupArn - The Amazon Resource Name (ARN) associated with the managed node group.

$sel:nodegroupName:Nodegroup', nodegroup_nodegroupName - The name associated with an Amazon EKS managed node group.

$sel:releaseVersion:Nodegroup', nodegroup_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.

$sel:remoteAccess:Nodegroup', nodegroup_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.

$sel:resources:Nodegroup', nodegroup_resources - The resources associated with the node group, such as Auto Scaling groups and security groups for remote access.

$sel:scalingConfig:Nodegroup', nodegroup_scalingConfig - The scaling configuration details for the Auto Scaling group that is associated with your node group.

$sel:status:Nodegroup', nodegroup_status - The current status of the managed node group.

$sel:subnets:Nodegroup', nodegroup_subnets - The subnets that were specified for the Auto Scaling group that is associated with your node group.

$sel:tags:Nodegroup', nodegroup_tags - The metadata applied to the node group to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

$sel:taints:Nodegroup', nodegroup_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.

$sel:updateConfig:Nodegroup', nodegroup_updateConfig - The node group update configuration.

Nodegroup, nodegroup_version - The Kubernetes version of the managed node group.

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.

The capacity type of your managed node group.

The name of the cluster that the managed node group resides in.

The Unix epoch timestamp in seconds for when the managed node group was created.

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.

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

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.

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

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.

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

The Unix epoch timestamp in seconds for when the managed node group was last modified.

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

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

The name associated with an Amazon EKS managed node group.

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.

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.

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

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

The current status of the managed node group.

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

The metadata applied to the node group to assist with categorization and organization. Each tag consists of a key and an optional value. You define both. Node group tags do not propagate to any other resources associated with the node group, such as the Amazon EC2 instances or subnets.

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.

The node group update configuration.

The Kubernetes version of the managed node group.