Package software.amazon.awscdk.services.ec2

Class CfnTransitGatewayConnectPeer

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.CfnTransitGatewayConnectPeer
All Implemented Interfaces:
IInspectable, ITaggableV2, ITransitGatewayConnectPeerRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:36.397Z") @Stability(Stable) public class CfnTransitGatewayConnectPeer extends CfnResource implements IInspectable, ITransitGatewayConnectPeerRef, ITaggableV2
Describes a transit gateway Connect peer.

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.*;
 CfnTransitGatewayConnectPeer cfnTransitGatewayConnectPeer = CfnTransitGatewayConnectPeer.Builder.create(this, "MyCfnTransitGatewayConnectPeer")
         .connectPeerConfiguration(TransitGatewayConnectPeerConfigurationProperty.builder()
                 .insideCidrBlocks(List.of("insideCidrBlocks"))
                 .peerAddress("peerAddress")
                 // the properties below are optional
                 .bgpConfigurations(List.of(TransitGatewayAttachmentBgpConfigurationProperty.builder()
                         .bgpStatus("bgpStatus")
                         .peerAddress("peerAddress")
                         .peerAsn(123)
                         .transitGatewayAddress("transitGatewayAddress")
                         .transitGatewayAsn(123)
                         .build()))
                 .protocol("protocol")
                 .transitGatewayAddress("transitGatewayAddress")
                 .build())
         .transitGatewayAttachmentId("transitGatewayAttachmentId")
         // 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

    • CfnTransitGatewayConnectPeer

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

    • CfnTransitGatewayConnectPeer

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

    • CfnTransitGatewayConnectPeer

      @Stability(Stable) public CfnTransitGatewayConnectPeer(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTransitGatewayConnectPeerProps props)
      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

    • fromTransitGatewayConnectPeerId

      @Stability(Stable) @NotNull public static ITransitGatewayConnectPeerRef fromTransitGatewayConnectPeerId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String transitGatewayConnectPeerId)
      Creates a new ITransitGatewayConnectPeerRef from a transitGatewayConnectPeerId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      transitGatewayConnectPeerId - 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.

    • getAttrConnectPeerConfigurationBgpConfigurations

      @Stability(Stable) @NotNull public IResolvable getAttrConnectPeerConfigurationBgpConfigurations()
      The BGP configuration details.

    • getAttrConnectPeerConfigurationProtocol

      @Stability(Stable) @NotNull public String getAttrConnectPeerConfigurationProtocol()
      The tunnel protocol.

    • getAttrCreationTime

      @Stability(Stable) @NotNull public String getAttrCreationTime()
      The creation time.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The state of the Connect peer.

    • getAttrTransitGatewayConnectPeerId

      @Stability(Stable) @NotNull public String getAttrTransitGatewayConnectPeerId()
      The ID of the Connect peer.

    • getCdkTagManager

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

    • getCfnProperties

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

    • getTransitGatewayConnectPeerRef

      @Stability(Stable) @NotNull public TransitGatewayConnectPeerReference getTransitGatewayConnectPeerRef()
      A reference to a TransitGatewayConnectPeer resource.
      Specified by:
      getTransitGatewayConnectPeerRef in interface ITransitGatewayConnectPeerRef

    • getConnectPeerConfiguration

      @Stability(Stable) @NotNull public Object getConnectPeerConfiguration()
      The Connect peer details.

      Returns union: either IResolvable or CfnTransitGatewayConnectPeer.TransitGatewayConnectPeerConfigurationProperty

    • setConnectPeerConfiguration

      @Stability(Stable) public void setConnectPeerConfiguration(@NotNull IResolvable value)
      The Connect peer details.

    • setConnectPeerConfiguration

      @Stability(Stable) public void setConnectPeerConfiguration(@NotNull CfnTransitGatewayConnectPeer.TransitGatewayConnectPeerConfigurationProperty value)
      The Connect peer details.

    • getTransitGatewayAttachmentId

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

    • setTransitGatewayAttachmentId

      @Stability(Stable) public void setTransitGatewayAttachmentId(@NotNull String value)
      The ID of the Connect attachment.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      The tags for the Connect peer.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      The tags for the Connect peer.