CreateNodegroup

Creates a managed node group for an Amazon EKS cluster.

You can only create a node group for your cluster that is equal to the current Kubernetes version for the cluster. All node groups are created with the latest AMI release version for the respective minor Kubernetes version of the cluster, unless you deploy a custom AMI using a launch template. For more information about using launch templates, see Customizing managed nodes with launch templates.

An Amazon EKS managed node group is an Amazon EC2 Auto Scaling group and associated Amazon EC2 instances that are managed by AWS for an Amazon EKS cluster. For more information, see Managed node groups in the Amazon EKS User Guide.

Request Syntax

POST /clusters/name/node-groups HTTP/1.1
Content-type: application/json

{
   "amiType": "string",
   "capacityType": "string",
   "clientRequestToken": "string",
   "diskSize": number,
   "instanceTypes": [ "string" ],
   "labels": { 
      "string" : "string" 
   },
   "launchTemplate": { 
      "id": "string",
      "name": "string",
      "version": "string"
   },
   "nodegroupName": "string",
   "nodeRole": "string",
   "releaseVersion": "string",
   "remoteAccess": { 
      "ec2SshKey": "string",
      "sourceSecurityGroups": [ "string" ]
   },
   "scalingConfig": { 
      "desiredSize": number,
      "maxSize": number,
      "minSize": number
   },
   "subnets": [ "string" ],
   "tags": { 
      "string" : "string" 
   },
   "taints": [ 
      { 
         "effect": "string",
         "key": "string",
         "value": "string"
      }
   ],
   "updateConfig": { 
      "maxUnavailable": number,
      "maxUnavailablePercentage": number
   },
   "version": "string"
}

URI Request Parameters

The request uses the following URI parameters.

Request Body

The request accepts the following data in JSON format.

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "nodegroup": { 
      "amiType": "string",
      "capacityType": "string",
      "clusterName": "string",
      "createdAt": number,
      "diskSize": number,
      "health": { 
         "issues": [ 
            { 
               "code": "string",
               "message": "string",
               "resourceIds": [ "string" ]
            }
         ]
      },
      "instanceTypes": [ "string" ],
      "labels": { 
         "string" : "string" 
      },
      "launchTemplate": { 
         "id": "string",
         "name": "string",
         "version": "string"
      },
      "modifiedAt": number,
      "nodegroupArn": "string",
      "nodegroupName": "string",
      "nodeRole": "string",
      "releaseVersion": "string",
      "remoteAccess": { 
         "ec2SshKey": "string",
         "sourceSecurityGroups": [ "string" ]
      },
      "resources": { 
         "autoScalingGroups": [ 
            { 
               "name": "string"
            }
         ],
         "remoteAccessSecurityGroup": "string"
      },
      "scalingConfig": { 
         "desiredSize": number,
         "maxSize": number,
         "minSize": number
      },
      "status": "string",
      "subnets": [ "string" ],
      "tags": { 
         "string" : "string" 
      },
      "taints": [ 
         { 
            "effect": "string",
            "key": "string",
            "value": "string"
         }
      ],
      "updateConfig": { 
         "maxUnavailable": number,
         "maxUnavailablePercentage": number
      },
      "version": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Errors

For information about the errors that are common to all actions, see Common Errors.

Examples

In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the Amazon EKS General Reference.

You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example 1

This example creates a managed node group without a launch template that uses an Amazon EKS optimized AMI with GPU support on p2.xlarge instances.

Sample Request

POST /clusters/my-cluster/node-groups HTTP/1.1
Host: eks.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34
X-Amz-Date: 20200812T151423Z
Authorization: AUTHPARAMS
Content-Length: 454

{
	"nodegroupName": "my-nodegroup-gpu",
	"scalingConfig": {
		"minSize": 2,
		"maxSize": 2,
		"desiredSize": 2
	},
	"subnets": ["subnet-nnnnnnnnnnnnnnnnn", "subnet-xxxxxxxxxxxxxxxxx", "subnet-yyyyyyyyyyyyyyyyy", "subnet-zzzzzzzzzzzzzzzzz"],
	"instanceTypes": ["p2.xlarge"],
	"amiType": "AL2_x86_64_GPU",
        "remoteAccess": {
          "ec2SshKey": "id_rsa"
         },
	"nodeRole": "arn:aws:iam::012345678910:role/NodeInstanceRole",
	"clientRequestToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Sample Response

HTTP/1.1 200 OK
Date: Wed, 12 Aug 2020 15:14:24 GMT
Content-Type: application/json
Content-Length: 951
x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
x-amz-apigw-id: DAc5BGsWvHcF_bw=
X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx
Connection: keep-alive

{
	"nodegroup": {
		"nodegroupName": "my-nodegroup-gpu2",
		"nodegroupArn": "arn:aws:eks:us-west-2:012345678910:nodegroup/my-cluster/my-nodegroup-gpu2/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
		"clusterName": "lt-testing",
		"version": "1.17",
		"releaseVersion": "1.17.9-20200804",
		"createdAt": 1.597245264844E9,
		"modifiedAt": 1.597245264844E9,
		"status": "CREATING",
		"scalingConfig": {
			"minSize": 2,
			"maxSize": 2,
			"desiredSize": 2
		},
		"instanceTypes": ["p2.xlarge"],
		"subnets": ["subnet-nnnnnnnnnnnnnnnnn", "subnet-xxxxxxxxxxxxxxxxx", "subnet-yyyyyyyyyyyyyyyyy", "subnet-zzzzzzzzzzzzzzzzz"],
		"remoteAccess": {
                  "ec2SshKey": "id_rsa",
                  "sourceSecurityGroups": null
                },
		"amiType": "AL2_x86_64_GPU",
		"nodeRole": "arn:aws:iam::012345678910:role/NodeInstanceRole",
		"labels": null,
		"resources": null,
		"diskSize": 20,
		"health": {
			"issues": []
		},
		"launchTemplate": null,
		"tags": {}
	}
}

Example 2

This example creates a managed node group with an Amazon EKS optimized AMI using version 2 of a launch template named my-launch-template.

Sample Request

POST /clusters/lt-testing/node-groups HTTP/1.1
Host: eks.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34
X-Amz-Date: 20200812T135927Z
Authorization: AUTHPARAMS
Content-Length: 433

{
	"nodegroupName": "my-nodegroup",
	"scalingConfig": {
		"minSize": 2,
		"maxSize": 2,
		"desiredSize": 2
	},
	"subnets": ["subnet-nnnnnnnnnnnnnnnnn", "subnet-xxxxxxxxxxxxxxxxx", "subnet-yyyyyyyyyyyyyyyyy", "subnet-zzzzzzzzzzzzzzzzz"],
	"amiType": "AL2_x86_64",
	"nodeRole": "arn:aws:iam::012345678910:role/NodeInstanceRole",
	"launchTemplate": {
		"name": "my-launch-template",
		"version": "2"
	},
	"clientRequestToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

Sample Response

HTTP/1.1 200 OK
Date: Wed, 12 Aug 2020 13:59:32 GMT
Content-Type: application/json
Content-Length: 1028
x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
x-amz-apigw-id: DAc5BGsWvHcF_bw=
X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx
Connection: keep-alive

{
	"nodegroup": {
		"nodegroupName": "my-nodegroup",
		"nodegroupArn": "arn:aws:eks:us-west-2:012345678910:nodegroup/my-cluster/my-nodegroup/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
		"clusterName": "my-cluster",
		"version": "1.17",
		"releaseVersion": "1.17.9-20200804",
		"createdAt": 1.597240771904E9,
		"modifiedAt": 1.597240771904E9,
		"status": "CREATING",
		"scalingConfig": {
			"minSize": 2,
			"maxSize": 2,
			"desiredSize": 2
		},
		"instanceTypes": null,
		"subnets": ["subnet-nnnnnnnnnnnnnnnnn", "subnet-xxxxxxxxxxxxxxxxx", "subnet-yyyyyyyyyyyyyyyyy", "subnet-zzzzzzzzzzzzzzzzz"],
		"remoteAccess": null,
		"amiType": "AL2_x86_64",
		"nodeRole": "arn:aws:iam::012345678910:role/NodeInstanceRole",
		"labels": null,
		"resources": null,
		"diskSize": null,
		"health": {
			"issues": []
		},
		"launchTemplate": {
			"name": "my-template",
			"version": "2",
			"id": "lt-xxxxxxxxxxxxxxxxx"
		},
		"tags": {}
	}
}

See Also

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