Amazon Fargate · Schema

Cluster

An Amazon ECS cluster

ComputeContainersECSEKSMicroservicesServerless

Properties

Name Type Description
clusterArn string The ARN of the cluster
clusterName string The name of the cluster
status string Cluster status
registeredContainerInstancesCount integer Number of registered container instances
runningTasksCount integer Number of running tasks
pendingTasksCount integer Number of pending tasks
activeServicesCount integer Number of active services
tags array Tags associated with the cluster
settings array Cluster settings
View JSON Schema on GitHub

JSON Schema

amazon-fargate-cluster-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-fargate/refs/heads/main/json-schema/amazon-fargate-cluster-schema.json",
  "title": "Cluster",
  "description": "An Amazon ECS cluster",
  "type": "object",
  "properties": {
    "clusterArn": {
      "type": "string",
      "description": "The ARN of the cluster",
      "example": "arn:aws:ecs:us-east-1:123456789012:cluster/my-fargate-cluster"
    },
    "clusterName": {
      "type": "string",
      "description": "The name of the cluster",
      "example": "my-fargate-cluster"
    },
    "status": {
      "type": "string",
      "description": "Cluster status",
      "example": "ACTIVE",
      "enum": [
        "ACTIVE",
        "PROVISIONING",
        "DEPROVISIONING",
        "FAILED",
        "INACTIVE"
      ]
    },
    "registeredContainerInstancesCount": {
      "type": "integer",
      "description": "Number of registered container instances",
      "example": 0
    },
    "runningTasksCount": {
      "type": "integer",
      "description": "Number of running tasks",
      "example": 5
    },
    "pendingTasksCount": {
      "type": "integer",
      "description": "Number of pending tasks",
      "example": 0
    },
    "activeServicesCount": {
      "type": "integer",
      "description": "Number of active services",
      "example": 2
    },
    "tags": {
      "type": "array",
      "description": "Tags associated with the cluster",
      "items": {
        "$ref": "#/components/schemas/Tag"
      }
    },
    "settings": {
      "type": "array",
      "description": "Cluster settings",
      "items": {
        "$ref": "#/components/schemas/ClusterSetting"
      }
    }
  }
}