AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::EC2::Route

CfnRoute

Specifies a route in a route table. For more information, see [Routes](https://docs.aws.amazon.com/vpc/latest/userguide/VPC_Route_Tables.html#route-table-routes) in the *Amazon VPC User Guide* . You must specify either a destination CIDR block or prefix list ID. You must also specify exactly one of the resources as the target. If you create a route that references a transit gateway in the same template where you create the transit gateway, you must declare a dependency on the transit gateway attachment. The route table cannot use the transit gateway until it has successfully attached to the VPC. Add a [DependsOn Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) in the `AWS::EC2::Route` resource to explicitly declare a dependency on the `AWS::EC2::TransitGatewayAttachment` resource.

Import

import { CfnRoute } from 'aws-cdk-lib/aws-ec2';

Or use the module namespace:

import * as ec2 from 'aws-cdk-lib/aws-ec2';
// ec2.CfnRoute

Properties

Configuration passed to the constructor as CfnRouteProps.

routeTableIdRequired
string | IRouteTableRef

The ID of the route table for the route.

carrierGatewayIdOptional
string | ICarrierGatewayRef

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.

coreNetworkArnOptional
string

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

destinationCidrBlockOptional
string

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

destinationIpv6CidrBlockOptional
string

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

destinationPrefixListIdOptional
string

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

egressOnlyInternetGatewayIdOptional
string | IEgressOnlyInternetGatewayRef

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

gatewayIdOptional
string | IInternetGatewayRef | IVPNGatewayRef

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

instanceIdOptional
string | IInstanceRef

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.

localGatewayIdOptional
string

The ID of the local gateway.

natGatewayIdOptional
string | INatGatewayRef

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

networkInterfaceIdOptional
string

The ID of a network interface.

transitGatewayIdOptional
string | ITransitGatewayRef

The ID of a transit gateway.

vpcEndpointIdOptional
string

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

vpcPeeringConnectionIdOptional
string | IVPCPeeringConnectionRef

The ID of a VPC peering connection.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::EC2::RouteView in CloudFormation Explorer

Get the Amazon EC2 Cheat Sheet

Everything you need to know about Amazon EC2 on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-ec2
CFN TypeAWS::EC2::Route
Properties15

Related Constructs

Explore This Service

External Links