UpdateClusterVersion
Updates an Amazon EKS cluster to the specified Kubernetes version. Your cluster continues to function during the update. The response output includes an update ID that you can use to track the status of your cluster update with the DescribeUpdate API operation.
Cluster updates are asynchronous, and they should finish within a few minutes. During
an update, the cluster status moves to UPDATING
(this status transition is
eventually consistent). When the update is complete (either Failed
or
Successful
), the cluster status moves to Active
.
If your cluster has managed node groups attached to it, all of your node groups’ Kubernetes versions must match the cluster’s Kubernetes version in order to update the cluster to a new Kubernetes version.
Request Syntax
POST /clusters/name
/updates HTTP/1.1
Content-type: application/json
{
"clientRequestToken": "string
",
"version": "string
"
}
URI Request Parameters
The request uses the following URI parameters.
- name
-
The name of the Amazon EKS cluster to update.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- clientRequestToken
-
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Type: String
Required: No
- version
-
The desired Kubernetes version following a successful update.
Type: String
Required: Yes
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.
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 an IAM principal 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 withListNodegroups
. Amazon EKS clusters and node groups are AWS Region specific.HTTP Status Code: 404
- ServerException
-
These errors are usually caused by a server-side issue.
HTTP Status Code: 500
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)
Example
The following example updates the devel
cluster to Kubernetes version
1.11.
Sample Request
POST /clusters/devel/updates HTTP/1.1
Host: eks.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/1.16.56 Python/3.7.0 Darwin/17.7.0 botocore/1.12.46
X-Amz-Date: 20181129T172834Z
Authorization: AUTHPARAMS
{
"version": "1.11",
"clientRequestToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
Sample Response
HTTP/1.1 200 OK
Date: Thu, 29 Nov 2018 17:28:35 GMT
Content-Type: application/json
Content-Length: 228
x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx
x-amz-apigw-id: RIo2bEs8vHcFXoA=
X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx
Connection: keep-alive
{
"update": {
"errors": [],
"params": [{
"value": "1.11",
"type": "Version"
}, {
"value": "eks.1",
"type": "PlatformVersion"
}],
"status": "InProgress",
"id": "9f771284-9e30-4886-b5b1-3789b6bea4dc",
"createdAt": 1543512515.848,
"type": "VersionUpdate"
}
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: