2.168.0

class Route (construct) 🔹

LanguageType name
.NETAmazon.CDK.AWS.ec2.Alpha.Route
Gogithub.com/aws/aws-cdk-go/awsec2alpha/v2#Route
Javasoftware.amazon.awscdk.services.ec2.alpha.Route
Pythonaws_cdk.aws_ec2_alpha.Route
TypeScript (source)@aws-cdk/aws-ec2-alpha » Route

Implements IConstruct, IDependable, IResource, IRouteV2

Creates a new route with added functionality.

Example


const myVpc = new VpcV2(this, 'Vpc');
const routeTable = new RouteTable(this, 'RouteTable', {
  vpc: myVpc,
});
const subnet = new SubnetV2(this, 'Subnet', {
  vpc: myVpc,
  availabilityZone: 'eu-west-2a',
  ipv4CidrBlock: new IpCidr('10.0.0.0/24'),
  subnetType: SubnetType.PRIVATE_ISOLATED });

const natgw = new NatGateway(this, 'NatGW', {
  subnet: subnet,
  vpc: myVpc,
  connectivityType: NatConnectivityType.PRIVATE,
  privateIpAddress: '10.0.0.42',
});
new Route(this, 'NatGwRoute', {
  routeTable,
  destination: '0.0.0.0/0',
  target: { gateway: natgw },
});

Initializer

new Route(scope: Construct, id: string, props: RouteProps)

Parameters

Construct Props

NameTypeDescription
destination🔹stringThe IPv4 or IPv6 CIDR block used for the destination match.
routeTable🔹IRouteTableThe ID of the route table for the route.
target🔹RouteTargetTypeThe gateway or endpoint targeted by the route.
routeName?🔹stringThe resource name of the route.

destination🔹

Type: string

The IPv4 or IPv6 CIDR block used for the destination match.

Routing decisions are based on the most specific match.

routeTable🔹

Type: IRouteTable

The ID of the route table for the route.

target🔹

Type: RouteTargetType

The gateway or endpoint targeted by the route.

routeName?🔹

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

The resource name of the route.

Properties

NameTypeDescription
destination🔹stringThe IPv4 or IPv6 CIDR block used for the destination match.
env🔹ResourceEnvironmentThe environment this resource belongs to.
node🔹NodeThe tree node.
routeTable🔹IRouteTableThe route table for the route.
stack🔹StackThe stack in which this resource is defined.
target🔹RouteTargetTypeThe gateway or endpoint targeted by the route.
targetRouterType🔹RouterTypeThe type of router the route is targetting.
resource?🔹CfnRouteThe route CFN resource.

destination🔹

Type: string

The IPv4 or IPv6 CIDR block used for the destination match.

Routing decisions are based on the most specific match.

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

node🔹

Type: Node

The tree node.

routeTable🔹

Type: IRouteTable

The route table for the route.

stack🔹

Type: Stack

The stack in which this resource is defined.

target🔹

Type: RouteTargetType

The gateway or endpoint targeted by the route.

targetRouterType🔹

Type: RouterType

The type of router the route is targetting.

resource?🔹

Type: CfnRoute (optional)

The route CFN resource.

Methods

NameDescription
applyRemovalPolicy(policy)🔹Apply the given removal policy to this resource.
toString()🔹Returns a string representation of this construct.

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

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.

← PreviousNext →