cluster.status-eks ​
Read EKS control-plane and optional nodegroup status.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-clusters-aws |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
aws_connection_uuid | uuid | Yes | — | AWS CloudConnection UUID used for provider calls. |
cluster_name | string | Yes | — | EKS cluster name. |
region | string | Yes | — | AWS region. |
nodegroup_name | string | No | — | Optional managed nodegroup name to include in the status snapshot. |
include_nodegroup | boolean | No | — | Whether to describe the nodegroup when nodegroup_name is supplied. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
cluster_name | string | No | — | EKS cluster name. |
region | string | No | — | AWS region used. |
provider_cluster_ref | string | No | — | EKS cluster ARN or name. |
cluster_status | string | No | — | EKS control-plane status. |
nodegroup_status | string | No | — | EKS nodegroup status when requested. |
ready | boolean | No | — | True when requested EKS resources report active status. |
cluster_endpoint | string | No | — | Kubernetes API endpoint. |
kubernetes_version | string | No | — | Kubernetes version reported by EKS. |
cluster | json | No | — | Normalized output from aws.eks.describe_cluster. |
nodegroup | json | No | — | Normalized output from aws.eks.describe_nodegroup. |
checked_at | string | No | — | ISO-8601 status timestamp. |
failure_reason | string | No | — | Human-readable failure reason. |
failed_step | json | No | — | Failed DAG step. |
failed_layer | json | No | — | Failed DAG layer. |
failed_at_state | json | No | — | Failed state metadata. |
error | string | No | — | Error message. |
error_type | string | No | — | Error class. |
failed_at | string | No | — | ISO failure timestamp. |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | describe | — |
describing | No | No | — | complete | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | describe | describing | — |
describing | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "cluster.status-eks",
"initial_data": {
"aws_connection_uuid": "value",
"cluster_name": "value",
"region": "value"
}
}