Creates a route in a route table within a VPC¶

Description¶

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 192.0.2.3, and the route table includes the following two IPv4 routes:

192.0.2.0/24 (goes to some target A)
192.0.2.0/28 (goes to some target B)

Both routes apply to the traffic destined for 192.0.2.3. 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 Route tables in the Amazon VPC User Guide.

Usage¶

ec2_create_route(DestinationPrefixListId, VpcEndpointId,
  TransitGatewayId, LocalGatewayId, CarrierGatewayId, CoreNetworkArn,
  OdbNetworkArn, DryRun, RouteTableId, DestinationCidrBlock, GatewayId,
  DestinationIpv6CidrBlock, EgressOnlyInternetGatewayId, InstanceId,
  NetworkInterfaceId, VpcPeeringConnectionId, NatGatewayId)

Arguments¶

DestinationPrefixListId

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

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

The ID of a transit gateway.
LocalGatewayId

The ID of the local gateway.
CarrierGatewayId

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.
CoreNetworkArn

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

The Amazon Resource Name (ARN) of the ODB network.
DryRun

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

[required] The ID of the route table for the route.
DestinationCidrBlock

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

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

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

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

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.
NetworkInterfaceId

The ID of a network interface.
VpcPeeringConnectionId

The ID of a VPC peering connection.
NatGatewayId

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

Value¶

A list with the following syntax:

list(
  Return = TRUE|FALSE
)

Request syntax¶

svc$create_route(
  DestinationPrefixListId = "string",
  VpcEndpointId = "string",
  TransitGatewayId = "string",
  LocalGatewayId = "string",
  CarrierGatewayId = "string",
  CoreNetworkArn = "string",
  OdbNetworkArn = "string",
  DryRun = TRUE|FALSE,
  RouteTableId = "string",
  DestinationCidrBlock = "string",
  GatewayId = "string",
  DestinationIpv6CidrBlock = "string",
  EgressOnlyInternetGatewayId = "string",
  InstanceId = "string",
  NetworkInterfaceId = "string",
  VpcPeeringConnectionId = "string",
  NatGatewayId = "string"
)

Examples¶

# This example creates a route for the specified route table. The route
# matches all traffic (0.0.0.0/0) and routes it to the specified Internet
# gateway.
svc$create_route(
  DestinationCidrBlock = "0.0.0.0/0",
  GatewayId = "igw-c0a643a9",
  RouteTableId = "rtb-22574640"
)