All Products
Search
Document Center

Resource Orchestration Service:ALIYUN::VPC::BgpPeer

Last Updated:Mar 28, 2026

The ALIYUN::VPC::BgpPeer resource type adds a BGP peer to a specified BGP group.

Syntax

{
  "Type": "ALIYUN::VPC::BgpPeer",
  "Properties": {
    "PeerIpAddress": String,
    "EnableBfd": Boolean,
    "BgpGroupId": String,
    "BfdMultiHop": Integer,
    "IpVersion": String
  }
}

Properties

Parameter

Type

Required

Editable

Description

Constraints

PeerIpAddress

String

No

Yes

The IP address of the BGP peer.

None

EnableBfd

Boolean

No

Yes

Specifies whether to enable BFD.

Valid values:

  • true: BFD is enabled.

  • false: BFD is disabled.

BgpGroupId

String

Yes

No

The ID of the BGP group.

None

BfdMultiHop

Integer

No

No

The BFD hop count.

Valid values: 1 to 255.

This property is required when BFD is enabled. It specifies the maximum number of devices that packets can traverse between the source and destination. Set this value based on your physical link conditions.

Note

If you use BFD in a multi-cloud environment or over a direct fiber optic connection with no intermediate devices, change the default BFD hop count from 255 to 1.

IpVersion

String

No

No

The IP version.

Valid values:

  • IPv4 (Default)

  • IPv6: Supported only when the Virtual Border Router (VBR) associated with the BGP group has IPv6 enabled.

Return values

Fn::GetAtt

BgpPeerId: The ID of the BGP peer.

Examples

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  BgpGroupId:
    Type: String
    Description: The ID of the BGP group.
Resources:
  BgpPeer:
    Type: ALIYUN::VPC::BgpPeer
    Properties:
      PeerIpAddress: 192.168.1.1
      EnableBfd: false
      BgpGroupId:
        Ref: BgpGroupId
Outputs:
  BgpPeerId:
    Description: The ID of the BGP peer.
    Value:
      Fn::GetAtt:
        - BgpPeer
        - BgpPeerId
{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "BgpGroupId": {
      "Type": "String",
      "Description": "The ID of the BGP group."
    }
  },
  "Resources": {
    "BgpPeer": {
      "Type": "ALIYUN::VPC::BgpPeer",
      "Properties": {
        "PeerIpAddress": "192.168.1.1",
        "EnableBfd": false,
        "BgpGroupId": {
          "Ref": "BgpGroupId"
        }
      }
    }
  },
  "Outputs": {
    "BgpPeerId": {
      "Description": "The ID of the BGP peer.",
      "Value": {
        "Fn::GetAtt": [
          "BgpPeer",
          "BgpPeerId"
        ]
      }
    }
  }
}