VirtualBorderRouter

• Implements: IVirtualBorderRouter

This class encapsulates and extends the ROS resource type ALIYUN::VPC::VirtualBorderRouterUse the , which resource to create a virtual border router (VBR).

Initializers

import ros_cdk_vpc
ros_cdk_vpc.VirtualBorderRouter(
  scope: Construct,
  id: str,
  local_gateway_ip: typing.Union[str, IResolvable],
  peer_gateway_ip: typing.Union[str, IResolvable],
  peering_subnet_mask: typing.Union[str, IResolvable],
  physical_connection_id: typing.Union[str, IResolvable],
  vlan_id: typing.Union[typing.Union[int, float], IResolvable],
  bandwidth: typing.Union[typing.Union[int, float], IResolvable] = None,
  circuit_code: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

local_gateway_ip^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property localGatewayIp: The IP address of the VBR on the Alibaba Cloud side.

peer_gateway_ip^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property peerGatewayIp: The IP address of the peer router interface of the VBR.

Only the owner of the VBR can set or modify the value. This parameter is required when you create a VBR for the owner of the physical connection. You can ignore this parameter when you create a VBR for another Alibaba Cloud account.

peering_subnet_mask^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property peeringSubnetMask: 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 fall within the same subnet.

physical_connection_id^Required

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property physicalConnectionId: The ID of the physical connection.

vlan_id^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property vlanId: The VLAN ID of the VBR.

Valid values: 0 to 2999. Note Only the owner of the physical connection can set this parameter. The VLAN IDs of two VBRs of the same physical connection must be different.

bandwidth^Optional

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

Property bandwidth: The bandwidth of the VBR instance, in Mbps.

• When creating a VBR instance for a dedicated leased line, the values are 50, 100, 200, 300, 400, 500, 1000, 2048, 5120, 8192, 10240, 20480, 40960, 50120, 61440 and 102400.
• When creating a VBR instance for a shared leased line, no configuration is required, and the bandwidth of the VBR is the shared leased line bandwidth set when creating the shared physical connection.

circuit_code^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property circuitCode: The circuit code provided by the Internet service provider (ISP) for the physical connection.

Note Only the owner of the physical connection can set this parameter.

description^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: The description of the VBR.

The description must be 2 to 256 characters in length. It must start with a letter but cannot start with http:// or https://.

name^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property name: The name of the VBR.

The name must be 2 to 128 characters in length, and can contain, digits, periods (.), underscores (_), and hyphens (-). The name cannot start with http:// or https://.

resource_group_id^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property resourceGroupId: The ID of the resource group.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_vpc
ros_cdk_vpc.VirtualBorderRouter.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: ros_cdk_core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_name^Required

attr_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute Name: The name of the VBR.

attr_route_table_id^Required

attr_route_table_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute RouteTableId: The ID of the route table of the VBR.

attr_vbr_id^Required

attr_vbr_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute VbrId: The ID of the VBR.

attr_vlan_interface_id^Required

attr_vlan_interface_id: typing.Union[str, IResolvable]

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Attribute VlanInterfaceId: The ID of the VBR interface.

props^Required

props: VirtualBorderRouterProps

• Type: VirtualBorderRouterProps