runner.register_ec2_task_definition ​
Register ECS task definition for EC2 runner environment
Register an ECS task definition for EC2-backed runner executions.
Key differences from the Fargate task definition:
- networkMode = "bridge" (Fargate uses "awsvpc")
- requiresCompatibilities = ["EC2"]
- CPU and memory are set at the container level, not the task level
- No task-level executionRoleArn required
Outputs: task_definition_arn, task_definition_revision
Overview ​
| Property | Value |
|---|---|
| Workflow type | Linear |
| Library | App-runners-aws |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_group_uuid | uuid | Yes | — | UUID of the RunnerGroup this EC2 environment step operates on, picked from the organization's list of runner groups. |
organization_uuid | uuid | No | — | UUID of the caller's organization, injected server-side from the authenticated request; scopes the operation to the correct tenant. |
workflow_run_id | string | No | — | — |
workflow_run_uuid | string | No | — | Internal engine correlation/run identifier stamped onto this DAG-step execution; not a user-facing entity reference and has no picker. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
runner_group_uuid | uuid | No | — | UUID of the RunnerGroup this workflow operates on, picked from the organization's list of runner groups. Optional on this shared passthrough schema because the same field also appears as an output-only echo. |
organization_uuid | uuid | No | — | UUID of the caller's organization, injected server-side from the authenticated request; scopes the operation to the correct tenant. |
registry_account_uuid | uuid | No | — | UUID of the container registry account this runner group resolves images against, picked from the organization's registry accounts. Optional — falls back to default/unauthenticated image resolution when absent. |
actor_uuid | uuid | No | — | UUID of the user or service actor who triggered this action, injected server-side from the authenticated request when available; used for audit/attribution only. |
workflow_run_id | string | No | — | — |
workflow_run_uuid | string | No | — | Legacy alias of workflow_run_id: an internal engine correlation/run identifier for this DAG execution (ADR-015/E1 plumbing), not a foreign key to any business entity. No list/query workflow applies — this is engine-generated, never user-supplied. |
workflow_uuid | string | No | — | Engine workflow-run identifier associated with this record; not a platform entity foreign key despite the name. No list/query workflow applies — this is engine-generated, never user-supplied. |
status | string | No | — | — |
outcome | string | No | — | — |
initiated_at | string | No | — | — |
completed_at | string | No | — | — |
failed_at | string | No | — | — |
failure_reason | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
reason | string | No | — | — |
failed_step | json | No | — | — |
failed_layer | json | No | — | — |
failed_at_state | json | No | — | — |
compensation_trigger | json | No | — | — |
comp_current_layer | json | No | — | — |
comp_queue | json | No | — | — |
comp_retry_count | json | No | — | — |
primitive_input | json | No | — | — |
primitive_output | json | No | — | — |
step_output | json | No | — | — |
backend_type | json | No | — | — |
cloud_connection_uuid | json | No | — | UUID of the CloudConnection backing this runner group's cloud backend, picked from the organization's connections. |
region | json | No | — | — |
vpc_ref | json | No | — | — |
subnet_refs | json | No | — | — |
security_group_refs | json | No | — | — |
instance_type | json | No | — | — |
cluster_name | json | No | — | — |
cluster_arn | json | No | — | — |
log_group_name | json | No | — | — |
task_definition_arn | json | No | — | — |
task_definition_revision | json | No | — | — |
asg_name | json | No | — | — |
capacity_provider_name | json | No | — | — |
active_executions_count | json | No | — | — |
active_executions_skipped | json | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
initiated | Yes | No | — | run | — |
run | No | No | — | complete | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
initiated | run | run | — |
run | complete | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "runner.register_ec2_task_definition",
"initial_data": {
"runner_group_uuid": "value"
}
}