Amazon EKS · JSON Structure

Eks Openapi Cluster Structure

Cluster schema from Amazon EKS API

Type: object Properties: 13

Container OrchestrationContainersEKSKubernetes

Cluster is a JSON Structure definition published by Amazon EKS, describing 13 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name arn createdAt version endpoint roleArn resourcesVpcConfig kubernetesNetworkConfig logging status certificateAuthority platformVersion tags

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-eks/refs/heads/main/json-structure/eks-openapi-cluster-structure.json",
  "name": "Cluster",
  "description": "Cluster schema from Amazon EKS API",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the cluster."
    },
    "arn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of the cluster."
    },
    "createdAt": {
      "type": "datetime",
      "description": "The Unix epoch timestamp at object creation."
    },
    "version": {
      "type": "string",
      "description": "The Kubernetes server version for the cluster."
    },
    "endpoint": {
      "type": "string",
      "description": "The endpoint for your Kubernetes API server."
    },
    "roleArn": {
      "type": "string",
      "description": "The Amazon Resource Name (ARN) of the IAM role."
    },
    "resourcesVpcConfig": {
      "$ref": "#/components/schemas/VpcConfigResponse"
    },
    "kubernetesNetworkConfig": {
      "$ref": "#/components/schemas/KubernetesNetworkConfigResponse"
    },
    "logging": {
      "$ref": "#/components/schemas/Logging"
    },
    "status": {
      "type": "string",
      "enum": [
        "CREATING",
        "ACTIVE",
        "DELETING",
        "FAILED",
        "UPDATING",
        "PENDING"
      ],
      "description": "The current status of the cluster."
    },
    "certificateAuthority": {
      "type": "object",
      "properties": {
        "data": {
          "type": "string",
          "description": "The Base64-encoded certificate data."
        }
      }
    },
    "platformVersion": {
      "type": "string",
      "description": "The platform version of your Amazon EKS cluster."
    },
    "tags": {
      "type": "object",
      "additionalProperties": {
        "type": "string"
      },
      "description": "Metadata that assists with categorization and organization."
    }
  }
}