class RouteTable (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.ec2.Alpha.RouteTable
Go	github.com/aws/aws-cdk-go/awsec2alpha/v2#RouteTable
Java	software.amazon.awscdk.services.ec2.alpha.RouteTable
Python	aws_cdk.aws_ec2_alpha.RouteTable
TypeScript (source)	@aws-cdk/aws-ec2-alpha » RouteTable

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IRouteTable

Creates a route table for the specified VPC.

Example

const stack = new Stack();
const myVpc = new VpcV2(this, 'Vpc');
const vpnGateway = myVpc.enableVpnGatewayV2({
  vpnRoutePropagation: [{ subnetType: SubnetType.PUBLIC }],
  type: VpnConnectionType.IPSEC_1,
});

const routeTable = new RouteTable(stack, 'routeTable', {
  vpc: myVpc
  } );

new Route(stack, 'route', {
  destination: '172.31.0.0/24',
  target: { gateway: vpnGateway },
  routeTable: routeTable,
});

Initializer

new RouteTable(scope: Construct, id: string, props: RouteTableProps)

Parameters

• scope Construct
• id string
• props RouteTableProps

Construct Props

Name	Type	Description
vpc🔹	IVpcV2	The ID of the VPC.
routeTableName?🔹	string	The resource name of the route table.

---

vpc🔹

Type: IVpcV2

The ID of the VPC.

---

routeTableName?🔹

Type: string (optional, default: provisioned without a route table name)

The resource name of the route table.

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
resource🔹	CfnRouteTable	The route table CFN resource.
routeTableId🔹	string	The ID of the route table.
stack🔹	Stack	The stack in which this resource is defined.
static PROPERTY_INJECTION_ID🔹	string	Uniquely identifies this class.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

---

node🔹

Type: Node

The tree node.

---

resource🔹

Type: CfnRouteTable

The route table CFN resource.

---

routeTableId🔹

Type: string

The ID of the route table.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

Name	Description
addRoute(id, destination, target, routeName?)🔹	Adds a new custom route to the route table.
applyCrossStackReferenceStrength(strength)🔹	Override the cross-stack reference strength for this resource.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
toString()🔹	Returns a string representation of this construct.
with(...mixins)🔹	Applies one or more mixins to this construct.

---

addRoute(id, destination, target, routeName?)🔹

public addRoute(id: string, destination: string, target: RouteTargetType, routeName?: string): void

Parameters

• id string
• destination string — The IPv4 or IPv6 CIDR block used for the destination match.
• target RouteTargetType — The gateway or endpoint targeted by the route.
• routeName string — The resource name of the route.

Adds a new custom route to the route table.

---

applyCrossStackReferenceStrength(strength)🔹

public applyCrossStackReferenceStrength(strength: ReferenceStrength): void

Parameters

• strength ReferenceStrength — - The reference strength to use for this resource.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

with(...mixins)🔹

public with(...mixins: IMixin[]): IConstruct

Parameters

• mixins IMixin

Returns

• IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.