Skip to content

VirtualBorderRouter

This class encapsulates and extends the ROS resource type ALIYUN::VPC::VirtualBorderRouter, which is used 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],
  circuit_code: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
local_gateway_ip typing.Union[str, ros_cdk_core.IResolvable] Property localGatewayIp: The IP address of the VBR on the Alibaba Cloud side.
peer_gateway_ip typing.Union[str, ros_cdk_core.IResolvable] Property peerGatewayIp: The IP address of the peer router interface of the VBR.
peering_subnet_mask 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.
physical_connection_id typing.Union[str, ros_cdk_core.IResolvable] Property physicalConnectionId: The ID of the physical connection.
vlan_id typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property vlanId: The VLAN ID of the VBR.
circuit_code typing.Union[str, ros_cdk_core.IResolvable] Property circuitCode: The circuit code provided by the Internet service provider (ISP) for the physical connection.
description typing.Union[str, ros_cdk_core.IResolvable] Property description: The description of the VBR.
name typing.Union[str, ros_cdk_core.IResolvable] Property name: The name of the VBR.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

local_gateway_ipRequired

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

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

peer_gateway_ipRequired

  • 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_maskRequired

  • 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_idRequired

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

Property physicalConnectionId: The ID of the physical connection.

vlan_idRequired

  • 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.

circuit_codeOptional

  • 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.

descriptionOptional

  • 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://.

nameOptional

  • 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://.

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

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

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_name ros_cdk_core.IResolvable Attribute Name: The name of the VBR.
attr_route_table_id ros_cdk_core.IResolvable Attribute RouteTableId: The ID of the route table of the VBR.
attr_vbr_id ros_cdk_core.IResolvable Attribute VbrId: The ID of the VBR.
attr_vlan_interface_id ros_cdk_core.IResolvable Attribute VlanInterfaceId: The ID of the VBR interface.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_nameRequired 

attr_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Name: The name of the VBR.

attr_route_table_idRequired 

attr_route_table_id: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_vbr_idRequired 

attr_vbr_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VbrId: The ID of the VBR.

attr_vlan_interface_idRequired 

attr_vlan_interface_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VlanInterfaceId: The ID of the VBR interface.