AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to UpdateClusterVersionAsync.

Namespace: Amazon.EKS
Assembly: AWSSDK.EKS.dll
Version: 3.x.y.z

Syntax

C#
public abstract UpdateClusterVersionResponse UpdateClusterVersion(
         UpdateClusterVersionRequest request
)

Parameters

request
Type: Amazon.EKS.Model.UpdateClusterVersionRequest

Container for the necessary parameters to execute the UpdateClusterVersion service method.

Return Value


The response from the UpdateClusterVersion service method, as returned by EKS.

Exceptions

ExceptionCondition
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.
InvalidParameterException The specified parameter is invalid. Review the available parameters for the API request.
InvalidRequestException The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.
ResourceInUseException The specified resource is in use.
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 Amazon Web Services Region specific.
ServerException These errors are usually caused by a server-side issue.

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

See Also