eks.clusters.update

Change the networks allowed to reach the API endpoint, or deletion protection

PATCH /eks/api/clusters/{cluster}IAM eks:UpdateClusterConfigChanges stateDestructive

Request syntax

PATCH /eks/api/clusters/{cluster}
{
  "allowedCidrs": "array of string",
  "endpointPublicAccess": "boolean",
  "endpointPrivateAccess": "boolean",
  "deletionProtection": "boolean",
  "autoscaler": "object",
  "logging": "object"
}

Path parameters

  • clusterRequired

    string

    Constraints: /^(ewk-[0-9a-f]{12}|[a-z]([a-z0-9-]{0,38}[a-z0-9])?)$/

Request body

  • allowedCidrsOptional

    array of string

    CIDRs allowed to reach the public endpoint, e.g. ["203.0.113.0/24"]

    Constraints: cidrv4

  • endpointPublicAccessOptional

    boolean

    The endpoint answers on its public address (to allowedCidrs); default true

  • endpointPrivateAccessOptional

    boolean

    The endpoint answers inside the VPC; default true

  • deletionProtectionOptional

    boolean

    true: a delete is refused (409) until it is turned off. Unchanged when absent

  • autoscalerOptional

    object

    The cluster autoscaler’s settings; it acts on node groups with autoscaling on

    Constraints: JSON

  • loggingOptional

    object

    Control-plane log types shipped to monitoring: api, audit, authenticator, controllerManager, scheduler

    Constraints: JSON

Response

200 with the cluster after the change: id, name, regionId, tier, version, kubernetesVersion, availableVersion, latestPatch, status, reconcileError, endpoint, endpointIpv4, allowedCidrs, endpointPublicAccess, endpointPrivateAccess, endpointPrivateIpv4, serviceAccountIssuer, vpcId, podCidr, serviceCidr, controlPlaneNodes, deletionProtection, autoscaler, logging, support, forcedUpgrade, slaPercent, createdAt, …. 400 when nothing is sent, or when the endpoint would have neither public nor private access. 404 when no cluster has that id or name, 403 without the permission on it.

A JSON response is wrapped as { "success": true, "data": … }; the CLI prints the whole body with --json.

Errors

  • 400The request does not pass the schema above. The body is { "error": …, "issues": […] }, one issue per field.
  • 401No credentials, or an access key that is unknown, revoked or expired.
  • 403The caller's policies do not allow eks:UpdateClusterConfig on this resource. The body names the action and the resource, and the refusal is recorded in the audit log.
  • 404The resource does not exist in your organization.

Examples

The required parameters only, with example values. Replace id and the other placeholders with your own.

dcloud eks clusters update cluster

Generated from the API description, the same one the API checks requests against and the CLI is built from. MCP tool: dcloud_eks_clusters_update.