AWS CDK Reference

Appearance

v2.273.0

CfnTransitGatewayProps Struct ​

Properties for defining a CfnTransitGateway.

Source
Generated code
Type last changed
v2.224.0 · 13 Nov 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
const cfnTransitGatewayProps: ec2.CfnTransitGatewayProps = {
  amazonSideAsn: 123,
  associationDefaultRouteTableId: 'associationDefaultRouteTableId',
  autoAcceptSharedAttachments: 'autoAcceptSharedAttachments',
  defaultRouteTableAssociation: 'defaultRouteTableAssociation',
  defaultRouteTablePropagation: 'defaultRouteTablePropagation',
  description: 'description',
  dnsSupport: 'dnsSupport',
  encryptionSupport: 'encryptionSupport',
  multicastSupport: 'multicastSupport',
  propagationDefaultRouteTableId: 'propagationDefaultRouteTableId',
  securityGroupReferencingSupport: 'securityGroupReferencingSupport',
  tags: [{
    key: 'key',
    value: 'value',
  }],
  transitGatewayCidrBlocks: ['transitGatewayCidrBlocks'],
  vpnEcmpSupport: 'vpnEcmpSupport',
};

Properties ​

amazonSideAsnnumberamazon_side_asnint | floatamazonSideAsnNumberAmazonSideAsndoubleAmazonSideAsn*float64#
A private Autonomous System Number (ASN) for the Amazon side of a BGP session.

The range is 64512 to 65534 for 16-bit ASNs. The default is 64512.

associationDefaultRouteTableIdstringassociation_default_route_table_idstrassociationDefaultRouteTableIdStringAssociationDefaultRouteTableIdstringAssociationDefaultRouteTableId*string#
The ID of the default association route table.
autoAcceptSharedAttachmentsstringauto_accept_shared_attachmentsstrautoAcceptSharedAttachmentsStringAutoAcceptSharedAttachmentsstringAutoAcceptSharedAttachments*string#
Enable or disable automatic acceptance of attachment requests.

Disabled by default.

defaultRouteTableAssociationstringdefault_route_table_associationstrdefaultRouteTableAssociationStringDefaultRouteTableAssociationstringDefaultRouteTableAssociation*string#
Enable or disable automatic association with the default association route table.

Enabled by default. If DefaultRouteTableAssociation is set to enable, AWS Transit Gateway will create the default transit gateway route table.

defaultRouteTablePropagationstringdefault_route_table_propagationstrdefaultRouteTablePropagationStringDefaultRouteTablePropagationstringDefaultRouteTablePropagation*string#
Enable or disable automatic propagation of routes to the default propagation route table.

Enabled by default. If DefaultRouteTablePropagation is set to enable, AWS Transit Gateway will create the default transit gateway route table.

descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#
The description of the transit gateway.
dnsSupportstringdns_supportstrdnsSupportStringDnsSupportstringDnsSupport*string#
Enable or disable DNS support.

Enabled by default.

encryptionSupportstringencryption_supportstrencryptionSupportStringEncryptionSupportstringEncryptionSupport*string#
Enable or disable encryption support.

Disabled by default.

multicastSupportstringmulticast_supportstrmulticastSupportStringMulticastSupportstringMulticastSupport*string#
Indicates whether multicast is enabled on the transit gateway.
propagationDefaultRouteTableIdstringpropagation_default_route_table_idstrpropagationDefaultRouteTableIdStringPropagationDefaultRouteTableIdstringPropagationDefaultRouteTableId*string#
The ID of the default propagation route table.
securityGroupReferencingSupportstringsecurity_group_referencing_supportstrsecurityGroupReferencingSupportStringSecurityGroupReferencingSupportstringSecurityGroupReferencingSupport*string#
Enables you to reference a security group across VPCs attached to a transit gateway (TGW).
notes

Use this option to simplify security group management and control of instance-to-instance traffic across VPCs that are connected by transit gateway. You can also use this option to migrate from VPC peering (which was the only option that supported security group referencing) to transit gateways (which now also support security group referencing). This option is disabled by default and there are no additional costs to use this feature.

For important information about this feature, see Create a transit gateway in the AWS Transit Gateway Guide .

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
The tags for the transit gateway.
transitGatewayCidrBlocksstring[]transit_gateway_cidr_blockstyping.List[str]transitGatewayCidrBlocksList<String>TransitGatewayCidrBlocksstring[]TransitGatewayCidrBlocks*[]*string#
The transit gateway CIDR blocks.
vpnEcmpSupportstringvpn_ecmp_supportstrvpnEcmpSupportStringVpnEcmpSupportstringVpnEcmpSupport*string#
Enable or disable Equal Cost Multipath Protocol support.

Enabled by default.

Used as props by ​