Skip to content
Proud to collaborate with Microsoft for Startups

aws.ec2.create_instance_with_user_data ​

Launch one EC2 instance with boot-time user data using a CloudConnection UUID.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryBase-aws
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidYes—CloudConnection UUID for the target AWS account.
regionstringNo—AWS region override.
ami_idstringYes—AMI ID to launch.
instance_typestringYes—EC2 instance type.
subnet_idstringYes—VPC subnet ID to launch into.
security_group_idslistYes—Security group IDs for the instance.
user_datastringYes—Boot-time user data script or cloud-init payload.
user_data_base64_encodedbooleanNo—True when user_data is already base64 encoded.
key_namestringNo—EC2 key pair name for SSH access.
iam_instance_profilejsonNo—Provider-native IAM instance profile name or ARN object.
associate_public_ip_addressbooleanNo—Whether to associate a public IPv4 address.
private_ip_addressstringNo—Optional primary private IPv4 address.
block_device_mappingslistNo—Provider-native block device mappings.
metadata_optionsjsonNo—Provider-native IMDS metadata options.
instance_initiated_shutdown_behaviorstringNo—stop or terminate.
tagsjsonNo—Tags to apply to the instance as a key/value map (or a native TagSpecifications list).
client_tokenstringNo—Idempotency token for RunInstances.
wait_until_runningbooleanNo—Wait for running state before completing.

Output Schema ​

FieldTypeRequiredDefaultDescription
connection_uuiduuidNo—CloudConnection UUID echoed from input.
regionstringNo—AWS region used.
instance_idstringNo—EC2 instance ID.
statestringNo—EC2 instance state.
private_ipstringNo—Private IPv4 address assigned to the instance.
public_ipstringNo—Public IPv4 address assigned to the instance.
image_idstringNo—AMI ID used.
instance_typestringNo—EC2 instance type used.
subnet_idstringNo—Subnet ID used.
vpc_idstringNo—VPC ID reported by EC2.
launch_timestringNo—Provider launch timestamp as ISO string when available.
instancejsonNo—Sanitized provider instance object without user_data.
compensation_workflowstringNo—Suggested compensation workflow aws.ec2.terminate_instance.
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.create_instance_with_user_data",
  "initial_data": {
    "connection_uuid": "value",
    "ami_id": "value",
    "instance_type": "value",
    "subnet_id": "value"
  }
}