class Nodegroup (construct)

Language	Type name
.NET	Amazon.CDK.AWS.EKS.Nodegroup
Java	software.amazon.awscdk.services.eks.Nodegroup
Python	aws_cdk.aws_eks.Nodegroup
TypeScript (source)	@aws-cdk/aws-eks » Nodegroup

Implements IConstruct, IConstruct, IDependable, IResource, INodegroup

The Nodegroup resource class.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ec2 from '@aws-cdk/aws-ec2';
import * as eks from '@aws-cdk/aws-eks';
import * as iam from '@aws-cdk/aws-iam';

declare const cluster: eks.Cluster;
declare const instanceType: ec2.InstanceType;
declare const role: iam.Role;
declare const securityGroup: ec2.SecurityGroup;
declare const subnet: ec2.Subnet;
declare const subnetFilter: ec2.SubnetFilter;
const nodegroup = new eks.Nodegroup(this, 'MyNodegroup', {
  cluster: cluster,

  // the properties below are optional
  amiType: eks.NodegroupAmiType.AL2_X86_64,
  capacityType: eks.CapacityType.SPOT,
  desiredSize: 123,
  diskSize: 123,
  forceUpdate: false,
  instanceType: instanceType,
  instanceTypes: [instanceType],
  labels: {
    labelsKey: 'labels',
  },
  launchTemplateSpec: {
    id: 'id',

    // the properties below are optional
    version: 'version',
  },
  maxSize: 123,
  minSize: 123,
  nodegroupName: 'nodegroupName',
  nodeRole: role,
  releaseVersion: 'releaseVersion',
  remoteAccess: {
    sshKeyName: 'sshKeyName',

    // the properties below are optional
    sourceSecurityGroups: [securityGroup],
  },
  subnets: {
    availabilityZones: ['availabilityZones'],
    onePerAz: false,
    subnetFilters: [subnetFilter],
    subnetGroupName: 'subnetGroupName',
    subnetName: 'subnetName',
    subnets: [subnet],
    subnetType: ec2.SubnetType.ISOLATED,
  },
  tags: {
    tagsKey: 'tags',
  },
  taints: [{
    effect: eks.TaintEffect.NO_SCHEDULE,
    key: 'key',
    value: 'value',
  }],
});

Initializer

new Nodegroup(scope: Construct, id: string, props: NodegroupProps)

Parameters

• scope Construct
• id string
• props NodegroupProps

Construct Props

Name	Type	Description
cluster	ICluster	Cluster resource.
amiType?	NodegroupAmiType	The AMI type for your node group.
capacityType?	CapacityType	The capacity type of the nodegroup.
desiredSize?	number	The current number of worker nodes that the managed node group should maintain.
diskSize?	number	The root device disk size (in GiB) for your node group instances.
forceUpdate?	boolean	Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
instanceType?⚠️	InstanceType	The instance type to use for your node group.
instanceTypes?	InstanceType[]	The instance types to use for your node group.
labels?	{ [string]: string }	The Kubernetes labels to be applied to the nodes in the node group when they are created.
launchTemplateSpec?	LaunchTemplateSpec	Launch template specification used for the nodegroup.
maxSize?	number	The maximum number of worker nodes that the managed node group can scale out to.
minSize?	number	The minimum number of worker nodes that the managed node group can scale in to.
nodeRole?	IRole	The IAM role to associate with your node group.
nodegroupName?	string	Name of the Nodegroup.
releaseVersion?	string	The AMI version of the Amazon EKS-optimized AMI to use with your node group (for example, 1.14.7-YYYYMMDD).
remoteAccess?	NodegroupRemoteAccess	The remote access (SSH) configuration to use with your node group.
subnets?	SubnetSelection	The subnets to use for the Auto Scaling group that is created for your node group.
tags?	{ [string]: string }	The metadata to apply to the node group to assist with categorization and organization.
taints?	TaintSpec[]	The Kubernetes taints to be applied to the nodes in the node group when they are created.

---

cluster

Type: ICluster

Cluster resource.

---

amiType?

Type: NodegroupAmiType (optional, default: auto-determined from the instanceTypes property when launchTemplateSpec property is not specified)

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.

---

capacityType?

Type: CapacityType (optional, default: ON_DEMAND)

The capacity type of the nodegroup.

---

desiredSize?

Type: number (optional, default: 2)

The current number of worker nodes that the managed node group should maintain.

If not specified, the nodewgroup will initially create minSize instances.

---

diskSize?

Type: number (optional, default: 20)

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

---

forceUpdate?

Type: boolean (optional, default: true)

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.

---

instanceType?⚠️

⚠️ Deprecated: Use instanceTypes instead.

Type: InstanceType (optional, default: t3.medium)

The instance type to use for your node group.

Currently, you can specify a single instance type for a node group. The default value for this parameter is t3.medium. If you choose a GPU instance type, be sure to specify the AL2_x86_64_GPU with the amiType parameter.

---

instanceTypes?

Type: InstanceType[] (optional, default: t3.medium will be used according to the cloudformation document.)

The instance types to use for your node group.

See also: [- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes](- https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-eks-nodegroup.html#cfn-eks-nodegroup-instancetypes)

---

labels?

Type: { [string]: string } (optional, default: None)

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

---

launchTemplateSpec?

Type: LaunchTemplateSpec (optional, default: no launch template)

Launch template specification used for the nodegroup.

See also: [- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html](- https://docs.aws.amazon.com/eks/latest/userguide/launch-templates.html)

---

maxSize?

Type: number (optional, default: desiredSize)

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.

---

minSize?

Type: number (optional, default: 1)

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.

---

nodeRole?

Type: IRole (optional, default: None. Auto-generated if not specified.)

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.

---

nodegroupName?

Type: string (optional, default: resource ID)

Name of the Nodegroup.

---

releaseVersion?

Type: string (optional, default: The latest available AMI version for the node group's current Kubernetes version is used.)

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

---

remoteAccess?

Type: NodegroupRemoteAccess (optional, default: disabled)

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)

---

subnets?

Type: SubnetSelection (optional, default: private subnets)

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.

---

tags?

Type: { [string]: string } (optional, default: None)

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.

---

taints?

Type: TaintSpec[] (optional, default: None)

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

Properties

Name	Type	Description
cluster	ICluster	the Amazon EKS cluster resource.
env	ResourceEnvironment	The environment this resource belongs to.
node	ConstructNode	The construct tree node associated with this construct.
nodegroupArn	string	ARN of the nodegroup.
nodegroupName	string	Nodegroup name.
role	IRole	IAM role of the instance profile for the nodegroup.
stack	Stack	The stack in which this resource is defined.

---

cluster

Type: ICluster

the Amazon EKS cluster resource.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node

Type: ConstructNode

The construct tree node associated with this construct.

---

nodegroupArn

Type: string

ARN of the nodegroup.

---

nodegroupName

Type: string

Nodegroup name.

---

role

Type: IRole

IAM role of the instance profile for the nodegroup.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.
static fromNodegroupName(scope, id, nodegroupName)	Import the Nodegroup from attributes.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromNodegroupName(scope, id, nodegroupName)

public static fromNodegroupName(scope: Construct, id: string, nodegroupName: string): INodegroup

Parameters

• scope Construct
• id string
• nodegroupName string

Returns

• INodegroup

Import the Nodegroup from attributes.