@aws-cdk/aws-ec2-alpha.TransitGatewayRouteTable

Experimental

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

TransitGatewayRouteTable L2 construct

Creates a Transit Gateway route table.

Construct›Resource›TransitGatewayRouteTable

implements

• ITransitGatewayRouteTable,
• IResource,
• IRouteTable,
• IEnvironmentAware,
• 2 more

  • IConstruct,
  • IDependable

Stability

Experimental

CloudFormation

AWS::EC2::TransitGatewayRouteTable

L1 type

CfnTransitGatewayRouteTable

Source

lib/transit-gateway-route-table.ts

Example

// 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 transitGateway: ec2_alpha.TransitGateway;
const transitGatewayRouteTable = new ec2_alpha.TransitGatewayRouteTable(this, 'MyTransitGatewayRouteTable', {
  transitGateway: transitGateway,

  // the properties below are optional
  transitGatewayRouteTableName: 'transitGatewayRouteTableName',
});

# 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: ec2_alpha.TransitGateway

transit_gateway_route_table = ec2_alpha.TransitGatewayRouteTable(self, "MyTransitGatewayRouteTable",
    transit_gateway=transit_gateway,

    # the properties below are optional
    transit_gateway_route_table_name="transitGatewayRouteTableName"
)

// 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.*;

TransitGateway transitGateway;

TransitGatewayRouteTable transitGatewayRouteTable = TransitGatewayRouteTable.Builder.create(this, "MyTransitGatewayRouteTable")
        .transitGateway(transitGateway)

        // the properties below are optional
        .transitGatewayRouteTableName("transitGatewayRouteTableName")
        .build();

// 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;

TransitGateway transitGateway;

var transitGatewayRouteTable = new TransitGatewayRouteTable(this, "MyTransitGatewayRouteTable", new TransitGatewayRouteTableProps {
    TransitGateway = transitGateway,

    // the properties below are optional
    TransitGatewayRouteTableName = "transitGatewayRouteTableName"
});

// 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 transitGateway TransitGateway

transitGatewayRouteTable := ec2_alpha.NewTransitGatewayRouteTable(this, jsii.String("MyTransitGatewayRouteTable"), &TransitGatewayRouteTableProps{
	TransitGateway: transitGateway,

	// the properties below are optional
	TransitGatewayRouteTableName: jsii.String("transitGatewayRouteTableName"),
})

Initializer

new TransitGatewayRouteTable(scope: Construct, id: string, props: TransitGatewayRouteTableProps)

TransitGatewayRouteTable(scope: Construct, id: str, props: TransitGatewayRouteTableProps)

new TransitGatewayRouteTable(Construct scope, String id, TransitGatewayRouteTableProps props)

new TransitGatewayRouteTable(Construct scope, string id, TransitGatewayRouteTableProps props)

NewTransitGatewayRouteTable(Scope Construct, Id *string, Props TransitGatewayRouteTableProps)

Construct Props

transitGatewayITransitGatewaytransit_gatewayITransitGatewaytransitGatewayITransitGatewayTransitGatewayITransitGatewayTransitGatewayITransitGatewayrequired#

The Transit Gateway that this route table belongs to.

transitGatewayRouteTableName?optionalstringtransit_gateway_route_table_name?optionalstrtransitGatewayRouteTableName?optionalStringTransitGatewayRouteTableName?optionalstringTransitGatewayRouteTableName?optional*string#

Physical name of this Transit Gateway Route Table.

Default: Assigned by CloudFormation.

Properties

envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#

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.

PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#

Uniquely identifies this class.

routeTableIdstringroute_table_idstrrouteTableIdStringRouteTableIdstringRouteTableId*stringrequired#

Route table ID.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

transitGatewayITransitGatewaytransit_gatewayITransitGatewaytransitGatewayITransitGatewayTransitGatewayITransitGatewayTransitGatewayITransitGatewayrequired#

The Transit Gateway.

Methods

addAssociation(id: string, transitGatewayAttachment: ITransitGatewayAttachment): ITransitGatewayRouteTableAssociationdef add_association(self, id: str, transit_gateway_attachment: ITransitGatewayAttachment) -> ITransitGatewayRouteTableAssociationpublic ITransitGatewayRouteTableAssociation addAssociation(String id, ITransitGatewayAttachment transitGatewayAttachment)public ITransitGatewayRouteTableAssociation AddAssociation(string id, ITransitGatewayAttachment transitGatewayAttachment)func AddAssociation(Id *string, TransitGatewayAttachment ITransitGatewayAttachment) ITransitGatewayRouteTableAssociation#

Associate the provided Attachments with this route table.

addBlackholeRoute(id: string, destinationCidr: string): ITransitGatewayRoutedef add_blackhole_route(self, id: str, destination_cidr: str) -> ITransitGatewayRoutepublic ITransitGatewayRoute addBlackholeRoute(String id, String destinationCidr)public ITransitGatewayRoute AddBlackholeRoute(string id, string destinationCidr)func AddBlackholeRoute(Id *string, DestinationCidr *string) ITransitGatewayRoute#

Add a blackhole route to this route table.

addRoute(id: string, transitGatewayAttachment: ITransitGatewayAttachment, destinationCidr: string): ITransitGatewayRoutedef add_route(self, id: str, transit_gateway_attachment: ITransitGatewayAttachment, destination_cidr: str) -> ITransitGatewayRoutepublic ITransitGatewayRoute addRoute(String id, ITransitGatewayAttachment transitGatewayAttachment, String destinationCidr)public ITransitGatewayRoute AddRoute(string id, ITransitGatewayAttachment transitGatewayAttachment, string destinationCidr)func AddRoute(Id *string, TransitGatewayAttachment ITransitGatewayAttachment, DestinationCidr *string) ITransitGatewayRoute#

Add an active route to this 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)#

Override the cross-stack reference strength for this resource.

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)#

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).

enablePropagation(id: string, transitGatewayAttachment: ITransitGatewayAttachment): ITransitGatewayRouteTablePropagationdef enable_propagation(self, id: str, transit_gateway_attachment: ITransitGatewayAttachment) -> ITransitGatewayRouteTablePropagationpublic ITransitGatewayRouteTablePropagation enablePropagation(String id, ITransitGatewayAttachment transitGatewayAttachment)public ITransitGatewayRouteTablePropagation EnablePropagation(string id, ITransitGatewayAttachment transitGatewayAttachment)func EnablePropagation(Id *string, TransitGatewayAttachment ITransitGatewayAttachment) ITransitGatewayRouteTablePropagation#

Enable propagation from the provided Attachments to this route table.

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#

Checks if `x` is a construct.

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#

Returns true if the construct was created by CDK, and false otherwise.

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#

Check whether the given construct is a Resource.

toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#

Returns a string representation of this construct.

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. Use multiple with() calls if subsequent mixins should apply to added constructs.