Package software.amazon.awscdk.services.networkmanager

Class CfnConnectPeer

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.networkmanager.CfnConnectPeer
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IConnectPeerRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-11-13T16:10:09.755Z") @Stability(Stable) public class CfnConnectPeer extends CfnResource implements IInspectable, IConnectPeerRef, ITaggable
Creates a core network Connect peer for a specified core network connect attachment between a core network and an appliance.

The peer address and transit gateway address must be the same IP address family (IPv4 or IPv6).

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.networkmanager.*;
 CfnConnectPeer cfnConnectPeer = CfnConnectPeer.Builder.create(this, "MyCfnConnectPeer")
         .connectAttachmentId("connectAttachmentId")
         .peerAddress("peerAddress")
         // the properties below are optional
         .bgpOptions(BgpOptionsProperty.builder()
                 .peerAsn(123)
                 .build())
         .coreNetworkAddress("coreNetworkAddress")
         .insideCidrBlocks(List.of("insideCidrBlocks"))
         .subnetArn("subnetArn")
         .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

    • CfnConnectPeer

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

    • CfnConnectPeer

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

    • CfnConnectPeer

      @Stability(Stable) public CfnConnectPeer(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnConnectPeerProps props)
      Create a new AWS::NetworkManager::ConnectPeer.

      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

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

    • getAttrConfiguration

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

    • getAttrConfigurationBgpConfigurations

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

    • getAttrConfigurationCoreNetworkAddress

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

    • getAttrConfigurationInsideCidrBlocks

      @Stability(Stable) @NotNull public List<String> getAttrConfigurationInsideCidrBlocks()

    • getAttrConfigurationPeerAddress

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

    • getAttrConfigurationProtocol

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

    • getAttrConnectPeerId

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

    • getAttrCoreNetworkId

      @Stability(Stable) @NotNull public String getAttrCoreNetworkId()
      The core network ID.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp when the Connect peer was created.

    • getAttrEdgeLocation

      @Stability(Stable) @NotNull public String getAttrEdgeLocation()
      The Connect peer Regions where edges are located.

    • getAttrLastModificationErrors

      @Stability(Stable) @NotNull public List<String> getAttrLastModificationErrors()
      Describes the error associated with the attachment request.

    • getAttrState

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

      This will be: REJECTED | PENDING_ATTACHMENT_ACCEPTANCE | CREATING | FAILED | AVAILABLE | UPDATING | PENDING_NETWORK_UPDATE | PENDING_TAG_ACCEPTANCE | DELETING .

    • getCfnProperties

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

    • getConnectPeerRef

      @Stability(Stable) @NotNull public ConnectPeerReference getConnectPeerRef()
      A reference to a ConnectPeer resource.
      Specified by:
      getConnectPeerRef in interface IConnectPeerRef

    • getTags

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

    • getConnectAttachmentId

      @Stability(Stable) @NotNull public String getConnectAttachmentId()
      The ID of the attachment to connect.

    • setConnectAttachmentId

      @Stability(Stable) public void setConnectAttachmentId(@NotNull String value)
      The ID of the attachment to connect.

    • getPeerAddress

      @Stability(Stable) @NotNull public String getPeerAddress()
      The IP address of the Connect peer.

    • setPeerAddress

      @Stability(Stable) public void setPeerAddress(@NotNull String value)
      The IP address of the Connect peer.

    • getBgpOptions

      @Stability(Stable) @Nullable public Object getBgpOptions()
      Describes the BGP options.

      Returns union: either IResolvable or CfnConnectPeer.BgpOptionsProperty

    • setBgpOptions

      @Stability(Stable) public void setBgpOptions(@Nullable IResolvable value)
      Describes the BGP options.

    • setBgpOptions

      @Stability(Stable) public void setBgpOptions(@Nullable CfnConnectPeer.BgpOptionsProperty value)
      Describes the BGP options.

    • getCoreNetworkAddress

      @Stability(Stable) @Nullable public String getCoreNetworkAddress()
      The IP address of a core network.

    • setCoreNetworkAddress

      @Stability(Stable) public void setCoreNetworkAddress(@Nullable String value)
      The IP address of a core network.

    • getInsideCidrBlocks

      @Stability(Stable) @Nullable public List<String> getInsideCidrBlocks()
      The inside IP addresses used for a Connect peer configuration.

    • setInsideCidrBlocks

      @Stability(Stable) public void setInsideCidrBlocks(@Nullable List<String> value)
      The inside IP addresses used for a Connect peer configuration.

    • getSubnetArn

      @Stability(Stable) @Nullable public String getSubnetArn()
      The subnet ARN of the Connect peer.

    • setSubnetArn

      @Stability(Stable) public void setSubnetArn(@Nullable String value)
      The subnet ARN of the Connect peer.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      The list of key-value tags associated with the Connect peer.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      The list of key-value tags associated with the Connect peer.