BgpGroup

This class encapsulates and extends the ROS resource type ALIYUN::VPC::BgpGroup, which is used to create a Border Gateway Protocol (BGP) (Multi-ISP) group for a virtual border router (VBR).

Initializers

import com.aliyun.ros.cdk.vpc.BgpGroup;
BgpGroup.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .peerAsn(java.lang.Number)
    .peerAsn(IResolvable)
    .routerId(java.lang.String)
    .routerId(IResolvable)
//  .authKey(java.lang.String)
//  .authKey(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .ipVersion(java.lang.String)
//  .ipVersion(IResolvable)
//  .isFakeAsn(java.lang.Boolean)
//  .isFakeAsn(IResolvable)
//  .localAsn(java.lang.Number)
//  .localAsn(IResolvable)
//  .name(java.lang.String)
//  .name(IResolvable)
//  .routeQuota(java.lang.Number)
//  .routeQuota(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.
`peerAsn`	`java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable`	Property peerAsn: The AS number of the BGP peer.
`routerId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property routerId: The ID of the VBR.
`authKey`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property authKey: The authentication key of the BGP group.
`description`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property description: The description of the BGP group.
`ipVersion`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property ipVersion: The IP version of the BGP group.
`isFakeAsn`	`java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable`	Property isFakeAsn: A router that runs BGP typically belongs to only one AS.
`localAsn`	`java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable`	Property localAsn: The AS number on the Alibaba Cloud side.
`name`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property name: The name of the BGP group.
`routeQuota`	`java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable`	Property routeQuota: The upper limit of the BGP neighbor's route entries.

`scope`^Required

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

`id`^Required

Type: java.lang.String

`enableResourcePropertyConstraint`^Optional

Type: java.lang.Boolean

`peerAsn`^Required

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

Property peerAsn: The AS number of the BGP peer.

`routerId`^Required

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

Property routerId: The ID of the VBR.

`authKey`^Optional

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

Property authKey: The authentication key of the BGP group.

`description`^Optional

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

Property description: The description of the BGP group.

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

`ipVersion`^Optional

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

Property ipVersion: The IP version of the BGP group.

Valid values: IPv4 and IPv6.

`isFakeAsn`^Optional

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

Property isFakeAsn: A router that runs BGP typically belongs to only one AS.

In some cases, for example, the AS needs to be migrated or is merged with another AS, a new AS number replaces the original one.

`localAsn`^Optional

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

Property localAsn: The AS number on the Alibaba Cloud side.

`name`^Optional

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

Property name: The name of the BGP group.

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

`routeQuota`^Optional

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

Property routeQuota: The upper limit of the BGP neighbor's route entries.

Unit: entries, default value: 110.

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.BgpGroup;
BgpGroup.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.
`attrBgpGroupId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute BgpGroupId: The ID of the BGP group.
`attrName`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute Name: The name of the BGP group.

`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

`attrBgpGroupId`^Required

public IResolvable getAttrBgpGroupId();

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

Attribute BgpGroupId: The ID of the BGP group.

`attrName`^Required

public IResolvable getAttrName();

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

Attribute Name: The name of the BGP group.

BgpGroup

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

peerAsnRequired

routerIdRequired

authKeyOptional

descriptionOptional

ipVersionOptional

isFakeAsnOptional

localAsnOptional

nameOptional

routeQuotaOptional

Methods

toString

synthesize

addCondition

addCount

addDependency

addResourceDesc

applyRemovalPolicy

getAtt

setMetadata