class TransitGatewayVpcAttachment (construct) 🔹

Language	Type name
.NET	Amazon.CDK.AWS.ec2.Alpha.TransitGatewayVpcAttachment
Go	github.com/aws/aws-cdk-go/awsec2alpha/v2#TransitGatewayVpcAttachment
Java	software.amazon.awscdk.services.ec2.alpha.TransitGatewayVpcAttachment
Python	aws_cdk.aws_ec2_alpha.TransitGatewayVpcAttachment
TypeScript (source)	@aws-cdk/aws-ec2-alpha » TransitGatewayVpcAttachment

Implements IConstruct, IDependable, IResource, ITransitGatewayVpcAttachment, ITransitGatewayAttachment

Creates a Transit Gateway VPC Attachment.

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,
});

Initializer

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

Parameters

• scope Construct
• id string
• props TransitGatewayVpcAttachmentProps

Construct Props

Name	Type	Description
subnets🔹	ISubnet[]	A list of one or more subnets to place the attachment in.
transitGateway🔹	ITransitGateway	The transit gateway this attachment gets assigned to.
vpc🔹	IVpc	A VPC attachment(s) will get assigned to.
transitGatewayAttachmentName?🔹	string	Physical name of this Transit Gateway VPC Attachment.
vpcAttachmentOptions?🔹	ITransitGatewayVpcAttachmentOptions	The VPC attachment options.

---

subnets🔹

Type: ISubnet[]

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

It is recommended to specify more subnets for better availability.

---

transitGateway🔹

Type: ITransitGateway

The transit gateway this attachment gets assigned to.

---

vpc🔹

Type: IVpc

A VPC attachment(s) will get assigned to.

---

transitGatewayAttachmentName?🔹

Type: string (optional, default: Assigned by CloudFormation.)

Physical name of this Transit Gateway VPC Attachment.

---

vpcAttachmentOptions?🔹

Type: ITransitGatewayVpcAttachmentOptions (optional, default: All options are disabled.)

The VPC attachment options.

Properties

Name	Type	Description
env🔹	ResourceEnvironment	The environment this resource belongs to.
node🔹	Node	The tree node.
stack🔹	Stack	The stack in which this resource is defined.
transitGatewayAttachmentId🔹	string	The ID of the transit gateway attachment.

---

env🔹

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

node🔹

Type: Node

The tree node.

---

stack🔹

Type: Stack

The stack in which this resource is defined.

---

transitGatewayAttachmentId🔹

Type: string

The ID of the transit gateway attachment.

Methods

Name	Description
addSubnets(subnets)🔹	Add additional subnets to this attachment.
applyRemovalPolicy(policy)🔹	Apply the given removal policy to this resource.
removeSubnets(subnets)🔹	Remove additional subnets to this attachment.
toString()🔹	Returns a string representation of this construct.

---

addSubnets(subnets)🔹

public addSubnets(subnets: ISubnet[]): void

Parameters

• subnets ISubnet[]

Add additional subnets to this attachment.

---

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

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

---

removeSubnets(subnets)🔹

public removeSubnets(subnets: ISubnet[]): void

Parameters

• subnets ISubnet[]

Remove additional subnets to this attachment.

---

toString()🔹

public toString(): string

Returns

• string

Returns a string representation of this construct.