Skip to content
v2.274.0

CfnConnectionProps Struct ​

Properties for defining a CfnConnection.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_interconnect as interconnect } from 'aws-cdk-lib';
const cfnConnectionProps: interconnect.CfnConnectionProps = {
  attachPoint: {
    arn: 'arn',
    directConnectGateway: 'directConnectGateway',
  },

  // the properties below are optional
  activationKey: 'activationKey',
  bandwidth: 'bandwidth',
  description: 'description',
  environmentId: 'environmentId',
  remoteAccount: {
    identifier: 'identifier',
  },
  remoteOwnerAccount: 'remoteOwnerAccount',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

activationKeyoptionalstringactivation_keyoptionalstractivationKeyoptionalStringActivationKeyoptionalstringActivationKeyoptional*string#
The activation key for accepting a connection proposal from a partner CSP.

Mutually exclusive with EnvironmentId.

attachPointIResolvable | CfnConnection.AttachPointPropertyattach_pointtyping.Union[IResolvable, AttachPointProperty]attachPointIResolvableAttachPointIResolvableAttachPointinterface{}required#
The logical attachment point in your AWS network where the managed connection will be connected.
bandwidthoptionalstringbandwidthoptionalstrbandwidthoptionalStringBandwidthoptionalstringBandwidthoptional*string#
The bandwidth of the connection (e.g., 50Mbps, 1Gbps). Required when creating a connection through AWS.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description of the connection.
environmentIdoptionalstringenvironment_idoptionalstrenvironmentIdoptionalStringEnvironmentIdoptionalstringEnvironmentIdoptional*string#
The ID of the environment for the connection.

Required when creating a connection through AWS. Mutually exclusive with ActivationKey.

remoteAccountoptionalIResolvable | CfnConnection.RemoteAccountPropertyremote_accountoptionaltyping.Union[IResolvable, RemoteAccountProperty]remoteAccountoptionalIResolvableRemoteAccountoptionalIResolvableRemoteAccountoptionalinterface{}#
The remote account identifier for the connection.

Required when creating a connection through AWS. Replaces RemoteOwnerAccount.

remoteOwnerAccountoptionalstringremote_owner_accountoptionalstrremoteOwnerAccountoptionalStringRemoteOwnerAccountoptionalstringRemoteOwnerAccountoptional*stringdeprecated#
this property has been deprecated

Use RemoteAccount instead. The account ID of the remote owner. Required when creating a connection through AWS.

tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to this resource.