Package software.amazon.awscdk.services.ec2

Class CfnTransitGatewayRoute

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.ec2.CfnTransitGatewayRoute

All Implemented Interfaces:

IInspectable, ITransitGatewayRouteRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:03.247Z")
@Stability(Stable)
public class CfnTransitGatewayRoute
extends CfnResource
implements IInspectable, ITransitGatewayRouteRef

Specifies a static route for a transit gateway route table.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 CfnTransitGatewayRoute cfnTransitGatewayRoute = CfnTransitGatewayRoute.Builder.create(this, "MyCfnTransitGatewayRoute")
         .destinationCidrBlock("destinationCidrBlock")
         .transitGatewayRouteTableId("transitGatewayRouteTableId")
         // the properties below are optional
         .blackhole(false)
         .transitGatewayAttachmentId("transitGatewayAttachmentId")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ec2-transitgatewayroute.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnTransitGatewayRoute.Builder	A fluent builder for CfnTransitGatewayRoute.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.ec2.ITransitGatewayRouteRef

ITransitGatewayRouteRef.Jsii$Default, ITransitGatewayRouteRef.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnTransitGatewayRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnTransitGatewayRoute(software.amazon.jsii.JsiiObjectRef objRef)
	CfnTransitGatewayRoute(software.constructs.Construct scope, String id, CfnTransitGatewayRouteProps props)	Create a new AWS::EC2::TransitGatewayRoute.

Method Summary

Modifier and Type	Method	Description
Object	getBlackhole()	Indicates whether to drop traffic that matches this route.
protected Map<String,Object>	getCfnProperties()
String	getDestinationCidrBlock()	The CIDR block used for destination matches.
String	getTransitGatewayAttachmentId()	The ID of the attachment.
TransitGatewayRouteReference	getTransitGatewayRouteRef()	A reference to a TransitGatewayRoute resource.
String	getTransitGatewayRouteTableId()	The ID of the transit gateway route table.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setBlackhole(Boolean value)	Indicates whether to drop traffic that matches this route.
void	setBlackhole(IResolvable value)	Indicates whether to drop traffic that matches this route.
void	setDestinationCidrBlock(String value)	The CIDR block used for destination matches.
void	setTransitGatewayAttachmentId(String value)	The ID of the attachment.
void	setTransitGatewayRouteTableId(String value)	The ID of the transit gateway route table.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnTransitGatewayRoute

protected CfnTransitGatewayRoute(software.amazon.jsii.JsiiObjectRef objRef)

CfnTransitGatewayRoute

protected CfnTransitGatewayRoute(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnTransitGatewayRoute

@Stability(Stable)
public CfnTransitGatewayRoute(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnTransitGatewayRouteProps props)

Create a new AWS::EC2::TransitGatewayRoute.

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTransitGatewayRouteRef

@Stability(Stable)
@NotNull
public TransitGatewayRouteReference getTransitGatewayRouteRef()

A reference to a TransitGatewayRoute resource.

Specified by:

getTransitGatewayRouteRef in interface ITransitGatewayRouteRef

getDestinationCidrBlock

@Stability(Stable)
@NotNull
public String getDestinationCidrBlock()

The CIDR block used for destination matches.

setDestinationCidrBlock

@Stability(Stable)
public void setDestinationCidrBlock(@NotNull
 String value)

The CIDR block used for destination matches.

getTransitGatewayRouteTableId

@Stability(Stable)
@NotNull
public String getTransitGatewayRouteTableId()

The ID of the transit gateway route table.

setTransitGatewayRouteTableId

@Stability(Stable)
public void setTransitGatewayRouteTableId(@NotNull
 String value)

The ID of the transit gateway route table.

getBlackhole

@Stability(Stable)
@Nullable
public Object getBlackhole()

Indicates whether to drop traffic that matches this route.

Returns union: either Boolean or IResolvable

setBlackhole

@Stability(Stable)
public void setBlackhole(@Nullable
 Boolean value)

Indicates whether to drop traffic that matches this route.

setBlackhole

@Stability(Stable)
public void setBlackhole(@Nullable
 IResolvable value)

Indicates whether to drop traffic that matches this route.

getTransitGatewayAttachmentId

@Stability(Stable)
@Nullable
public String getTransitGatewayAttachmentId()

The ID of the attachment.

setTransitGatewayAttachmentId

@Stability(Stable)
public void setTransitGatewayAttachmentId(@Nullable
 String value)

The ID of the attachment.