ALIYUN::VPC::VirtualBorderRouter - Resource Orchestration Service

Syntax

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

Properties


Property	Type	Required	Editable	Description	Constraint
PeerGatewayIp	String	Yes	Yes	The IP address of the VBR on the user side.	Only the owner of the VBR can set or modify this property. This property is required when you create a VBR for the owner of the Express Connect circuit. You can ignore this property when you create a VBR for another Alibaba Cloud account.
LocalGatewayIp	String	Yes	Yes	The IP address of the VBR on the Alibaba Cloud side.	None
Description	String	No	Yes	The description of the VBR.	The description must be 2 to 256 characters in length. The description must start with a letter but cannot start with `http://` or `https://`.
CircuitCode	String	No	Yes	The code provided by the Internet service provider (ISP) of the Express Connect circuit.	Only the owner of the Express Connect circuit can set this property.
PhysicalConnectionId	String	Yes	No	The ID of the Express Connect circuit.	None
PeeringSubnetMask	String	Yes	Yes	The subnet mask for the IP addresses of the VBR on the Alibaba Cloud side and on the user side.	The two IP addresses must be located in the same subnet.
VlanId	Integer	Yes	No	The virtual LAN (VLAN) ID of the VBR.	Valid values: 1 to 2999. Note Only the owner of the Express Connect circuit can set this property. The VLAN IDs of two VBRs of the same the Express Connect circuit must be different.
Name	String	No	Yes	The name of the VBR.	The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter but cannot start with `http://` or `https://`.

Response parameters

Fn::GetAtt

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

Examples

YAMLformat

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: {}

JSONformat

{
  "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": {
  }
}