AWS Fundamentals Logo
AWS Fundamentals
L2 Construct

Nodegroup

The Nodegroup resource class.

Import

import { Nodegroup } from 'aws-cdk-lib/aws-eks-v2';

Or use the module namespace:

import * as eks_v2 from 'aws-cdk-lib/aws-eks-v2';
// eks_v2.Nodegroup

Properties

Configuration passed to the constructor as NodegroupProps.

clusterRequired
ICluster

Cluster resource.

21 properties inherited from NodegroupOptions
amiTypeOptionalinherited from NodegroupOptions
NodegroupAmiType

The AMI type for your node group. If you explicitly specify the launchTemplate with custom AMI, do not specify this property, or the node group deployment will fail. In other cases, you will need to specify correct amiType for the nodegroup.

Default: - auto-determined from the instanceTypes property when launchTemplateSpec property is not specified

capacityTypeOptionalinherited from NodegroupOptions
CapacityType

The capacity type of the nodegroup.

Default: CapacityType.ON_DEMAND

desiredSizeOptionalinherited from NodegroupOptions
number

The current number of worker nodes that the managed node group should maintain. If not specified, the nodewgroup will initially create `minSize` instances.

Default: 2

diskSizeOptionalinherited from NodegroupOptions
number

The root device disk size (in GiB) for your node group instances.

Default: 20

enableNodeAutoRepairOptionalinherited from NodegroupOptions
boolean

Specifies whether to enable node auto repair for the node group. Node auto repair is disabled by default.

Default: false

forceUpdateOptionalinherited from NodegroupOptions
boolean

Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue. If an update fails because pods could not be drained, you can force the update after it fails to terminate the old node whether or not any pods are running on the node.

Default: true

instanceTypesOptionalinherited from NodegroupOptions
InstanceType[]

The instance types to use for your node group.

Default: t3.medium will be used according to the cloudformation document.

labelsOptionalinherited from NodegroupOptions
{ [key: string]: string }

The Kubernetes labels to be applied to the nodes in the node group when they are created.

Default: - None

launchTemplateSpecOptionalinherited from NodegroupOptions
LaunchTemplateSpec

Launch template specification used for the nodegroup.

Default: - no launch template

maxSizeOptionalinherited from NodegroupOptions
number

The maximum number of worker nodes that the managed node group can scale out to. Managed node groups can support up to 100 nodes by default.

Default: - same as desiredSize property

maxUnavailableOptionalinherited from NodegroupOptions
number

The maximum number of nodes unavailable at once during a version update. Nodes will be updated in parallel. The maximum number is 100. This value or `maxUnavailablePercentage` is required to have a value for custom update configurations to be applied.

Default: 1

maxUnavailablePercentageOptionalinherited from NodegroupOptions
number

The maximum percentage of nodes unavailable during a version update. This percentage of nodes will be updated in parallel, up to 100 nodes at once. This value or `maxUnavailable` is required to have a value for custom update configurations to be applied.

Default: undefined - node groups will update instances one at a time

minSizeOptionalinherited from NodegroupOptions
number

The minimum number of worker nodes that the managed node group can scale in to. This number must be greater than or equal to zero.

Default: 1

nodegroupNameOptionalinherited from NodegroupOptions
string

Name of the Nodegroup.

Default: - resource ID

nodeRoleOptionalinherited from NodegroupOptions
IRole

The IAM role to associate with your node group. The Amazon EKS worker node kubelet daemon makes calls to AWS APIs on your behalf. Worker nodes receive permissions for these API calls through an IAM instance profile and associated policies. Before you can launch worker nodes and register them into a cluster, you must create an IAM role for those worker nodes to use when they are launched.

Default: - None. Auto-generated if not specified.

releaseVersionOptionalinherited from NodegroupOptions
string

The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, `1.14.7-YYYYMMDD`).

Default: - The latest available AMI version for the node group's current Kubernetes version is used.

remoteAccessOptionalinherited from NodegroupOptions
NodegroupRemoteAccess

The remote access (SSH) configuration to use with your node group. Disabled by default, however, if you specify an Amazon EC2 SSH key but do not specify a source security group when you create a managed node group, then port 22 on the worker nodes is opened to the internet (0.0.0.0/0)

Default: - disabled

removalPolicyOptionalinherited from NodegroupOptions
RemovalPolicy

The removal policy applied to the managed node group resources. The removal policy controls what happens to the resource if it stops being managed by CloudFormation. This can happen in one of three situations: - The resource is removed from the template, so CloudFormation stops managing it - A change to the resource is made that requires it to be replaced, so CloudFormation stops managing it - The stack is deleted, so CloudFormation stops managing all resources in it

Default: RemovalPolicy.DESTROY

subnetsOptionalinherited from NodegroupOptions
SubnetSelection

The subnets to use for the Auto Scaling group that is created for your node group. By specifying the SubnetSelection, the selected subnets will automatically apply required tags i.e. `kubernetes.io/cluster/CLUSTER_NAME` with a value of `shared`, where `CLUSTER_NAME` is replaced with the name of your cluster.

Default: - private subnets

tagsOptionalinherited from NodegroupOptions
{ [key: string]: string }

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

Default: None

taintsOptionalinherited from NodegroupOptions
TaintSpec[]

The Kubernetes taints to be applied to the nodes in the node group when they are created.

Default: - None

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL2 (Higher-level)
Moduleaws-eks-v2
Properties22

External Links