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 configuration. 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 DescribeUpdate"/>.

You can use this API operation to enable or disable exporting the Kubernetes control plane logs for your cluster to CloudWatch Logs. By default, cluster control plane logs aren't exported to CloudWatch Logs. For more information, see Amazon EKS Cluster control plane logs in the Amazon EKS User Guide.

CloudWatch Logs ingestion, archive storage, and data scanning rates apply to exported control plane logs. For more information, see CloudWatch Pricing.

You can also use this API operation to enable or disable public and private access to your cluster's Kubernetes API server endpoint. By default, public access is enabled, and private access is disabled. For more information, see Amazon EKS cluster endpoint access control in the Amazon EKS User Guide.

You can also use this API operation to choose different subnets and security groups for the cluster. You must specify at least two subnets that are in different Availability Zones. You can't change which VPC the subnets are from, the subnets must be in the same VPC as the subnets that the cluster was created with. For more information about the VPC requirements, see https://docs.aws.amazon.com/eks/latest/userguide/network_reqs.html in the Amazon EKS User Guide.

You can also use this API operation to enable or disable ARC zonal shift. If zonal shift is enabled, Amazon Web Services configures zonal autoshift for the cluster.

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.

Note:

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

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

Syntax

C#
public virtual UpdateClusterConfigResponse UpdateClusterConfig(
         UpdateClusterConfigRequest request
)

Parameters

request
Type: Amazon.EKS.Model.UpdateClusterConfigRequest

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

Return Value


The response from the UpdateClusterConfig 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