Skip to content
Proud to collaborate with Microsoft for Startups

cluster.status-eks ​

Read EKS control-plane and optional nodegroup status.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-clusters-aws
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
aws_connection_uuiduuidYes—AWS CloudConnection UUID used for provider calls.
cluster_namestringYes—EKS cluster name.
regionstringYes—AWS region.
nodegroup_namestringNo—Optional managed nodegroup name to include in the status snapshot.
include_nodegroupbooleanNo—Whether to describe the nodegroup when nodegroup_name is supplied.

Output Schema ​

FieldTypeRequiredDefaultDescription
cluster_namestringNo—EKS cluster name.
regionstringNo—AWS region used.
provider_cluster_refstringNo—EKS cluster ARN or name.
cluster_statusstringNo—EKS control-plane status.
nodegroup_statusstringNo—EKS nodegroup status when requested.
readybooleanNo—True when requested EKS resources report active status.
cluster_endpointstringNo—Kubernetes API endpoint.
kubernetes_versionstringNo—Kubernetes version reported by EKS.
clusterjsonNo—Normalized output from aws.eks.describe_cluster.
nodegroupjsonNo—Normalized output from aws.eks.describe_nodegroup.
checked_atstringNo—ISO-8601 status timestamp.
failure_reasonstringNo—Human-readable failure reason.
failed_stepjsonNo—Failed DAG step.
failed_layerjsonNo—Failed DAG layer.
failed_at_statejsonNo—Failed state metadata.
errorstringNo—Error message.
error_typestringNo—Error class.
failed_atstringNo—ISO failure timestamp.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—describe—
describingNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingdescribedescribing—
describingcompletecompleted—
* (any state)failfailed—

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"
  }
}