Package software.amazon.awscdk.services.networkmanager

Class CfnConnection

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.CfnConnection
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IConnectionRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:04:56.430Z") @Stability(Stable) public class CfnConnection extends CfnResource implements IInspectable, IConnectionRef, ITaggableV2
Resource Type definition for AWS::NetworkManager::Connection.

Describes a connection between two devices in a global network.

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.*;
 CfnConnection cfnConnection = CfnConnection.Builder.create(this, "MyCfnConnection")
         .connectedDeviceId("connectedDeviceId")
         .deviceId("deviceId")
         .globalNetworkId("globalNetworkId")
         // the properties below are optional
         .connectedLinkId("connectedLinkId")
         .description("description")
         .linkId("linkId")
         .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

    • CfnConnection

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

    • CfnConnection

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

    • CfnConnection

      @Stability(Stable) public CfnConnection(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnConnectionProps props)
      Create a new AWS::NetworkManager::Connection.

      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

    • arnForConnection

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

    • isCfnConnection

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

      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.

    • getAttrConnectionArn

      @Stability(Stable) @NotNull public String getAttrConnectionArn()
      The Amazon Resource Name (ARN) of the connection.

    • getAttrConnectionId

      @Stability(Stable) @NotNull public String getAttrConnectionId()
      The ID of the connection.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The date and time that the connection was created.

    • getAttrState

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

    • 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

    • getCfnPropertyNames

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

    • getConnectionRef

      @Stability(Stable) @NotNull public ConnectionReference getConnectionRef()
      A reference to a Connection resource.
      Specified by:
      getConnectionRef in interface IConnectionRef

    • getConnectedDeviceId

      @Stability(Stable) @NotNull public String getConnectedDeviceId()
      The ID of the second device in the connection.

    • setConnectedDeviceId

      @Stability(Stable) public void setConnectedDeviceId(@NotNull String value)
      The ID of the second device in the connection.

    • getDeviceId

      @Stability(Stable) @NotNull public String getDeviceId()
      The ID of the first device in the connection.

    • setDeviceId

      @Stability(Stable) public void setDeviceId(@NotNull String value)
      The ID of the first device in the connection.

    • getGlobalNetworkId

      @Stability(Stable) @NotNull public String getGlobalNetworkId()
      The ID of the global network that the connection belongs to.

    • setGlobalNetworkId

      @Stability(Stable) public void setGlobalNetworkId(@NotNull String value)
      The ID of the global network that the connection belongs to.

    • getConnectedLinkId

      @Stability(Stable) @Nullable public String getConnectedLinkId()
      The ID of the link for the second device.

    • setConnectedLinkId

      @Stability(Stable) public void setConnectedLinkId(@Nullable String value)
      The ID of the link for the second device.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the connection.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the connection.

    • getLinkId

      @Stability(Stable) @Nullable public String getLinkId()
      The ID of the link for the first device.

    • setLinkId

      @Stability(Stable) public void setLinkId(@Nullable String value)
      The ID of the link for the first device.

    • getTags

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

    • setTags

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