Describe Cluster
eks.describe_cluster
ActionAmazon Web Servicesconnection required
Calls the AWS eks API (SigV4).
Read a cluster's version, status and endpoint.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Amazon EKS
- Secret shape
- {"access_key_id", "secret_access_key"}
- Config it needs
- region
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
region AWS region (overrides the connection). | string | No | — | — | — |
name Cluster name. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
name | string | — |
status | string | — |
version | string | — |
endpoint | string | — |
arn Cluster ARN — what a tagging or IAM step acts on. | string | — |
platform_version | string | — |
id The cluster's own id. | string | — |
role_arn The IAM role the control plane assumes. | string | — |
created_at When the cluster was created, epoch seconds. | number | — |
tags | object | — |
certificate_authority Base64 CA certificate — a kubeconfig needs it alongside the endpoint. | string | — |
vpc_id | string | — |
subnet_ids | array | — |
security_group_ids | array | — |
cluster_security_group_id | string | — |
health_issues Why the cluster is unhealthy, when it is. | array | — |
{
"arn": "",
"certificate_authority": "",
"cluster_security_group_id": "",
"created_at": 0,
"endpoint": "",
"health_issues": [],
"id": "",
"name": "",
"platform_version": "",
"role_arn": "",
"security_group_ids": [],
"status": "",
"subnet_ids": [],
"tags": {},
"version": "",
"vpc_id": ""
}Related Amazon EKS nodes
See Describe Cluster run in a workflow.
In a technical demo we add the Amazon EKS connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.