aws.eks.describe_cluster ​
Describe an Amazon EKS cluster using a CloudConnection UUID.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | Base-aws |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
connection_uuid | uuid | Yes | — | CloudConnection UUID for the target AWS account. |
workflow_run_id | string | No | — | Engine DAG run ID stamped onto child steps. |
region | string | No | — | AWS region override. |
name | string | Yes | — | EKS cluster name. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
connection_uuid | uuid | No | — | CloudConnection UUID echoed from input. |
region | string | No | — | AWS region used. |
cluster_name | string | No | — | EKS cluster name. |
cluster_arn | string | No | — | EKS cluster ARN. |
status | string | No | — | Provider cluster status. |
endpoint | string | No | — | Kubernetes API server endpoint. |
certificate_authority_data | string | No | — | Base64 certificate authority data. |
version | string | No | — | Kubernetes version reported by EKS. |
platform_version | string | No | — | EKS platform version. |
role_arn | string | No | — | Control-plane role ARN. |
resources_vpc_config | json | No | — | Provider VPC config returned by EKS. |
kubernetes_network_config | json | No | — | Provider Kubernetes network config. |
logging | json | No | — | Provider logging config. |
identity | json | No | — | Provider identity block. |
tags | json | No | — | Cluster tags. |
cluster | json | No | — | Sanitized provider cluster object. |
failure_reason | string | No | — | Human-readable failure reason. |
failed_step | string | No | — | Failed logical step. |
failed_layer | json | No | — | Failed DAG layer if engine supplies one. |
failed_at_state | string | No | — | State where failure occurred. |
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 | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "aws.eks.describe_cluster",
"initial_data": {
"connection_uuid": "value",
"name": "value"
}
}