class TransitGatewayRoute (construct) 🔹

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

Implements IConstruct, IDependable, IResource, IEnvironmentAware, 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

• scope Construct
• id string
• props TransitGatewayRouteProps

Construct Props

Name	Type	Description
destinationCidrBlock🔹	string	The destination CIDR block for this route.
transitGatewayAttachment🔹	ITransitGatewayAttachment	The transit gateway attachment to route the traffic to.
transitGatewayRouteTable🔹	ITransitGatewayRouteTable	The transit gateway route table you want to install this route into.
transitGatewayRouteName?🔹	string	Physical 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

Name	Type	Description
destinationCidrBlock🔹	string	The destination CIDR block for this route.
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
resource🔹	CfnTransitGatewayRoute	The AWS CloudFormation resource representing the Transit Gateway Route.
routeTable🔹	ITransitGatewayRouteTable	The transit gateway route table this route belongs to.
stack🔹	Stack	The stack in which this resource is defined.
static PROPERTY_INJECTION_ID🔹	string	Uniquely identifies this class.

---

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

---

static PROPERTY_INJECTION_ID🔹

Type: string

Uniquely identifies this class.

Methods

Name	Description
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.

---

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.