Container for the parameters to the CreateRoute operation. 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.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.EC2.AmazonEC2Request
Amazon.EC2.Model.CreateRouteRequest
Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z
Syntax
public class CreateRouteRequest : AmazonEC2Request IAmazonWebServiceRequest
The CreateRouteRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreateRouteRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
CarrierGatewayId | System.String |
Gets and sets the property 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 | System.String |
Gets and sets the property CoreNetworkArn. The Amazon Resource Name (ARN) of the core network. |
|
|
DestinationCidrBlock | System.String |
Gets and sets the property 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 |
|
|
DestinationIpv6CidrBlock | System.String |
Gets and sets the property DestinationIpv6CidrBlock. The IPv6 CIDR block used for the destination match. Routing decisions are based on the most specific match. |
|
|
DestinationPrefixListId | System.String |
Gets and sets the property DestinationPrefixListId. The ID of a prefix list used for the destination match. |
|
|
EgressOnlyInternetGatewayId | System.String |
Gets and sets the property EgressOnlyInternetGatewayId. [IPv6 traffic only] The ID of an egress-only internet gateway. |
|
|
GatewayId | System.String |
Gets and sets the property GatewayId. The ID of an internet gateway or virtual private gateway attached to your VPC. |
|
|
InstanceId | System.String |
Gets and sets the property 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. |
|
|
LocalGatewayId | System.String |
Gets and sets the property LocalGatewayId. The ID of the local gateway. |
|
|
NatGatewayId | System.String |
Gets and sets the property NatGatewayId. [IPv4 traffic only] The ID of a NAT gateway. |
|
|
NetworkInterfaceId | System.String |
Gets and sets the property NetworkInterfaceId. The ID of a network interface. |
|
|
RouteTableId | System.String |
Gets and sets the property RouteTableId. The ID of the route table for the route. |
|
|
TransitGatewayId | System.String |
Gets and sets the property TransitGatewayId. The ID of a transit gateway. |
|
|
VpcEndpointId | System.String |
Gets and sets the property VpcEndpointId. The ID of a VPC endpoint. Supported for Gateway Load Balancer endpoints only. |
|
|
VpcPeeringConnectionId | System.String |
Gets and sets the property VpcPeeringConnectionId. The ID of a VPC peering connection. |
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.
To create a route
var client = new AmazonEC2Client();
var response = client.CreateRoute(new CreateRouteRequest
{
DestinationCidrBlock = "0.0.0.0/0",
GatewayId = "igw-c0a643a9",
RouteTableId = "rtb-22574640"
});
Version Information
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5