TransitGateway L2 construct
Creates a Transit Gateway.
Example
const transitGateway = new TransitGateway(this, 'MyTransitGateway');
const routeTable = transitGateway.addRouteTable('CustomRouteTable');
const myVpc = new VpcV2(this, 'Vpc');
const subnet = new SubnetV2(this, 'Subnet', {
vpc: myVpc,
availabilityZone: 'eu-west-2a',
ipv4CidrBlock: new IpCidr('10.0.0.0/24'),
subnetType: SubnetType.PUBLIC
});
const attachment = transitGateway.attachVpc('VpcAttachment', {
vpc: myVpc,
subnets: [subnet]
});
// Associate an attachment with a route table
routeTable.addAssociation('Association', attachment);
// Enable route propagation for an attachment
routeTable.enablePropagation('Propagation', attachment);
transit_gateway = TransitGateway(self, "MyTransitGateway")
route_table = transit_gateway.add_route_table("CustomRouteTable")
my_vpc = VpcV2(self, "Vpc")
subnet = SubnetV2(self, "Subnet",
vpc=my_vpc,
availability_zone="eu-west-2a",
ipv4_cidr_block=IpCidr("10.0.0.0/24"),
subnet_type=SubnetType.PUBLIC
)
attachment = transit_gateway.attach_vpc("VpcAttachment",
vpc=my_vpc,
subnets=[subnet]
)
# Associate an attachment with a route table
route_table.add_association("Association", attachment)
# Enable route propagation for an attachment
route_table.enable_propagation("Propagation", attachment)
TransitGateway transitGateway = new TransitGateway(this, "MyTransitGateway");
ITransitGatewayRouteTable routeTable = transitGateway.addRouteTable("CustomRouteTable");
VpcV2 myVpc = new VpcV2(this, "Vpc");
SubnetV2 subnet = SubnetV2.Builder.create(this, "Subnet")
.vpc(myVpc)
.availabilityZone("eu-west-2a")
.ipv4CidrBlock(new IpCidr("10.0.0.0/24"))
.subnetType(SubnetType.PUBLIC)
.build();
ITransitGatewayVpcAttachment attachment = transitGateway.attachVpc("VpcAttachment", AttachVpcOptions.builder()
.vpc(myVpc)
.subnets(List.of(subnet))
.build());
// Associate an attachment with a route table
routeTable.addAssociation("Association", attachment);
// Enable route propagation for an attachment
routeTable.enablePropagation("Propagation", attachment);
// Install: dotnet add package Amazon.CDK.AWS.ec2.Alpha
var transitGateway = new TransitGateway(this, "MyTransitGateway");
var routeTable = transitGateway.AddRouteTable("CustomRouteTable");
var myVpc = new VpcV2(this, "Vpc");
var subnet = new SubnetV2(this, "Subnet", new SubnetV2Props {
Vpc = myVpc,
AvailabilityZone = "eu-west-2a",
Ipv4CidrBlock = new IpCidr("10.0.0.0/24"),
SubnetType = SubnetType.PUBLIC
});
var attachment = transitGateway.AttachVpc("VpcAttachment", new AttachVpcOptions {
Vpc = myVpc,
Subnets = new [] { subnet }
});
// Associate an attachment with a route table
routeTable.AddAssociation("Association", attachment);
// Enable route propagation for an attachment
routeTable.EnablePropagation("Propagation", attachment);
// Install: go get github.com/aws/aws-cdk-go/awsec2alpha/v2
transitGateway := awsec2alpha.NewTransitGateway(this, jsii.String("MyTransitGateway"))
routeTable := transitGateway.addRouteTable(jsii.String("CustomRouteTable"))
myVpc := awsec2alpha.NewVpcV2(this, jsii.String("Vpc"))
subnet := awsec2alpha.NewSubnetV2(this, jsii.String("Subnet"), &SubnetV2Props{
Vpc: myVpc,
AvailabilityZone: jsii.String("eu-west-2a"),
Ipv4CidrBlock: awsec2alpha.NewIpCidr(jsii.String("10.0.0.0/24")),
SubnetType: awscdk.SubnetType_PUBLIC,
})
attachment := transitGateway.attachVpc(jsii.String("VpcAttachment"), &AttachVpcOptions{
Vpc: myVpc,
Subnets: []ISubnet{
subnet,
},
})
// Associate an attachment with a route table
routeTable.AddAssociation(jsii.String("Association"), attachment)
// Enable route propagation for an attachment
routeTable.EnablePropagation(jsii.String("Propagation"), attachment)
Initializer
new TransitGateway(scope: Construct, id: string, props?: TransitGatewayProps)
TransitGateway(scope: Construct, id: str, props: typing.Optional[TransitGatewayProps] = None)
new TransitGateway(Construct scope, String id, TransitGatewayProps props)
new TransitGateway(Construct scope, string id, TransitGatewayProps? props = null)
NewTransitGateway(Scope Construct, Id *string, Props TransitGatewayProps)
Construct Props
amazonSideAsnnumberamazon_side_asnint | floatamazonSideAsnNumberAmazonSideAsndoubleAmazonSideAsn*float64= undefined, 64512 is assigned by …#The range is 64512 to 65534 for 16-bit ASNs.
default
Default: undefined, 64512 is assigned by CloudFormation.
defaultRouteTableAssociationbooleandefault_route_table_associationbooldefaultRouteTableAssociationBooleanDefaultRouteTableAssociationboolDefaultRouteTableAssociation*bool= enable (true)#defaultRouteTablePropagationbooleandefault_route_table_propagationbooldefaultRouteTablePropagationBooleanDefaultRouteTablePropagationboolDefaultRouteTablePropagation*bool= enable (true)#descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string= no description#If dnsSupport is enabled on a VPC Attachment, this also needs to be enabled for the feature to work. Otherwise the resources will still deploy but the feature will not work.
securityGroupReferencingSupportbooleansecurity_group_referencing_supportboolsecurityGroupReferencingSupportBooleanSecurityGroupReferencingSupportboolSecurityGroupReferencingSupport*bool= disable (false)#If securityGroupReferencingSupport is enabled on a VPC Attachment, this also needs to be enabled for the feature to work. Otherwise the resources will still deploy but the feature will not work.
transitGatewayCidrBlocksstring[]transit_gateway_cidr_blockstyping.List[str]transitGatewayCidrBlocksList<String>TransitGatewayCidrBlocksstring[]TransitGatewayCidrBlocks*[]*string= none#transitGatewayNamestringtransit_gateway_namestrtransitGatewayNameStringTransitGatewayNamestringTransitGatewayName*string= Assigned by CloudFormation.#Properties
defaultRouteTableITransitGatewayRouteTabledefault_route_tableITransitGatewayRouteTabledefaultRouteTableITransitGatewayRouteTableDefaultRouteTableITransitGatewayRouteTableDefaultRouteTableITransitGatewayRouteTablerequired#This route table is created by the CDK and is used to manage the routes for attachments that do not have an explicitly defined route table association.
defaultRouteTableAssociationbooleandefault_route_table_associationbooldefaultRouteTableAssociationBooleanDefaultRouteTableAssociationboolDefaultRouteTableAssociation*boolrequired#If set to true, any VPC or VPN attachment will be automatically associated with the default route table unless otherwise specified.
defaultRouteTablePropagationbooleandefault_route_table_propagationbooldefaultRouteTablePropagationBooleanDefaultRouteTablePropagationboolDefaultRouteTablePropagation*boolrequired#When set to true, routes from attachments will be automatically propagated to the default route table unless propagation is explicitly disabled.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
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.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#routerTargetIdstringrouter_target_idstrrouterTargetIdStringRouterTargetIdstringRouterTargetId*stringrequired#routerTypeRouterTyperouter_typeRouterTyperouterTypeRouterTypeRouterTypeRouterTypeRouterTypeRouterTyperequired#securityGroupReferencingSupportbooleansecurity_group_referencing_supportboolsecurityGroupReferencingSupportBooleanSecurityGroupReferencingSupportboolSecurityGroupReferencingSupport*boolrequired#transitGatewayArnstringtransit_gateway_arnstrtransitGatewayArnStringTransitGatewayArnstringTransitGatewayArn*stringrequired#The ARN uniquely identifies the Transit Gateway across AWS and is commonly used for permissions and resource tracking.
transitGatewayIdstringtransit_gateway_idstrtransitGatewayIdStringTransitGatewayIdstringTransitGatewayId*stringrequired#This ID is automatically assigned by AWS upon creation of the Transit Gateway and is used to reference it in various configurations and operations.
Methods
addRouteTable(id: string): ITransitGatewayRouteTabledef add_route_table(self, id: str) -> ITransitGatewayRouteTablepublic ITransitGatewayRouteTable addRouteTable(String id)public ITransitGatewayRouteTable AddRouteTable(string id)func AddRouteTable(Id *string) ITransitGatewayRouteTable#returns
Returns: The created Transit Gateway route table.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
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.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
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).
attachVpc(id: string, options: AttachVpcOptions): ITransitGatewayVpcAttachmentdef attach_vpc(self, id: str, options: AttachVpcOptions) -> ITransitGatewayVpcAttachmentpublic ITransitGatewayVpcAttachment attachVpc(String id, AttachVpcOptions options)public ITransitGatewayVpcAttachment AttachVpc(string id, AttachVpcOptions options)func AttachVpc(Id *string, Options AttachVpcOptions) ITransitGatewayVpcAttachment#returns
Returns: The created Transit Gateway VPC attachment.
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#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.