View a markdown version of this page

AWS::Interconnect::Connection - AWS CloudFormation
SyntaxPropertiesReturn values

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Interconnect::Connection

The AWS::Interconnect::Connection resource specifies a managed network connection between AWS and a partner cloud service provider. Amazon Web Services Interconnect connections enable hybrid and multicloud connectivity through partner-provided last-mile or cross-cloud connectivity.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::Interconnect::Connection",
  "Properties" : {
      "ActivationKey" : String,
      "AttachPoint" : AttachPoint,
      "Bandwidth" : String,
      "Description" : String,
      "EnvironmentId" : String,
      "RemoteAccount" : RemoteAccount,
      "RemoteOwnerAccount" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::Interconnect::Connection
Properties:
  ActivationKey: String
  AttachPoint: 
    AttachPoint
  Bandwidth: String
  Description: String
  EnvironmentId: String
  RemoteAccount: 
    RemoteAccount
  RemoteOwnerAccount: String
  Tags: 
    - Tag

Properties

ActivationKey

The activation key for accepting a connection proposal from a partner cloud service provider. Mutually exclusive with EnvironmentId.

Required: No

Type: String

Update requires: Replacement

AttachPoint

The logical attachment point in your AWS network where the managed connection is connected. Currently, the only supported type of attach point is a AWS Direct Connect gateway.

Required: Yes

Type: AttachPoint

Update requires: Replacement

Bandwidth

The bandwidth of the connection (for example, 50Mbps or 1Gbps). Required when creating a connection through AWS.

Required: No

Type: String

Pattern: ^\d+[MG]bps$

Update requires: No interruption

Description

A description of the connection.

Required: No

Type: String

Pattern: ^[-a-zA-Z0-9_ ]+$

Maximum: 255

Update requires: No interruption

EnvironmentId

The ID of the environment for the connection. Required when creating a connection through AWS. Mutually exclusive with ActivationKey.

Required: No

Type: String

Minimum: 1

Maximum: 32

Update requires: Replacement

RemoteAccount

The remote account identifier for the connection. Required when creating a connection through AWS. Replaces RemoteOwnerAccount.

Required: No

Type: RemoteAccount

Update requires: Replacement

RemoteOwnerAccount

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

Required: No

Type: String

Pattern: ^[-a-zA-Z0-9_@\.]+$

Maximum: 255

Update requires: No interruption

Tags

An array of key-value pairs to apply to this resource.

For more information, see Tag.

Required: No

Type: Array of Tag

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon Resource Name (ARN) of the connection.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The Amazon Resource Name (ARN) of the connection.

BillingTier

The billing tier assigned to the connection.

ConnectionId

The unique identifier of the connection.

OwnerAccount

The AWS account ID of the connection owner.

SharedId

An identifier used by both AWS and the remote partner to identify the connection.

State

The current state of the connection. Valid values are:

  • requested: The initial state of the connection. The state remains here until the connection is accepted on the partner portal.

  • pending: The connection has been accepted and is being provisioned between AWS and the partner.

  • available: The connection has been fully provisioned between AWS and the partner.

  • down: The connection is provisioned but not currently passing traffic.

  • deleting: The connection is being deleted.

  • deleted: The connection has been deleted.

  • failed: The connection failed to be created.

Type

The type of managed connection.