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 ros_cdk_vpc
ros_cdk_vpc.BgpGroup(
  scope: Construct,
  id: str,
  peer_asn: typing.Union[typing.Union[int, float], IResolvable],
  router_id: typing.Union[str, IResolvable],
  auth_key: typing.Union[str, IResolvable] = None,
  description: typing.Union[str, IResolvable] = None,
  ip_version: typing.Union[str, IResolvable] = None,
  is_fake_asn: typing.Union[bool, IResolvable] = None,
  local_asn: typing.Union[typing.Union[int, float], IResolvable] = None,
  name: typing.Union[str, IResolvable] = None,
  route_quota: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

peer_asn^Required

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

Property peerAsn: The AS number of the BGP peer.

router_id^Required

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

Property routerId: The ID of the VBR.

auth_key^Optional

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

Property authKey: The authentication key of the BGP group.

description^Optional

• Type: typing.Union[str, 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://.

ip_version^Optional

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

Property ipVersion: The IP version of the BGP group.

Valid values: IPv4 and IPv6.

is_fake_asn^Optional

• Type: typing.Union[bool, 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.

local_asn^Optional

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

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

name^Optional

• Type: typing.Union[str, 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://.

route_quota^Optional

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

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

Unit: entries, default value: 110.

enable_resource_property_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_bgp_group_id^Required

attr_bgp_group_id: typing.Union[str, IResolvable]

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

Attribute BgpGroupId: The ID of the BGP group.

attr_name^Required

attr_name: typing.Union[str, IResolvable]

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

Attribute Name: The name of the BGP group.

props^Required

props: BgpGroupProps

• Type: BgpGroupProps