Amazon Elastic Kubernetes Service
API Reference (API Version 2017-11-01)

UpdateNodegroupConfig

Updates an Amazon EKS managed node group configuration. Your node group continues to function during the update. The response output includes an update ID that you can use to track the status of your node group update with the DescribeUpdate API operation. Currently you can update the Kubernetes labels for a node group or the scaling configuration.

Request Syntax

POST /clusters/name/node-groups/nodegroupName/update-config HTTP/1.1 Content-type: application/json { "clientRequestToken": "string", "labels": { "addOrUpdateLabels": { "string" : "string" }, "removeLabels": [ "string" ] }, "scalingConfig": { "desiredSize": number, "maxSize": number, "minSize": number } }

URI Request Parameters

The request requires the following URI parameters.

name

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

nodegroupName

The name of the managed node group to update.

Request Body

The request accepts the following data in JSON format.

clientRequestToken

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

Required: No

labels

The Kubernetes labels to be applied to the nodes in the node group after the update.

Type: UpdateLabelsPayload object

Required: No

scalingConfig

The scaling configuration details for the Auto Scaling group after the update.

Type: NodegroupScalingConfig object

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "update": { "createdAt": number, "errors": [ { "errorCode": "string", "errorMessage": "string", "resourceIds": [ "string" ] } ], "id": "string", "params": [ { "type": "string", "value": "string" } ], "status": "string", "type": "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.

update

An object representing an asynchronous update.

Type: Update object

Errors

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

ClientException

These errors are usually caused by a client action. Actions can include using an action or resource on behalf of a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

HTTP Status Code: 400

InvalidParameterException

The specified parameter is invalid. Review the available parameters for the API request.

HTTP Status Code: 400

InvalidRequestException

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

HTTP Status Code: 400

ResourceInUseException

The specified resource is in use.

HTTP Status Code: 409

ResourceNotFoundException

The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are Region-specific.

HTTP Status Code: 404

ServerException

These errors are usually caused by a server-side issue.

HTTP Status Code: 500

Example

Example

This example updates the scaling configuration for a node group called standard in the prod cluster.

Sample Request

POST /clusters/prod/node-groups/standard/update-config HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.275 Python/3.7.4 Darwin/18.7.0 botocore/1.13.11 X-Amz-Date: 20191111T202415Z Authorization: AUTHPARAMS Content-Length: 127 { "scalingConfig": { "minSize": 2, "desiredSize": 4, "maxSize": 6 }, "clientRequestToken": "25a75794-5c57-4df8-955f-3707839347f1" }

Sample Response

HTTP/1.1 200 OK Date: Mon, 11 Nov 2019 20:24:16 GMT Content-Type: application/json Content-Length: 247 x-amzn-RequestId: efe08175-4b52-41d1-aa3f-3251f367ef37 x-amz-apigw-id: DAt5dGkFPHcFzuQ= X-Amzn-Trace-Id: Root=1-5dc9c36f-00d117cc21d798af6091631a Connection: keep-alive { "update": { "id": "4c6c3652-9c56-3c76-86e3-8a3930af1bae", "status": "InProgress", "type": "ConfigUpdate", "params": [ { "type": "MinSize", "value": "2" }, { "type": "MaxSize", "value": "6" }, { "type": "DesiredSize", "value": "4" } ], "createdAt": 1573503855.887, "errors": [] } }

See Also

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