BgpPeer

• Implements: ros_cdk_vpc.datasource.IBgpPeer

This class encapsulates and extends the ROS resource type DATASOURCE::VPC::BgpPeer.

Initializers

from ros_cdk_vpc import datasource
datasource.BgpPeer(
  scope: Construct,
  id: str,
  bgp_peer_id: typing.Union[str, IResolvable] = None,
  refresh_options: typing.Union[str, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

bgp_peer_id^Optional

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

Property bgpPeerId: The ID of the BGP peer.

refresh_options^Optional

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

Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

Valid values:

• Never: Never refresh the datasource resource when the stack is updated.
• Always: Always refresh the datasource resource when the stack is updated. Default is Never.

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

from ros_cdk_vpc import datasource
datasource.BgpPeer.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_advertised_route_count^Required

attr_advertised_route_count: typing.Union[str, IResolvable]

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

Attribute AdvertisedRouteCount: The number of advertised routes.

attr_auth_key^Required

attr_auth_key: typing.Union[str, IResolvable]

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

Attribute AuthKey: The authentication key of the BGP group.

attr_bfd_multi_hop^Required

attr_bfd_multi_hop: typing.Union[str, IResolvable]

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

Attribute BfdMultiHop: The Bidirectional Forwarding Detection (BFD) hop count.

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_bgp_peer_id^Required

attr_bgp_peer_id: typing.Union[str, IResolvable]

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

Attribute BgpPeerId: The ID of the BGP peer.

attr_bgp_status^Required

attr_bgp_status: typing.Union[str, IResolvable]

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

Attribute BgpStatus: The status of the BGP connection.

Valid values: Idle: The BGP connection is not used. Connect: The BGP connection is used. Active: The BGP connection is available. Established: The BGP connection is established. Down: The BGP connection is unavailable.

attr_description^Required

attr_description: typing.Union[str, IResolvable]

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

Attribute Description: The description of the BGP group.

attr_enable_bfd^Required

attr_enable_bfd: typing.Union[str, IResolvable]

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

Attribute EnableBfd: Indicates whether BFD is enabled.

Valid values: false true

attr_gmt_modified^Required

attr_gmt_modified: typing.Union[str, IResolvable]

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

Attribute GmtModified: The time when the BGP peer is modified.

attr_hold^Required

attr_hold: typing.Union[str, IResolvable]

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

Attribute Hold: The hold time.

attr_ip_version^Required

attr_ip_version: typing.Union[str, IResolvable]

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

Attribute IpVersion: The version of the IP address.

attr_is_fake^Required

attr_is_fake: typing.Union[str, IResolvable]

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

Attribute IsFake: Indicates whether a fake autonomous system number (ASN) is used.

Valid values: false true

attr_keepalive^Required

attr_keepalive: typing.Union[str, IResolvable]

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

Attribute Keepalive: The Keepalive interval.

attr_local_asn^Required

attr_local_asn: typing.Union[str, IResolvable]

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

Attribute LocalAsn: The ASN of the device on the Alibaba Cloud side.

attr_name^Required

attr_name: typing.Union[str, IResolvable]

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

Attribute Name: The name of the BGP peer.

attr_peer_asn^Required

attr_peer_asn: typing.Union[str, IResolvable]

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

Attribute PeerAsn: The autonomous system number (ASN)of the BGP peer.

attr_peer_ip_address^Required

attr_peer_ip_address: typing.Union[str, IResolvable]

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

Attribute PeerIpAddress: The IP address of the BGP peer.

attr_received_route_count^Required

attr_received_route_count: typing.Union[str, IResolvable]

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

Attribute ReceivedRouteCount: The number of received routes.

attr_route_limit^Required

attr_route_limit: typing.Union[str, IResolvable]

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

Attribute RouteLimit: The maximum number of routes.

attr_router_id^Required

attr_router_id: typing.Union[str, IResolvable]

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

Attribute RouterId: The Router ID.

attr_status^Required

attr_status: typing.Union[str, IResolvable]

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

Attribute Status: The status of the BGP peer.

Valid values: Pending Available Modifying Deleting Deleted

props^Required

props: BgpPeerProps

• Type: BgpPeerProps