Package software.amazon.awscdk.services.ec2

Class CfnTransitGatewayPeeringAttachment

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.CfnTransitGatewayPeeringAttachment
All Implemented Interfaces:
IInspectable, ITransitGatewayPeeringAttachmentRef, 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.112Z") @Stability(Stable) public class CfnTransitGatewayPeeringAttachment extends CfnResource implements IInspectable, ITransitGatewayPeeringAttachmentRef, ITaggable
Requests a transit gateway peering attachment between the specified transit gateway (requester) and a peer transit gateway (accepter).

The peer transit gateway can be in your account or a different AWS account .

After you create the peering attachment, the owner of the accepter transit gateway must accept the attachment request.

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.*;
 CfnTransitGatewayPeeringAttachment cfnTransitGatewayPeeringAttachment = CfnTransitGatewayPeeringAttachment.Builder.create(this, "MyCfnTransitGatewayPeeringAttachment")
         .peerAccountId("peerAccountId")
         .peerRegion("peerRegion")
         .peerTransitGatewayId("peerTransitGatewayId")
         .transitGatewayId("transitGatewayId")
         // the properties below are optional
         .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

    • CfnTransitGatewayPeeringAttachment

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

    • CfnTransitGatewayPeeringAttachment

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

    • CfnTransitGatewayPeeringAttachment

      @Stability(Stable) public CfnTransitGatewayPeeringAttachment(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTransitGatewayPeeringAttachmentProps props)
      Create a new AWS::EC2::TransitGatewayPeeringAttachment.

      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

    • arnForTransitGatewayPeeringAttachment

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

    • fromTransitGatewayAttachmentId

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

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

    • isCfnTransitGatewayPeeringAttachment

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

      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.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The time the transit gateway peering attachment was created.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The state of the transit gateway peering attachment.

      Note that the initiating state has been deprecated.

    • getAttrStatus

      @Stability(Stable) @NotNull public IResolvable getAttrStatus()

    • getAttrStatusCode

      @Stability(Stable) @NotNull public String getAttrStatusCode()

    • getAttrStatusMessage

      @Stability(Stable) @NotNull public String getAttrStatusMessage()

    • getAttrTransitGatewayAttachmentId

      @Stability(Stable) @NotNull public String getAttrTransitGatewayAttachmentId()
      The ID of the transit gateway peering 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

    • getTransitGatewayPeeringAttachmentRef

      @Stability(Stable) @NotNull public TransitGatewayPeeringAttachmentReference getTransitGatewayPeeringAttachmentRef()
      A reference to a TransitGatewayPeeringAttachment resource.
      Specified by:
      getTransitGatewayPeeringAttachmentRef in interface ITransitGatewayPeeringAttachmentRef

    • getPeerAccountId

      @Stability(Stable) @NotNull public String getPeerAccountId()
      The ID of the AWS account that owns the transit gateway.

    • setPeerAccountId

      @Stability(Stable) public void setPeerAccountId(@NotNull String value)
      The ID of the AWS account that owns the transit gateway.

    • getPeerRegion

      @Stability(Stable) @NotNull public String getPeerRegion()
      The Region where the transit gateway that you want to create the peer for is located.

    • setPeerRegion

      @Stability(Stable) public void setPeerRegion(@NotNull String value)
      The Region where the transit gateway that you want to create the peer for is located.

    • getPeerTransitGatewayId

      @Stability(Stable) @NotNull public String getPeerTransitGatewayId()
      The ID of the transit gateway in the PeerRegion.

    • setPeerTransitGatewayId

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

    • getTransitGatewayId

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

    • setTransitGatewayId

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

    • getTagsRaw

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

    • setTagsRaw

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