Skip to content
v2.274.0

Experimental

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

ITransitGateway Interface ​

Represents a Transit Gateway.

Properties ​

defaultRouteTableITransitGatewayRouteTabledefault_route_tableITransitGatewayRouteTabledefaultRouteTableITransitGatewayRouteTableDefaultRouteTableITransitGatewayRouteTableDefaultRouteTableITransitGatewayRouteTablerequired#
The default route table associated with the Transit Gateway.

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#
Indicates whether new attachments are automatically associated with the default route table.

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#
Indicates whether route propagation to the default route table is enabled.

When set to true, routes from attachments will be automatically propagated to the default route table unless propagation is explicitly disabled.

dnsSupportbooleandns_supportbooldnsSupportBooleanDnsSupportboolDnsSupport*boolrequired#
Whether or not DNS support is enabled on the Transit Gateway.
The environment this resource belongs to.
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.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#
The tree node.
routerTargetIdstringrouter_target_idstrrouterTargetIdStringRouterTargetIdstringRouterTargetId*stringrequired#
The ID of the route target.
routerTypeRouterTyperouter_typeRouterTyperouterTypeRouterTypeRouterTypeRouterTypeRouterTypeRouterTyperequired#
The type of router used in the route.
securityGroupReferencingSupportbooleansecurity_group_referencing_supportboolsecurityGroupReferencingSupportBooleanSecurityGroupReferencingSupportboolSecurityGroupReferencingSupport*boolrequired#
Whether or not security group referencing support is enabled on the Transit Gateway.
stackStackstackStackstackStackStackStackStackStackrequired#
The stack in which this resource is defined.
transitGatewayArnstringtransit_gateway_arnstrtransitGatewayArnStringTransitGatewayArnstringTransitGatewayArn*stringrequired#
The Amazon Resource Name (ARN) of the Transit Gateway.

The ARN uniquely identifies the Transit Gateway across AWS and is commonly used for permissions and resource tracking.

transitGatewayIdstringtransit_gateway_idstrtransitGatewayIdStringTransitGatewayIdstringTransitGatewayId*stringrequired#
The unique identifier of the Transit Gateway.

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 ​

applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#
Apply the given removal policy to this resource.
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).

with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#
Applies one or more mixins to this construct.

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.

1 parameter · returns

Parameters

  • mixinsmixinsmixinsmixinsMixins — The mixins to apply.

Returns: This construct for chaining