Skip to content
Proud to collaborate with Microsoft for Startups

cluster.status-aws-vm ​

Return provider status for an AWS VM-backed cluster.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-clusters-aws
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization UUID for audit context.
provider_connection_uuiduuidNo—AWS CloudConnection UUID.
aws_connection_uuiduuidNo—AWS CloudConnection UUID alias.
provider_cluster_refstringNo—EC2 instance ID backing the cluster.
instance_idstringNo—EC2 instance ID alias.
regionstringNo—AWS region.
actorstringNo—Caller requesting status.
timeout_secondsintegerNo—Reserved for future polling status reads.

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization UUID for audit context.
provider_connection_uuiduuidNo—AWS CloudConnection UUID.
aws_connection_uuiduuidNo—AWS CloudConnection UUID alias.
provider_cluster_refstringNo—EC2 instance ID backing the cluster.
instance_idstringNo—EC2 instance ID alias.
regionstringNo—AWS region.
actorstringNo—Caller requesting status.
timeout_secondsintegerNo—Reserved for future polling status reads.
describe_instancejsonNo—Output from aws.ec2.describe_instance.
provider_statusjsonNo—Normalized provider status object.
statusstringNo—Normalized lifecycle status.
phasestringNo—Raw EC2 instance phase.
reachablebooleanNo—True when the backing VM is running.
private_ipstringNo—VM private IP.
public_ipstringNo—VM public IP if present.
checked_atstringNo—ISO 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_instance—
describing_instanceNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingdescribe_instancedescribing_instance—
describing_instancecompletecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "cluster.status-aws-vm",
  "initial_data": {
    "organization_uuid": "value",
    "provider_connection_uuid": "value",
    "aws_connection_uuid": "value",
    "provider_cluster_ref": "value"
  }
}