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 specified 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
)
Name | Type | Description |
---|---|---|
scope |
ros_cdk_core.Construct |
No description. |
id |
str |
No description. |
peer_asn |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property peerAsn: The AS number of the BGP peer. |
router_id |
typing.Union[str, ros_cdk_core.IResolvable] |
Property routerId: The ID of the VBR. |
auth_key |
typing.Union[str, ros_cdk_core.IResolvable] |
Property authKey: The authentication key of the BGP group. |
description |
typing.Union[str, ros_cdk_core.IResolvable] |
Property description: The description of the BGP group. |
ip_version |
typing.Union[str, ros_cdk_core.IResolvable] |
Property ipVersion: The IP version of the BGP group. |
is_fake_asn |
typing.Union[bool, ros_cdk_core.IResolvable] |
Property isFakeAsn: A router that runs BGP typically belongs to only one AS. |
local_asn |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property localAsn: The AS number on the Alibaba Cloud side. |
name |
typing.Union[str, ros_cdk_core.IResolvable] |
Property name: The name of the BGP group. |
route_quota |
typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] |
Property routeQuota: The upper limit of the BGP neighbor's route entries. |
enable_resource_property_constraint |
bool |
No description. |
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
Name | Description |
---|---|
to_string |
Returns a string representation of this construct. |
synthesize |
Allows this construct to emit artifacts into the cloud assembly during synthesis. |
add_condition |
No description. |
add_count |
No description. |
add_dependency |
No description. |
add_resource_desc |
No description. |
apply_removal_policy |
No description. |
get_att |
No description. |
set_metadata |
No description. |
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.
- Type: ros_cdk_core.ISynthesisSession
The synthesis session.
add_condition
def add_condition(
condition: RosCondition
) -> None
- Type: ros_cdk_core.RosCondition
add_count
def add_count(
count: typing.Union[typing.Union[int, float], IResolvable]
) -> None
- Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]
add_dependency
def add_dependency(
resource: Resource
) -> None
- Type: ros_cdk_core.Resource
add_resource_desc
def add_resource_desc(
desc: str
) -> None
- Type: str
apply_removal_policy
def apply_removal_policy(
policy: RemovalPolicy
) -> None
- Type: ros_cdk_core.RemovalPolicy
get_att
def get_att(
name: str
) -> IResolvable
- Type: str
set_metadata
def set_metadata(
key: str,
value: typing.Any
) -> None
- Type: str
- Type: typing.Any
Static Functions
Name | Description |
---|---|
is_construct |
Return whether the given object is a Construct. |
is_construct
import ros_cdk_vpc
ros_cdk_vpc.BgpGroup.is_construct(
x: typing.Any
)
Return whether the given object is a Construct.
- Type: typing.Any
Properties
Name | Type | Description |
---|---|---|
node |
ros_cdk_core.ConstructNode |
The construct tree node associated with this construct. |
ref |
str |
No description. |
stack |
ros_cdk_core.Stack |
The stack in which this resource is defined. |
resource |
ros_cdk_core.RosResource |
No description. |
attr_bgp_group_id |
ros_cdk_core.IResolvable |
Attribute BgpGroupId: The ID of the BGP group. |
attr_name |
ros_cdk_core.IResolvable |
Attribute Name: The name of the BGP group. |
node
Required
node: ConstructNode
- Type: ros_cdk_core.ConstructNode
The construct tree node associated with this construct.
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: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute BgpGroupId: The ID of the BGP group.
attr_name
Required
attr_name: IResolvable
- Type: ros_cdk_core.IResolvable
Attribute Name: The name of the BGP group.