AWS::DirectConnect::DirectConnectGateway - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

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::DirectConnect::DirectConnectGateway

Creates a Direct Connect gateway, which is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. A Direct Connect gateway is global and visible in any AWS Region after it is created. The virtual interfaces and virtual private gateways that are connected through a Direct Connect gateway can be in different AWS Regions. This enables you to connect to a VPC in any Region, regardless of the Region in which the virtual interfaces are located, and pass traffic between them.

For more information, see Direct Connect gateways in the Direct Connect User Guide .

Syntax

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

JSON

{
  "Type" : "AWS::DirectConnect::DirectConnectGateway",
  "Properties" : {
      "AmazonSideAsn" : String,
      "DirectConnectGatewayName" : String,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::DirectConnect::DirectConnectGateway
Properties:
  AmazonSideAsn: String
  DirectConnectGatewayName: String
  Tags: 
    - Tag

Properties

AmazonSideAsn

The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294. The default is 64512.

Required: No

Type: String

Pattern: ^[1-9][0-9]*$

Update requires: Replacement

DirectConnectGatewayName

The name of the Direct Connect gateway.

Required: Yes

Type: String

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

Update requires: No interruption

Tags

Information about a tag.

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 Direct Connect gateway.

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.

DirectConnectGatewayArn

The Amazon Resource Name (ARN) of the Direct Connect gateway.

DirectConnectGatewayId

The ID of the Direct Connect gateway.

Examples

Basic Direct Connect gateway

This example shows a basic Direct Connect gateway.

JSON

{
  "Resources": {
    "myDirectConnectGateway": {
      "Type": "AWS::DirectConnect::DirectConnectGateway",
      "Properties": {
        "DirectConnectGatewayName": "cfn-directconnectgateway-example",
        "AmazonSideAsn": "65412",
        "Tags": [
          {
            "Key": "example-key",
            "Value": "example-value"
          }
        ]
      }
    }
  }
}

YAML

Resources:
  myDirectConnectGateway:
    Type: AWS::DirectConnect::DirectConnectGateway
    Properties:
      DirectConnectGatewayName: cfn-directconnectgateway-example
      AmazonSideAsn: '65412'
      Tags:
      - Key: example-key
        Value: example-value