Skip to content
v2.277.0

Experimental

@aws-cdk/aws-ec2-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

TransitGatewayRouteProps Struct ​

Common properties for a Transit Gateway Route.

Example ​

ts
// 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 transitGatewayRouteProps: ec2_alpha.TransitGatewayRouteProps = {
  destinationCidrBlock: 'destinationCidrBlock',
  transitGatewayAttachment: transitGatewayAttachment,
  transitGatewayRouteTable: transitGatewayRouteTable,

  // the properties below are optional
  transitGatewayRouteName: 'transitGatewayRouteName',
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ec2_alpha as ec2_alpha

# transit_gateway_attachment: ec2_alpha.ITransitGatewayAttachment
# transit_gateway_route_table: ec2_alpha.TransitGatewayRouteTable

transit_gateway_route_props = ec2_alpha.TransitGatewayRouteProps(
    destination_cidr_block="destinationCidrBlock",
    transit_gateway_attachment=transit_gateway_attachment,
    transit_gateway_route_table=transit_gateway_route_table,

    # the properties below are optional
    transit_gateway_route_name="transitGatewayRouteName"
)
java
// 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.alpha.*;

ITransitGatewayAttachment transitGatewayAttachment;
TransitGatewayRouteTable transitGatewayRouteTable;

TransitGatewayRouteProps transitGatewayRouteProps = TransitGatewayRouteProps.builder()
        .destinationCidrBlock("destinationCidrBlock")
        .transitGatewayAttachment(transitGatewayAttachment)
        .transitGatewayRouteTable(transitGatewayRouteTable)

        // the properties below are optional
        .transitGatewayRouteName("transitGatewayRouteName")
        .build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.ec2.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ec2.Alpha;

ITransitGatewayAttachment transitGatewayAttachment;
TransitGatewayRouteTable transitGatewayRouteTable;

var transitGatewayRouteProps = new TransitGatewayRouteProps {
    DestinationCidrBlock = "destinationCidrBlock",
    TransitGatewayAttachment = transitGatewayAttachment,
    TransitGatewayRouteTable = transitGatewayRouteTable,

    // the properties below are optional
    TransitGatewayRouteName = "transitGatewayRouteName"
};
go
// Install: go get github.com/aws/aws-cdk-go/awsec2alpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import ec2_alpha "github.com/aws/aws-cdk-go/awsec2alpha"

var transitGatewayAttachment ITransitGatewayAttachment
var transitGatewayRouteTable TransitGatewayRouteTable

transitGatewayRouteProps := &TransitGatewayRouteProps{
	DestinationCidrBlock: jsii.String("destinationCidrBlock"),
	TransitGatewayAttachment: transitGatewayAttachment,
	TransitGatewayRouteTable: transitGatewayRouteTable,

	// the properties below are optional
	TransitGatewayRouteName: jsii.String("transitGatewayRouteName"),
}

Properties ​

destinationCidrBlockstringdestination_cidr_blockstrdestinationCidrBlockStringDestinationCidrBlockstringDestinationCidrBlock*string required #
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.

transitGatewayAttachmentITransitGatewayAttachmenttransit_gateway_attachmentITransitGatewayAttachmenttransitGatewayAttachmentITransitGatewayAttachmentTransitGatewayAttachmentITransitGatewayAttachmentTransitGatewayAttachmentITransitGatewayAttachment required #
The transit gateway attachment to route the traffic to.
transitGatewayRouteNameoptionalstringtransit_gateway_route_nameoptionalstrtransitGatewayRouteNameoptionalStringTransitGatewayRouteNameoptionalstringTransitGatewayRouteNameoptional*string #
Physical name of this Transit Gateway Route.

Default: Assigned by CloudFormation.

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