Create a Virtual Border Router via ROS for Express Connect - Resource Orchestration Service

Use the ALIYUN::VPC::VirtualBorderRouter resource to create a virtual border router (VBR).

Syntax

{
  "Type": "ALIYUN::VPC::VirtualBorderRouter",
  "Properties": {
    "PeerGatewayIp": String,
    "LocalGatewayIp": String,
    "Description": String,
    "CircuitCode": String,
    "PhysicalConnectionId": String,
    "PeeringSubnetMask": String,
    "VlanId": Integer,
    "Name": String,
    "ResourceGroupId": String,
    "Bandwidth": Integer
  }
}

Properties

Parameter	Type	Required	Updatable	Description	Constraints
PeerGatewayIp	String	Yes	Yes	The IP address of the peer gateway.	This property is required when the VBR instance is created by the owner of the Express Connect circuit. Do not specify this property when you create a VBR instance for another Alibaba Cloud account.
LocalGatewayIp	String	Yes	Yes	The IP address of the local gateway.	None
Description	String	No	Yes	The description of the VBR.	The description must be 2 to 256 characters long and start with a letter or a Chinese character. It cannot start with `http://` or `https://`.
CircuitCode	String	No	Yes	The circuit code of the Express Connect circuit, provided by your internet service provider (ISP).	Only the owner of the Express Connect circuit can specify this property.
PhysicalConnectionId	String	Yes	No	The ID of the Express Connect circuit.	None
PeeringSubnetMask	String	Yes	Yes	The subnet mask for the local and peer gateway IP addresses.	The IP addresses of the local and peer gateways must be in the same subnet.
VlanId	Integer	Yes	No	The VLAN ID of the VBR.	Valid values: 1 to 2999. Note Only the owner of the Express Connect circuit can specify this property. VLAN IDs must be unique for each VBR on the same Express Connect circuit.
Name	String	No	Yes	The name of the VBR.	The name must be 2 to 128 characters long and start with a letter or a Chinese character. It can contain letters, Chinese characters, digits, periods (.), underscores (_), and hyphens (-). The name cannot start with `http://` or `https://`.
ResourceGroupId	String	No	No	The ID of the resource group.	None
Bandwidth	Integer	No	No	The bandwidth of the VBR instance.	Unit: Mbps. For dedicated Express Connect circuits, the valid values are 50, 100, 200, 300, 400, 500, 1000, 2048, 5120, 8192, 10240, 20480, 40960, 50120, 61440, and 102400. For shared Express Connect circuits, do not specify this parameter. The VBR instance inherits its bandwidth from the shared circuit.

Return values

Fn::GetAtt

VbrId: The ID of the VBR instance.
Name: The name of the VBR.
RouteTableId: The ID of the VBR route table.
VlanInterfaceId: The ID of the VBR interface.

Examples

YAML

ROSTemplateFormatVersion: '2015-09-01'
Parameters:
  PhysicalConnectionId:
    Type: String
    Default: pc-uf68cptix9pqv9ufXXXXXX
Resources:
  VirtualBorderRouter:
    Type: ALIYUN::VPC::VirtualBorderRouter
    Properties:
      VlanId: 200
      PhysicalConnectionId:
        Ref: PhysicalConnectionId
      PeerGatewayIp: 10.0.0.2
      Name: TestVBR
      PeeringSubnetMask: 255.255.255.252
      LocalGatewayIp: 10.0.0.1
Outputs: {}

JSON

{
  "ROSTemplateFormatVersion": "2015-09-01",
  "Parameters": {
    "PhysicalConnectionId": {
      "Type": "String",
      "Default": "pc-uf68cptix9pqv9ufXXXXXX"
    }
  },
  "Resources": {
    "VirtualBorderRouter": {
      "Type": "ALIYUN::VPC::VirtualBorderRouter",
      "Properties": {
        "VlanId": 200,
        "PhysicalConnectionId": {
          "Ref": "PhysicalConnectionId"
        },
        "PeerGatewayIp": "10.0.0.2",
        "Name": "TestVBR",
        "PeeringSubnetMask": "255.255.255.252",
        "LocalGatewayIp": "10.0.0.1"
      }
    }
  },
  "Outputs": {
  }
}