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 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)
//  .circuitCode(java.lang.String)
//  .circuitCode(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .name(java.lang.String)
//  .name(IResolvable)
    .build();

Name	Type	Description
`scope`	`com.aliyun.ros.cdk.core.Construct`	No description.
`id`	`java.lang.String`	No description.
`enableResourcePropertyConstraint`	`java.lang.Boolean`	No description.
`localGatewayIp`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property localGatewayIp: The IP address of the VBR on the Alibaba Cloud side.
`peerGatewayIp`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property peerGatewayIp: The IP address of the peer router interface of the VBR.
`peeringSubnetMask`	`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.
`physicalConnectionId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property physicalConnectionId: The ID of the physical connection.
`vlanId`	`java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable`	Property vlanId: The VLAN ID of the VBR.
`circuitCode`	`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.
`description`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property description: The description of the VBR.
`name`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property name: The name of the VBR.

`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 on the Alibaba Cloud side.

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

`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, digits, periods (.), underscores (_), and hyphens (-). The name cannot start with http:// or https://.

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`synthesize`	Allows this construct to emit artifacts into the cloud assembly during synthesis.
`addCondition`	No description.
`addCount`	No description.
`addDependency`	No description.
`addResourceDesc`	No description.
`applyRemovalPolicy`	No description.
`getAtt`	No description.
`setMetadata`	No description.

`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

`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

Name	Description
`isConstruct`	Return whether the given object is a Construct.

`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

Name	Type	Description
`node`	`com.aliyun.ros.cdk.core.ConstructNode`	The construct tree node associated with this construct.
`ref`	`java.lang.String`	No description.
`stack`	`com.aliyun.ros.cdk.core.Stack`	The stack in which this resource is defined.
`resource`	`com.aliyun.ros.cdk.core.RosResource`	No description.
`attrName`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute Name: The name of the VBR.
`attrRouteTableId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute RouteTableId: The ID of the route table of the VBR.
`attrVbrId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute VbrId: The ID of the VBR.
`attrVlanInterfaceId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute VlanInterfaceId: The ID of the VBR interface.

`node`^Required

public ConstructNode getNode();

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

The construct tree node associated with this construct.

`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 IResolvable getAttrName();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Name: The name of the VBR.

`attrRouteTableId`^Required

public IResolvable getAttrRouteTableId();

Type: com.aliyun.ros.cdk.core.IResolvable

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

`attrVbrId`^Required

public IResolvable getAttrVbrId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VbrId: The ID of the VBR.

`attrVlanInterfaceId`^Required

public IResolvable getAttrVlanInterfaceId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute VlanInterfaceId: The ID of the VBR interface.

VirtualBorderRouter

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

localGatewayIpRequired

peerGatewayIpRequired

peeringSubnetMaskRequired

physicalConnectionIdRequired

vlanIdRequired

circuitCodeOptional

descriptionOptional

nameOptional

Methods

toString

synthesize

addCondition

addCount

addDependency

addResourceDesc

applyRemovalPolicy

getAtt

setMetadata