Skip to content
Proud to collaborate with Microsoft for Startups

aws.ec2.run_instances ​

Launch one or more EC2 instances using a CloudConnection UUID.

Overview ​

PropertyValue
Workflow typeAtomic
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.
image_idstringYes—AMI ID to launch.
instance_typestringYes—EC2 instance type.
subnet_idstringNo—VPC subnet ID to launch into.
security_group_idslistNo—Security group IDs for the instances.
key_namestringNo—EC2 key pair name for SSH access.
min_countintegerNo—Minimum number of instances to launch.
max_countintegerNo—Maximum number of instances to launch.
iam_instance_profilejsonNo—Provider-native IAM instance profile name or ARN object.
user_datastringNo—Boot-time user data script or cloud-init payload.
block_device_mappingslistNo—Provider-native block device mappings.
metadata_optionsjsonNo—Provider-native IMDS metadata options.
tagsjsonNo—Provider-native TagSpecifications for RunInstances, e.g. [{"ResourceType": "instance", "Tags": [{"Key": "Name", "Value": "web"}]}]. A plain {"Key": "Value"} mapping is rejected by boto3; use aws.ec2.create_instance for key/value tag input.
client_tokenstringNo—Idempotency token for RunInstances. Use this whenever callers may retry after a partial launch.

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo—CloudConnection UUID echoed from input.
regionstringNo—AWS region used.
instance_idslistNo—EC2 instance IDs launched.
instancesjsonNo—Sanitized provider instance objects without user_data.
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—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

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

{
  "workflow_type": "aws.ec2.run_instances",
  "initial_data": {
    "connection_uuid": "value",
    "image_id": "value",
    "instance_type": "value"
  }
}