Package software.amazon.awscdk.services.ec2

Class CfnTransitGatewayAttachment

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.ec2.CfnTransitGatewayAttachment
All Implemented Interfaces:
IInspectable, ITransitGatewayAttachmentRef, IEnvironmentAware, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:35.096Z") @Stability(Stable) public class CfnTransitGatewayAttachment extends CfnResource implements IInspectable, ITransitGatewayAttachmentRef, ITaggable
Attaches a VPC to a transit gateway.

If you attach a VPC with a CIDR range that overlaps the CIDR range of a VPC that is already attached, the new VPC CIDR range is not propagated to the default propagation route table.

To send VPC traffic to an attached transit gateway, add a route to the VPC route table using AWS::EC2::Route .

To update tags for a VPC attachment after creation without replacing the attachment, use AWS::EC2::TransitGatewayVpcAttachment instead.

Example: 

 // 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.*;
 Object options;
 CfnTransitGatewayAttachment cfnTransitGatewayAttachment = CfnTransitGatewayAttachment.Builder.create(this, "MyCfnTransitGatewayAttachment")
         .subnetIds(List.of("subnetIds"))
         .transitGatewayId("transitGatewayId")
         .vpcId("vpcId")
         // the properties below are optional
         .options(options)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTransitGatewayAttachment

      protected CfnTransitGatewayAttachment(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnTransitGatewayAttachment

      protected CfnTransitGatewayAttachment(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnTransitGatewayAttachment

      @Stability(Stable) public CfnTransitGatewayAttachment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTransitGatewayAttachmentProps props)
      Create a new AWS::EC2::TransitGatewayAttachment.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForTransitGatewayAttachment

      @Stability(Stable) @NotNull public static String arnForTransitGatewayAttachment(@NotNull ITransitGatewayAttachmentRef resource)
      Parameters:
      resource - This parameter is required.

    • fromTransitGatewayAttachmentId

      @Stability(Stable) @NotNull public static ITransitGatewayAttachmentRef fromTransitGatewayAttachmentId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String transitGatewayAttachmentId)
      Creates a new ITransitGatewayAttachmentRef from a transitGatewayAttachmentId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      transitGatewayAttachmentId - This parameter is required.

    • isCfnTransitGatewayAttachment

      @Stability(Stable) @NotNull public static Boolean isCfnTransitGatewayAttachment(@NotNull Object x)
      Checks whether the given object is a CfnTransitGatewayAttachment.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()
      The ID of the attachment.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getTransitGatewayAttachmentRef

      @Stability(Stable) @NotNull public TransitGatewayAttachmentReference getTransitGatewayAttachmentRef()
      A reference to a TransitGatewayAttachment resource.
      Specified by:
      getTransitGatewayAttachmentRef in interface ITransitGatewayAttachmentRef

    • getSubnetIds

      @Stability(Stable) @NotNull public List<String> getSubnetIds()
      The IDs of one or more subnets.

    • setSubnetIds

      @Stability(Stable) public void setSubnetIds(@NotNull List<String> value)
      The IDs of one or more subnets.

    • getTransitGatewayId

      @Stability(Stable) @NotNull public String getTransitGatewayId()
      The ID of the transit gateway.

    • setTransitGatewayId

      @Stability(Stable) public void setTransitGatewayId(@NotNull String value)
      The ID of the transit gateway.

    • getVpcId

      @Stability(Stable) @NotNull public String getVpcId()
      The ID of the VPC.

    • setVpcId

      @Stability(Stable) public void setVpcId(@NotNull String value)
      The ID of the VPC.

    • getOptions

      @Stability(Stable) @Nullable public Object getOptions()
      The VPC attachment options.

    • setOptions

      @Stability(Stable) public void setOptions(@Nullable Object value)
      The VPC attachment options.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The tags for the attachment.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The tags for the attachment.