eks.clusters.create

Create a cluster

POST /eks/api/clustersIAM eks:CreateClusterChanges state

tier dev runs one control-plane machine, standard three. The creator gets a ClusterAdmin access entry. nodegroup creates a first node group once the control plane is up and also needs eks:CreateNodegroup (and iam:PassRole when nodeRole is set). 409 when the name is taken.

Request syntax

POST /eks/api/clusters
{
  "regionId": "string",
  "name": "string",
  "version": "enum",
  "tier": "enum",
  "vpcId": "string",
  "allowedCidrs": "array of string",
  "endpointPublicAccess": "boolean",
  "endpointPrivateAccess": "boolean",
  "deletionProtection": "boolean",
  "nodegroup": "object",
  "addons": "array of json",
  "logging": "object",
  "tags": "map of string"
}

Request body

  • regionIdOptional

    string

    Region to create in (default: the X-EWS-Region header, else de1). fi1 (Helsinki, Finland) needs the organization setting "allow EU outside Germany".

    Constraints: 1-32 chars

  • nameRequired

    string

    Cluster name, unique in the organization (409 when taken): lowercase letters, digits and hyphens, starting with a letter, at most 40 characters

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

  • versionOptional

    enum

    Kubernetes minor; default the regular channel

    One of: 1.36, 1.37

  • tierOptional

    enum

    dev: one control-plane machine, no SLA. standard: three, highly available

    One of: dev, standard

  • vpcIdOptional

    string

    VPC the node groups join; default VPC if unset

  • 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. Default false

  • nodegroupOptional

    object

    A first node group, created once the control plane is up

    Constraints: JSON

  • addonsOptional

    array of json

    Add-ons to install. Default: metrics-server. [] installs none

  • loggingOptional

    object

    Default: audit only

    Constraints: JSON

  • tagsOptional

    map of string

    Tags for the new resource, e.g. {"env": "prod", "project": "shop"}. Keys your organization marks required must be present, or the create is refused with the missing keys (GET /tags/api/keys lists them).

    Constraints: key=value

Response

201 with the new cluster (status `creating`): 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, …. The control plane, the first node group and the add-ons are built in the background; follow it with `get` or `events`. 400 for a version past its end of support, a network in another region, a node type that cannot run a node, an add-on listed twice or not offered, or a missing required tag; 403 for a region the organization has not allowed; 404 for an unknown vpcId or nodeRole; 409 when the name is taken or a quota is full.

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:CreateCluster 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 create --name example

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