Package software.amazon.awscdk.services.interconnect

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.interconnect.CfnConnection
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IConnectionRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-04-02T21:55:12.481Z") @Stability(Stable) public class CfnConnection extends CfnResource implements IInspectable, IConnectionRef, ITaggableV2
Resource Type definition for AWS::Interconnect::Connection.

Creates a managed network connection between AWS and a partner cloud service provider.

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.interconnect.*;
 CfnConnection cfnConnection = CfnConnection.Builder.create(this, "MyCfnConnection")
         .attachPoint(AttachPointProperty.builder()
                 .arn("arn")
                 .directConnectGateway("directConnectGateway")
                 .build())
         // the properties below are optional
         .activationKey("activationKey")
         .bandwidth("bandwidth")
         .description("description")
         .environmentId("environmentId")
         .remoteOwnerAccount("remoteOwnerAccount")
         .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::Interconnect::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.

    • getAttrArn

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

    • getAttrBillingTier

      @Stability(Stable) @NotNull public Number getAttrBillingTier()
      The billing tier for the connection.

    • getAttrConnectionId

      @Stability(Stable) @NotNull public String getAttrConnectionId()
      The unique identifier for the connection.

    • getAttrOwnerAccount

      @Stability(Stable) @NotNull public String getAttrOwnerAccount()
      The AWS account ID of the connection owner.

    • getAttrProvider

      @Stability(Stable) @NotNull public IResolvable getAttrProvider()
      The partner cloud service provider.

    • getAttrSharedId

      @Stability(Stable) @NotNull public String getAttrSharedId()
      The shared identifier for the connection pairing.

    • getAttrState

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

    • getAttrType

      @Stability(Stable) @NotNull public String getAttrType()
      The type of managed 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

    • getConnectionRef

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

    • getAttachPoint

      @Stability(Stable) @NotNull public Object getAttachPoint()
      The logical attachment point in your AWS network where the managed connection will be connected.

      Returns union: either IResolvable or CfnConnection.AttachPointProperty

    • setAttachPoint

      @Stability(Stable) public void setAttachPoint(@NotNull IResolvable value)
      The logical attachment point in your AWS network where the managed connection will be connected.

    • setAttachPoint

      @Stability(Stable) public void setAttachPoint(@NotNull CfnConnection.AttachPointProperty value)
      The logical attachment point in your AWS network where the managed connection will be connected.

    • getActivationKey

      @Stability(Stable) @Nullable public String getActivationKey()
      The activation key for accepting a connection proposal from a partner CSP.

    • setActivationKey

      @Stability(Stable) public void setActivationKey(@Nullable String value)
      The activation key for accepting a connection proposal from a partner CSP.

    • getBandwidth

      @Stability(Stable) @Nullable public String getBandwidth()
      The bandwidth of the connection (e.g., 50Mbps, 1Gbps). Required when creating a connection through AWS.

    • setBandwidth

      @Stability(Stable) public void setBandwidth(@Nullable String value)
      The bandwidth of the connection (e.g., 50Mbps, 1Gbps). Required when creating a connection through AWS.

    • getDescription

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

    • setDescription

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

    • getEnvironmentId

      @Stability(Stable) @Nullable public String getEnvironmentId()
      The ID of the environment for the connection.

    • setEnvironmentId

      @Stability(Stable) public void setEnvironmentId(@Nullable String value)
      The ID of the environment for the connection.

    • getRemoteOwnerAccount

      @Stability(Stable) @Nullable public String getRemoteOwnerAccount()
      The account ID of the remote owner.

    • setRemoteOwnerAccount

      @Stability(Stable) public void setRemoteOwnerAccount(@Nullable String value)
      The account ID of the remote owner.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.