Skip to content
Proud to collaborate with Microsoft for Startups

aws.vpc.wait_nat_gateway_available ​

Wait until a NAT gateway reaches the available state using a CloudConnection UUID.

Overview ​

PropertyValue
Workflow typeLinear
LibraryBase-aws
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes—CloudConnection UUID for the target AWS account.
workflow_run_idstringNo—Engine DAG run ID stamped onto child steps.
regionstringNo—AWS region override.
nat_gateway_idstringYes—NAT gateway ID to wait on.
timeout_secondsintegerNo—Maximum time to wait for available.
poll_interval_secondsintegerNo—Delay between describe attempts.

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo—CloudConnection UUID echoed from input.
regionstringNo—AWS region used.
nat_gateway_idstringNo—NAT gateway ID.
statestringNo—Final NAT gateway state.
availablebooleanNo—True when final state is available.
waited_secondsintegerNo—Approximate seconds spent waiting.
nat_gatewayjsonNo—Sanitized final provider NAT gateway object.
failure_reasonstringNo—Human-readable failure reason.
failed_stepstringNo—Failed logical step.
failed_layerjsonNo—Failed DAG layer if engine supplies one.
failed_at_statestringNo—State where failure occurred.
errorstringNo—Error message.
error_typestringNo—Error class.
failed_atstringNo—ISO failure timestamp.

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—poll—
waitingNoNo———
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingpollwaiting—
waitingpollwaiting—
waitingcompletecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "aws.vpc.wait_nat_gateway_available",
  "initial_data": {
    "connection_uuid": "value",
    "nat_gateway_id": "value"
  }
}