interface CfnNodegroupProps

Language	Type name
.NET	`Amazon.CDK.AWS.EKS.Legacy.CfnNodegroupProps`
Java	`software.amazon.awscdk.services.eks.legacy.CfnNodegroupProps`
Python	`aws_cdk.aws_eks_legacy.CfnNodegroupProps`
TypeScript	`@aws-cdk/aws-eks-legacy` » `CfnNodegroupProps`

Properties for defining a CfnNodegroup.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as eks_legacy from '@aws-cdk/aws-eks-legacy';
const cfnNodegroupProps: eks_legacy.CfnNodegroupProps = {
  clusterName: 'clusterName',
  nodeRole: 'nodeRole',
  subnets: ['subnets'],

  // the properties below are optional
  amiType: 'amiType',
  capacityType: 'capacityType',
  diskSize: 123,
  forceUpdateEnabled: false,
  instanceTypes: ['instanceTypes'],
  labels: {
    labelsKey: 'labels',
  },
  launchTemplate: {
    id: 'id',
    name: 'name',
    version: 'version',
  },
  nodegroupName: 'nodegroupName',
  releaseVersion: 'releaseVersion',
  remoteAccess: {
    ec2SshKey: 'ec2SshKey',

    // the properties below are optional
    sourceSecurityGroups: ['sourceSecurityGroups'],
  },
  scalingConfig: {
    desiredSize: 123,
    maxSize: 123,
    minSize: 123,
  },
  tags: {
    tagsKey: 'tags',
  },
  taints: [{
    effect: 'effect',
    key: 'key',
    value: 'value',
  }],
  updateConfig: {
    maxUnavailable: 123,
    maxUnavailablePercentage: 123,
  },
  version: 'version',
};

Properties

Name	Type	Description
clusterName	`string`	The name of the cluster to create the node group in.
nodeRole	`string`	The Amazon Resource Name (ARN) of the IAM role to associate with your node group.
subnets	`string[]`	The subnets to use for the Auto Scaling group that is created for your node group.
amiType?	`string`	The AMI type for your node group.
capacityType?	`string`	The capacity type of your managed node group.
diskSize?	`number`	The root device disk size (in GiB) for your node group instances.
forceUpdateEnabled?	`boolean \|` `IResolvable`	Force the update if the existing node group's pods are unable to be drained due to a pod disruption budget issue.
instanceTypes?	`string[]`	Specify the instance types for a node group.
labels?	`IResolvable` `\| { [string]: string }`	The Kubernetes labels applied to the nodes in the node group.
launchTemplate?	`IResolvable` `\|` `LaunchTemplateSpecificationProperty`	An object representing a node group's launch template specification.
nodegroupName?	`string`	The unique name to give your node group.
releaseVersion?	`string`	The AMI version of the Amazon EKS optimized AMI to use with your node group (for example, `1.14.7- YYYYMMDD` ). By default, the latest available AMI version for the node group's current Kubernetes version is used. For more information, see Amazon EKS optimized Linux AMI Versions in the Amazon EKS User Guide .
remoteAccess?	`IResolvable` `\|` `RemoteAccessProperty`	The remote access configuration to use with your node group.
scalingConfig?	`IResolvable` `\|` `ScalingConfigProperty`	The scaling configuration details for the Auto Scaling group that is created for your node group.
tags?	`{ [string]: string }`	The metadata applied to the node group to assist with categorization and organization.
taints?	`IResolvable` `\|` `IResolvable` `\|` `TaintProperty[]`	The Kubernetes taints to be applied to the nodes in the node group when they are created.
updateConfig?	`IResolvable` `\|` `UpdateConfigProperty`	The node group update configuration.
version?	`string`	The Kubernetes version to use for your managed nodes.

clusterName

Type: string

The name of the cluster to create the node group in.

nodeRole

Type: string

The Amazon Resource Name (ARN) of the IAM role to associate with your node group.

The Amazon EKS worker 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. Before you can launch nodes and register them into a cluster, you must create an IAM role for those nodes to use when they are launched. For more information, see Amazon EKS node IAM role in the Amazon EKS User Guide . If you specify launchTemplate , then don't specify IamInstanceProfile in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide .

subnets

Type: string[]

The subnets to use for the Auto Scaling group that is created for your node group.

If you specify launchTemplate , then don't specify SubnetId in your launch template, or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide .

amiType?

Type: string (optional)

The AMI type for your node group.

If you specify launchTemplate , and your launch template uses a custom AMI, then don't specify amiType , or the node group deployment will fail. If your launch template uses a Windows custom AMI, then add eks:kube-proxy-windows to your Windows nodes rolearn in the aws-auth ConfigMap . For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide .

capacityType?

Type: string (optional)

The capacity type of your managed node group.

diskSize?

Type: number (optional)

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

The default disk size is 20 GiB for Linux and Bottlerocket. The default disk size is 50 GiB for Windows. If you specify launchTemplate , then don't specify diskSize , or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide .

forceUpdateEnabled?

Type: boolean | IResolvable (optional)

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.

instanceTypes?

Type: string[] (optional)

Specify the instance types for a node group.

If you specify a GPU instance type, make sure to also specify an applicable GPU AMI type with the amiType parameter. If you specify launchTemplate , then you can specify zero or one instance type in your launch template or you can specify 0-20 instance types for instanceTypes . If however, you specify an instance type in your launch template and specify any instanceTypes , the node group deployment will fail. If you don't specify an instance type in a launch template or for instanceTypes , then t3.medium is used, by default. If you specify Spot for capacityType , then we recommend specifying multiple values for instanceTypes . For more information, see Managed node group capacity types and Launch template support in the Amazon EKS User Guide .

labels?

Type: IResolvable | { [string]: string } (optional)

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.

launchTemplate?

Type: IResolvable | LaunchTemplateSpecificationProperty (optional)

An object representing a node group's launch template specification.

If specified, then do not specify instanceTypes , diskSize , or remoteAccess and make sure that the launch template meets the requirements in launchTemplateSpecification .

nodegroupName?

Type: string (optional)

The unique name to give your node group.

releaseVersion?

Type: string (optional)

The AMI version of the Amazon EKS optimized AMI to use with your node group (for example, 1.14.7- *YYYYMMDD* ). By default, the latest available AMI version for the node group's current Kubernetes version is used. For more information, see Amazon EKS optimized Linux AMI Versions in the Amazon EKS User Guide .

Changing this value triggers an update of the node group if one is available. You can't update other properties at the same time as updating Release Version .

remoteAccess?

Type: IResolvable | RemoteAccessProperty (optional)

The remote access configuration to use with your node group.

For Linux, the protocol is SSH. For Windows, the protocol is RDP. If you specify launchTemplate , then don't specify remoteAccess , or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide .

scalingConfig?

Type: IResolvable | ScalingConfigProperty (optional)

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

tags?

Type: { [string]: string } (optional)

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.

taints?

Type: IResolvable | IResolvable | TaintProperty[] (optional)

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 .

updateConfig?

Type: IResolvable | UpdateConfigProperty (optional)

The node group update configuration.

version?

Type: string (optional)

The Kubernetes version to use for your managed nodes.

By default, the Kubernetes version of the cluster is used, and this is the only accepted specified value. If you specify launchTemplate , and your launch template uses a custom AMI, then don't specify version , or the node group deployment will fail. For more information about using launch templates with Amazon EKS, see Launch template support in the Amazon EKS User Guide .

You can't update other properties at the same time as updating Version .