aws.eks.build_kubeconfig

Build a Kubernetes kubeconfig document for an ACTIVE EKS cluster.

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.
cluster_name	string	Yes	—	EKS cluster name.
context_name	string	No	—	Optional kubeconfig context name override.
user_name	string	No	—	Optional kubeconfig user name override.
role_arn	string	No	—	Optional EKS get-token role ARN.
exec_api_version	string	No	—	Kubernetes exec credential API version.
include_yaml	boolean	No	—	Include YAML string output in addition to JSON.

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 used as default context identity.
endpoint	string	No	—	Kubernetes API server endpoint.
certificate_authority_data	string	No	—	Base64 certificate authority data.
context_name	string	No	—	Kubeconfig context name.
user_name	string	No	—	Kubeconfig user name.
kubeconfig	json	No	—	Kubernetes kubeconfig document as JSON.
api_server	string	No	—	Kubernetes API server endpoint for static-token registration.
bearer_token	string	No	—	Short-lived EKS bearer token for immediate verification.
ca_certificate	string	No	—	PEM-encoded Kubernetes API server CA for static-token registration.
kubeconfig_yaml	string	No	—	Kubernetes kubeconfig document as YAML when requested.
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

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "aws.eks.build_kubeconfig",
  "initial_data": {
    "connection_uuid": "value",
    "cluster_name": "value"
  }
}