aws.vpc.create_route ​
Call AWS EC2 CreateRoute using a CloudConnection UUID.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | Base-aws |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | Authenticated organization UUID used for field resolution and connection scoping. |
connection_uuid | uuid | Yes | — | AWS CloudConnection UUID for the target VPC account, scoped to the caller organization. |
workflow_run_id | string | No | — | Engine DAG run ID stamped onto child steps. |
region | string | No | — | AWS API endpoint region override; omit to use the connection or SDK default. |
destination_prefix_list_id | string | No | — | The ID of a prefix list used for the destination match. |
vpc_endpoint_id | string | No | — | The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only. |
transit_gateway_id | string | No | — | The ID of a transit gateway. |
local_gateway_id | string | No | — | The ID of the local gateway. |
carrier_gateway_id | string | No | — | The ID of the carrier gateway. You can only use this option when the VPC contains a subnet which is associated with a Wavelength Zone. |
core_network_arn | string | No | — | The Amazon Resource Name (ARN) of the core network. |
odb_network_arn | string | No | — | The Amazon Resource Name (ARN) of the ODB network. |
dry_run | boolean | No | — | Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is Dry... |
route_table_id | string | Yes | — | The ID of the route table for the route. |
destination_cidr_block | string | No | — | The IPv4 CIDR address block used for the destination match. Routing decisions are based on the most specific match. We modify the specified CIDR block to its canonical form; for example, if you spe... |
gateway_id | string | No | — | The ID of an internet gateway or virtual private gateway attached to your VPC. |
destination_ipv6_cidr_block | string | No | — | The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match. |
egress_only_internet_gateway_id | string | No | — | [IPv6 traffic only] The ID of an egress-only internet gateway. |
instance_id | string | No | — | The ID of a NAT instance in your VPC. The operation fails if you specify an instance ID unless exactly one network interface is attached. |
network_interface_id | string | No | — | The ID of a network interface. |
vpc_peering_connection_id | string | No | — | The ID of a VPC peering connection. |
nat_gateway_id | string | No | — | [IPv4 traffic only] The ID of a NAT gateway. |
provider_native_request | json | No | — | Optional provider-native request overrides for AWS parameters not yet promoted to first-class fields. |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | No | — | Organization UUID echoed from input. |
connection_uuid | uuid | No | — | AWS CloudConnection UUID echoed from input. |
region | string | No | — | AWS API endpoint region used. |
service | string | No | — | AWS boto3 service/client name. |
operation | string | No | — | AWS API operation invoked. |
request_id | string | No | — | AWS request ID when available. |
response | json | No | — | Sanitized provider response object. |
items | list | No | — | Primary response item list when the API returns a collection. |
result_count | integer | No | — | Count of primary response items. |
next_page_token | string | No | — | Pagination token for the next page. |
failure_reason | string | No | — | Human-readable failure reason. |
failed_step | string | No | — | Failed logical step. |
failed_layer | json | No | — | Failed DAG layer if engine supplies one. |
failed_at_state | string | No | — | State where failure occurred. |
error | string | No | — | Error message. |
error_type | string | No | — | Error class. |
failed_at | string | No | — | ISO failure timestamp. |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "aws.vpc.create_route",
"initial_data": {
"organization_uuid": "value",
"connection_uuid": "value",
"route_table_id": "value"
}
}