Experimental

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

TransitGatewayVpcAttachment L2 construct

Creates a Transit Gateway VPC Attachment.

Stability: Experimental
CloudFormation: AWS::EC2::TransitGatewayAttachment
L1 type: CfnTransitGatewayAttachment
Source: lib/transit-gateway-vpc-attachment.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';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';

declare const subnet: ec2.Subnet;
declare const transitGateway: ec2_alpha.TransitGateway;
declare const transitGatewayVpcAttachmentOptions: ec2_alpha.ITransitGatewayVpcAttachmentOptions;
declare const vpc: ec2.Vpc;
const transitGatewayVpcAttachment = new ec2_alpha.TransitGatewayVpcAttachment(this, 'MyTransitGatewayVpcAttachment', {
  subnets: [subnet],
  transitGateway: transitGateway,
  vpc: vpc,

  // the properties below are optional
  transitGatewayAttachmentName: 'transitGatewayAttachmentName',
  vpcAttachmentOptions: transitGatewayVpcAttachmentOptions,
});

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
from aws_cdk import aws_ec2 as ec2

# subnet: ec2.Subnet
# transit_gateway: ec2_alpha.TransitGateway
# transit_gateway_vpc_attachment_options: ec2_alpha.ITransitGatewayVpcAttachmentOptions
# vpc: ec2.Vpc

transit_gateway_vpc_attachment = ec2_alpha.TransitGatewayVpcAttachment(self, "MyTransitGatewayVpcAttachment",
    subnets=[subnet],
    transit_gateway=transit_gateway,
    vpc=vpc,

    # the properties below are optional
    transit_gateway_attachment_name="transitGatewayAttachmentName",
    vpc_attachment_options=transit_gateway_vpc_attachment_options
)

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.*;
import software.amazon.awscdk.services.ec2.*;

Subnet subnet;
TransitGateway transitGateway;
ITransitGatewayVpcAttachmentOptions transitGatewayVpcAttachmentOptions;
Vpc vpc;

TransitGatewayVpcAttachment transitGatewayVpcAttachment = TransitGatewayVpcAttachment.Builder.create(this, "MyTransitGatewayVpcAttachment")
        .subnets(List.of(subnet))
        .transitGateway(transitGateway)
        .vpc(vpc)

        // the properties below are optional
        .transitGatewayAttachmentName("transitGatewayAttachmentName")
        .vpcAttachmentOptions(transitGatewayVpcAttachmentOptions)
        .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;
using Amazon.CDK.AWS.EC2;

Subnet subnet;
TransitGateway transitGateway;
ITransitGatewayVpcAttachmentOptions transitGatewayVpcAttachmentOptions;
Vpc vpc;

var transitGatewayVpcAttachment = new TransitGatewayVpcAttachment(this, "MyTransitGatewayVpcAttachment", new TransitGatewayVpcAttachmentProps {
    Subnets = new [] { subnet },
    TransitGateway = transitGateway,
    Vpc = vpc,

    // the properties below are optional
    TransitGatewayAttachmentName = "transitGatewayAttachmentName",
    VpcAttachmentOptions = transitGatewayVpcAttachmentOptions
});

// 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"
import "github.com/aws/aws-cdk-go/awscdk"

var subnet Subnet
var transitGateway TransitGateway
var transitGatewayVpcAttachmentOptions ITransitGatewayVpcAttachmentOptions
var vpc Vpc

transitGatewayVpcAttachment := ec2_alpha.NewTransitGatewayVpcAttachment(this, jsii.String("MyTransitGatewayVpcAttachment"), &TransitGatewayVpcAttachmentProps{
	Subnets: []ISubnet{
		subnet,
	},
	TransitGateway: transitGateway,
	Vpc: vpc,

	// the properties below are optional
	TransitGatewayAttachmentName: jsii.String("transitGatewayAttachmentName"),
	VpcAttachmentOptions: transitGatewayVpcAttachmentOptions,
})

Initializer

new TransitGatewayVpcAttachment(scope: Construct, id: string, props: TransitGatewayVpcAttachmentProps)

python

TransitGatewayVpcAttachment(scope: Construct, id: str, props: TransitGatewayVpcAttachmentProps)

java

new TransitGatewayVpcAttachment(Construct scope, String id, TransitGatewayVpcAttachmentProps props)

csharp

new TransitGatewayVpcAttachment(Construct scope, string id, TransitGatewayVpcAttachmentProps props)

NewTransitGatewayVpcAttachment(Scope Construct, Id *string, Props TransitGatewayVpcAttachmentProps)

Construct Props

subnetsISubnet[]subnetstyping.List[ISubnet]subnetsList<ISubnet>SubnetsISubnet[]Subnets*[]ISubnetrequired#

A list of one or more subnets to place the attachment in.

It is recommended to specify more subnets for better availability.

transitGatewayITransitGatewaytransit_gatewayITransitGatewaytransitGatewayITransitGatewayTransitGatewayITransitGatewayTransitGatewayITransitGatewayrequired#

The transit gateway this attachment gets assigned to.

transitGatewayAttachmentNamestringtransit_gateway_attachment_namestrtransitGatewayAttachmentNameStringTransitGatewayAttachmentNamestringTransitGatewayAttachmentName*string#

Physical name of this Transit Gateway VPC Attachment.

Default: Assigned by CloudFormation.

vpcIVpcvpcIVpcvpcIVpcVpcIVpcVpcIVpcrequired#

A VPC attachment(s) will get assigned to.

vpcAttachmentOptionsITransitGatewayVpcAttachmentOptionsvpc_attachment_optionsITransitGatewayVpcAttachmentOptionsvpcAttachmentOptionsITransitGatewayVpcAttachmentOptionsVpcAttachmentOptionsITransitGatewayVpcAttachmentOptionsVpcAttachmentOptionsITransitGatewayVpcAttachmentOptions#

The VPC attachment options.

Default: All options are disabled.

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.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

transitGatewayAttachmentIdstringtransit_gateway_attachment_idstrtransitGatewayAttachmentIdStringTransitGatewayAttachmentIdstringTransitGatewayAttachmentId*stringrequired#

The ID of the transit gateway attachment.

Methods

addSubnets(subnets: ISubnet[]): voiddef add_subnets(self, subnets: typing.List[ISubnet]) -> Nonepublic void addSubnets(List<ISubnet> subnets)public void AddSubnets(ISubnet[] subnets)func AddSubnets(Subnets *[]ISubnet)#

Add additional subnets to this attachment.

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

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.

removeSubnets(subnets: ISubnet[]): voiddef remove_subnets(self, subnets: typing.List[ISubnet]) -> Nonepublic void removeSubnets(List<ISubnet> subnets)public void RemoveSubnets(ISubnet[] subnets)func RemoveSubnets(Subnets *[]ISubnet)#

Remove additional subnets to this attachment.

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.

TransitGatewayVpcAttachment L2 construct ​

Example ​

Initializer ​

Construct Props ​

Properties ​

Methods ​