Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

2.181.1

class TransitGatewayRoute (construct) 🔹

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

Implements IConstruct, IDependable, IResource, ITransitGatewayRoute

Create a Transit Gateway Active Route.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as ec2_alpha from '@aws-cdk/aws-ec2-alpha';

declare const transitGatewayAttachment: ec2_alpha.ITransitGatewayAttachment;
declare const transitGatewayRouteTable: ec2_alpha.TransitGatewayRouteTable;
const transitGatewayRoute = new ec2_alpha.TransitGatewayRoute(this, 'MyTransitGatewayRoute', {
  destinationCidrBlock: 'destinationCidrBlock',
  transitGatewayAttachment: transitGatewayAttachment,
  transitGatewayRouteTable: transitGatewayRouteTable,

  // the properties below are optional
  transitGatewayRouteName: 'transitGatewayRouteName',
});

Initializer

new TransitGatewayRoute(scope: Construct, id: string, props: TransitGatewayRouteProps)

Parameters

Construct Props

NameTypeDescription
destinationCidrBlock🔹stringThe destination CIDR block for this route.
transitGatewayAttachment🔹ITransitGatewayAttachmentThe transit gateway attachment to route the traffic to.
transitGatewayRouteTable🔹ITransitGatewayRouteTableThe transit gateway route table you want to install this route into.
transitGatewayRouteName?🔹stringPhysical name of this Transit Gateway Route.

destinationCidrBlock🔹

Type: string

The destination CIDR block for this route.

Destination Cidr cannot overlap for static routes but is allowed for propagated routes. When overlapping occurs, static routes take precedence over propagated routes.

transitGatewayAttachment🔹

Type: ITransitGatewayAttachment

The transit gateway attachment to route the traffic to.

transitGatewayRouteTable🔹

Type: ITransitGatewayRouteTable

The transit gateway route table you want to install this route into.

transitGatewayRouteName?🔹

Type: string (optional, default: Assigned by CloudFormation.)

Physical name of this Transit Gateway Route.

Properties

NameTypeDescription
destinationCidrBlock🔹stringThe destination CIDR block for this route.
env🔹ResourceEnvironmentThe environment this resource belongs to.
node🔹NodeThe tree node.
resource🔹CfnTransitGatewayRouteThe AWS CloudFormation resource representing the Transit Gateway Route.
routeTable🔹ITransitGatewayRouteTableThe transit gateway route table this route belongs to.
stack🔹StackThe stack in which this resource is defined.

destinationCidrBlock🔹

Type: string

The destination CIDR block for this route.

Destination Cidr cannot overlap for static routes but is allowed for propagated routes. When overlapping occurs, static routes take precedence over propagated routes.

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.

resource🔹

Type: CfnTransitGatewayRoute

The AWS CloudFormation resource representing the Transit Gateway Route.

routeTable🔹

Type: ITransitGatewayRouteTable

The transit gateway route table this route belongs to.

stack🔹

Type: Stack

The stack in which this resource is defined.

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 →