class TransitGatewayBlackholeRoute (construct) 🔹

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

Implements IConstruct, IDependable, IResource, ITransitGatewayRoute

Create a Transit Gateway Blackhole 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 transitGatewayRouteTable: ec2_alpha.TransitGatewayRouteTable;
const transitGatewayBlackholeRoute = new ec2_alpha.TransitGatewayBlackholeRoute(this, 'MyTransitGatewayBlackholeRoute', {
  destinationCidrBlock: 'destinationCidrBlock',
  transitGatewayRouteTable: transitGatewayRouteTable,

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

Initializer

new TransitGatewayBlackholeRoute(scope: Construct, id: string, props: TransitGatewayBlackholeRouteProps)

Parameters

scope Construct
id string
props TransitGatewayBlackholeRouteProps

Construct Props

Name	Type	Description
destinationCidrBlock🔹	`string`	The destination CIDR block for this route.
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.

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.
routeTable🔹	`ITransitGatewayRouteTable`	The transit gateway route table this route belongs to.
stack🔹	`Stack`	The 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.

routeTable🔹

Type: ITransitGatewayRouteTable

The transit gateway route table this route belongs to.

stack🔹

Type: Stack

The stack in which this resource is defined.

Methods

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

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.