Skip to content
Proud to collaborate with Microsoft for Startups

cluster.delete-aws-vm ​

Delete an AWS VM-backed cluster by terminating its EC2 instance.

Overview ​

PropertyValue
Workflow typeLinear
LibraryApp-clusters-aws
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization UUID for audit context.
aws_connection_uuiduuidNo—AWS CloudConnection UUID.
provider_connection_uuiduuidNo—AWS CloudConnection UUID alias.
instance_idstringNo—EC2 instance ID provider reference.
provider_cluster_refstringNo—EC2 instance ID alias.
cluster_namestringNo—Logical cluster name for caller correlation.
regionstringNo—AWS region.
ignore_missingbooleanNo—Treat missing instance as successful deletion.
actorstringNo—Caller initiating deletion.

Output Schema ​

FieldTypeRequiredDefaultDescription
organization_uuiduuidNo—Organization UUID for audit context.
aws_connection_uuiduuidNo—AWS CloudConnection UUID.
provider_connection_uuiduuidNo—AWS CloudConnection UUID alias.
instance_idstringNo—EC2 instance ID provider reference.
provider_cluster_refstringNo—EC2 instance ID alias.
cluster_namestringNo—Logical cluster name for caller correlation.
regionstringNo—AWS region.
ignore_missingbooleanNo—Treat missing instance as successful deletion.
actorstringNo—Caller initiating deletion.
describe_instancejsonNo—Pre-delete aws.ec2.describe_instance output.
terminate_instancejsonNo—Output from aws.ec2.terminate_instance.
final_statestringNo—Final EC2 state reported by AWS.
existedbooleanNo—Whether the instance existed before delete.
deletedbooleanNo—True when the instance is terminated or absent under ignore_missing.
statusstringNo—Aggregated delete status.
completed_atstringNo—ISO completion 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—delete_instance—
deleting_instanceNoNo—complete—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingdelete_instancedeleting_instance—
deleting_instancecompletecompleted—
* (any state)failfailed—

API Usage ​

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

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