BgpGroup

• Implements: IBgpGroup

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();

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.

Valid values:

• IPv4: This is the default value.
• IPv6: IPv6 is supported only if the VBR for which you want to create the BGP group has IPv6 enabled.

isFakeAsn^Optional

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

Property isFakeAsn: Specifies whether to use a fake ASN.

Valid values:

• false (default)
• true

A router that runs BGP typically belongs to only one AS. If you need to replace an existing AS with a new AS and you cannot immediately modify BGP configurations, you can use fake ASNs to ensure service continuity.

localAsn^Optional

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

Property localAsn: The custom ASN on the cloud side.

Valid values:

• 45104
• 64512~65534
• 4200000000~4294967294

65025 is reserved by the cloud platform. By default, the system uses 45104 as LocalAsn. If you use custom LocalAsn in multi-line access scenarios, loops in BGP may occur.

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

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.BgpGroup;
BgpGroup.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

attrBgpGroupId^Required

public java.lang.Object getAttrBgpGroupId();

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

Attribute BgpGroupId: The ID of the BGP group.

attrName^Required

public java.lang.Object getAttrName();

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

Attribute Name: The name of the BGP group.

props^Required

public BgpGroupProps getProps();

• Type: BgpGroupProps