AWS::DirectConnect::PrivateVirtualInterface BgpPeer - AWS CloudFormation
SyntaxProperties

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::PrivateVirtualInterface BgpPeer

Information about a BGP peer.

Syntax

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

JSON

{
  "AddressFamily" : String,
  "AmazonAddress" : String,
  "Asn" : String,
  "AuthKey" : String,
  "BgpPeerId" : String,
  "CustomerAddress" : String
}

YAML

  AddressFamily: String
  AmazonAddress: String
  Asn: String
  AuthKey: String
  BgpPeerId: String
  CustomerAddress: String

Properties

AddressFamily

The address family for the BGP peer.

Required: Yes

Type: String

Pattern: ^(ipv4)|(ipv6)$

Update requires: No interruption

AmazonAddress

The IP address assigned to the Amazon interface.

Required: No

Type: String

Pattern: ^[0-9a-fA-F:.]+/[0-9]+$

Update requires: No interruption

Asn

The autonomous system number (ASN). The valid range is from 1 to 4294967294 for Border Gateway Protocol (BGP) configuration. If you provide a number greater than the maximum, an error is returned.

This is configured as a string to support long ASNs. For more details about long ASN support, see Long ASN support in Direct Connect in the Direct Connect User Guide .

Required: Yes

Type: String

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

Update requires: No interruption

AuthKey

The authentication key for BGP configuration. This string has a minimum length of 6 characters and and a maximun lenth of 80 characters.

Required: No

Type: String

Pattern: ^[A-Za-z0-9\\!"#$%&'()*+,\-./:;<=>?@\[\]\^_`{|}~]{6,80}$

Update requires: No interruption

BgpPeerId

The ID of the BGP peer.

Required: No

Type: String

Pattern: ^dxpeer-[a-z0-9]{8}$

Update requires: No interruption

CustomerAddress

The IP address assigned to the customer interface.

Required: No

Type: String

Pattern: ^[0-9a-fA-F:.]+/[0-9]+$

Update requires: No interruption