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 com.aliyun.ros.cdk.vpc.VirtualBorderRouter;
VirtualBorderRouter.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .localGatewayIp(java.lang.String)
    .localGatewayIp(IResolvable)
    .peerGatewayIp(java.lang.String)
    .peerGatewayIp(IResolvable)
    .peeringSubnetMask(java.lang.String)
    .peeringSubnetMask(IResolvable)
    .physicalConnectionId(java.lang.String)
    .physicalConnectionId(IResolvable)
    .vlanId(java.lang.Number)
    .vlanId(IResolvable)
//  .bandwidth(java.lang.Number)
//  .bandwidth(IResolvable)
//  .circuitCode(java.lang.String)
//  .circuitCode(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .name(java.lang.String)
//  .name(IResolvable)
//  .resourceGroupId(java.lang.String)
//  .resourceGroupId(IResolvable)
    .build();

scope^Required

• Type: com.aliyun.ros.cdk.core.Construct

id^Required

• Type: java.lang.String

enableResourcePropertyConstraint^Optional

• Type: java.lang.Boolean

localGatewayIp^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property localGatewayIp: The IP address of the VBR.

Only the owner of the VBR can set or modify this parameter. When you create a VBR for the owner of the Express Connect circuit, this parameter is required.

peerGatewayIp^Required

• Type: java.lang.String OR com.aliyun.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.

peeringSubnetMask^Required

• Type: java.lang.String OR com.aliyun.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.

physicalConnectionId^Required

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property physicalConnectionId: The ID of the physical connection.

vlanId^Required

• Type: java.lang.Number OR com.aliyun.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: java.lang.Number OR com.aliyun.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.

circuitCode^Optional

• Type: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.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: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property name: The name of the VBR.

The name must be 2 to 128 characters in length, and can contain letters, digits, underscores (_), and hyphens (-). The name must start with a letter.

resourceGroupId^Optional

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property resourceGroupId: The ID of the resource group.

Methods

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition

public void addCondition(RosCondition condition)

condition^Required

• Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

count^Required

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resource^Required

• Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

desc^Required

• Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

• Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

name^Required

• Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

key^Required

• Type: java.lang.String

value^Required

• Type: java.lang.Object

Static Functions

isConstruct

import com.aliyun.ros.cdk.vpc.VirtualBorderRouter;
VirtualBorderRouter.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

• Type: java.lang.Object

Properties

node^Required

public ConstructNode getNode();

• Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

env^Required

public IResourceEnvironment getEnv();

• Type: com.aliyun.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

public java.lang.String getRef();

• Type: java.lang.String

stack^Required

public Stack getStack();

• Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resource^Optional

public RosResource getResource();

• Type: com.aliyun.ros.cdk.core.RosResource

attrName^Required

public java.lang.Object getAttrName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Name: The name of the VBR.

attrRouteTableId^Required

public java.lang.Object getAttrRouteTableId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

attrVbrId^Required

public java.lang.Object getAttrVbrId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VbrId: The ID of the VBR.

attrVlanInterfaceId^Required

public java.lang.Object getAttrVlanInterfaceId();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute VlanInterfaceId: The ID of the VBR interface.

props^Required

public VirtualBorderRouterProps getProps();

• Type: VirtualBorderRouterProps