AWS::DirectConnect::Connection - Amazon CloudFormation
SyntaxPropertiesReturn valuesExamples
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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

AWS::DirectConnect::Connection

Creates a connection between a customer network and a specific Amazon Direct Connect location.

A connection links your internal network to an Amazon Direct Connect location over a standard Ethernet fiber-optic cable. One end of the cable is connected to your router, the other to an Amazon Direct Connect router.

To find the locations for your Region, use DescribeLocations.

You can automatically add the new connection to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new connection is allocated on the same Amazon Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no connection is created.

Important

Upon creation, a connection will enter the requested state. The connection cannot be used with other resources until it is approved and advances to available or down.

In order to create a virtual interface using a connection defined in the same CloudFormation template, it is recommended to create a LAG and create the virtual interface using the LAG. Member connections can be added to the LAG in the CloudFormation template.

For more information, see Dedicated Direct Connect connections in the Amazon Direct Connect User Guide .

Syntax

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

JSON

{
  "Type" : "AWS::DirectConnect::Connection",
  "Properties" : {
      "Bandwidth" : String,
      "ConnectionName" : String,
      "LagId" : String,
      "Location" : String,
      "ProviderName" : String,
      "RequestMACSec" : Boolean,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::DirectConnect::Connection
Properties:
  Bandwidth: String
  ConnectionName: String
  LagId: String
  Location: String
  ProviderName: String
  RequestMACSec: Boolean
  Tags: 
    - Tag

Properties

Bandwidth

The bandwidth of the connection.

Required: Yes

Type: String

Pattern: ^[1-9][0-9]*(M|G)bps$

Update requires: Replacement

ConnectionName

The name of the connection.

Required: Yes

Type: String

Pattern: ^[\w \-_,\/]{1,200}$

Update requires: No interruption

LagId

The ID or ARN of the LAG to associate the connection with.

Connectivity will be interrupted when associating or disassociating a connection with a LAG.

Required: No

Type: String

Pattern: ^(arn:aws[a-z-]*:directconnect:[a-z0-9-]+:[0-9]{12}:dxlag/)?dxlag-[a-zA-Z0-9]{8,21}$

Update requires: Some interruptions

Location

The location of the connection.

Required: Yes

Type: String

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

Update requires: Replacement

ProviderName

The name of the service provider associated with the connection.

Required: No

Type: String

Update requires: Replacement

RequestMACSec

Indicates whether you want the connection to support MAC Security (MACsec).

MAC Security (MACsec) is unavailable on hosted connections. For information about MAC Security (MACsec) prerequisites, see MAC Security in Amazon Direct Connect in the Amazon Direct Connect User Guide.

Required: No

Type: Boolean

Update requires: Replacement

Tags

The tags associated with the connection.

Required: No

Type: Array of Tag

Minimum: 1

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.

ConnectionArn

The Amazon Resource Name (ARN) of the connection.

ConnectionId

The ID of the connection.

ConnectionState

The state of the connection. The following are the possible values:

  • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

  • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

  • pending: The connection has been approved and is being initialized.

  • available: The network link is up and the connection is ready for use.

  • down: The network link is down.

  • deleting: The connection is being deleted.

  • deleted: The connection has been deleted.

  • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

  • unknown: The state of the connection is not available.

Examples

Basic connection

This example shows a basic connection. The bandwidth of the connection is 10Gbps.

JSON

{
  "Resources": {
    "myConnection": {
      "Type": "AWS::DirectConnect::Connection",
      "Properties": {
        "ConnectionName": "cfn-connection-example",
        "Bandwidth": "10Gbps",
        "Location": "EqSY3",
        "Tags": [
          {
            "Key": "example-key",
            "Value": "example-value"
          }
        ]
      }
    }
  }
}

YAML

Resources:
  myConnection:
    Type: AWS::DirectConnect::Connection
    Properties:
      ConnectionName: cfn-connection-example
      Bandwidth: 10Gbps
      Location: EqSY3
      Tags:
      - Key: example-key
        Value: example-value