GET

/#Action=CreateRoute

http://ec2.{region}.amazonaws.com/#Action=CreateRoute

Creates a route in a route table within a VPC. You must specify either a destination CIDR block or a prefix list ID. You must also specify exactly one of the resources from the parameter list. When determining how to route traffic, we use the route with the most specific match. For example, traffic is destined for the IPv4 address <code>192.0.2.3</code>, and the route table includes the following two IPv4 routes: <ul> <li> <code>192.0.2.0/24</code> (goes to some target A) </li> <li> <code>192.0.2.0/28</code> (goes to some target B) </li> </ul> Both routes apply to the traffic destined for <code>192.0.2.3</code>. However, the second route in the list covers a smaller number of IP addresses and is therefore more specific, so we use that route to determine where to target the traffic. For more information about route tables, see <a href="https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html">Route tables</a> in the Amazon Virtual Private Cloud User Guide.

Access Token Required: API Key

Query Params

DestinationCidrBlockstring

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 specify <code>100.68.0.18/18</code>, we modify it to <code>100.68.0.0/18</code>.

DestinationIpv6CidrBlockstring

The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match.

DestinationPrefixListIdstring

The ID of a prefix list used for the destination match.

DryRunboolean

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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.

VpcEndpointIdstring

The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only.

EgressOnlyInternetGatewayIdstring

[IPv6 traffic only] The ID of an egress-only internet gateway.

GatewayIdstring

The ID of an internet gateway or virtual private gateway attached to your VPC.

InstanceIdstring

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.

NatGatewayIdstring

[IPv4 traffic only] The ID of a NAT gateway.

TransitGatewayIdstring

The ID of a transit gateway.

LocalGatewayIdstring

The ID of the local gateway.

CarrierGatewayIdstring

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.

NetworkInterfaceIdstring

The ID of a network interface.

RouteTableIdstringrequired

The ID of the route table for the route.

VpcPeeringConnectionIdstring

The ID of a VPC peering connection.

CoreNetworkArnstring

The Amazon Resource Name (ARN) of the core network.

Actionstringrequired

Allowed:

Versionstringrequired

Allowed:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://ec2.{region}.amazonaws.com/#Action=CreateRoute' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}