Skip to content

BgpPeer

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
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
bgp_peer_id typing.Union[str, ros_cdk_core.IResolvable] Property bgpPeerId: The ID of the BGP peer.
refresh_options typing.Union[str, ros_cdk_core.IResolvable] Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

bgp_peer_idOptional

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

Property bgpPeerId: The ID of the BGP peer.

refresh_optionsOptional

  • 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_constraintOptional

  • 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.

sessionRequired

  • Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

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

countRequired

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

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

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

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

from ros_cdk_vpc import datasource
datasource.BgpPeer.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • 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_advertised_route_count ros_cdk_core.IResolvable Attribute AdvertisedRouteCount: The number of advertised routes.
attr_auth_key ros_cdk_core.IResolvable Attribute AuthKey: The authentication key of the BGP group.
attr_bfd_multi_hop ros_cdk_core.IResolvable Attribute BfdMultiHop: The Bidirectional Forwarding Detection (BFD) hop count.
attr_bgp_group_id ros_cdk_core.IResolvable Attribute BgpGroupId: The ID of the BGP group.
attr_bgp_peer_id ros_cdk_core.IResolvable Attribute BgpPeerId: The ID of the BGP peer.
attr_bgp_status ros_cdk_core.IResolvable Attribute BgpStatus: The status of the BGP connection.
attr_description ros_cdk_core.IResolvable Attribute Description: The description of the BGP group.
attr_enable_bfd ros_cdk_core.IResolvable Attribute EnableBfd: Indicates whether BFD is enabled.
attr_gmt_modified ros_cdk_core.IResolvable Attribute GmtModified: The time when the BGP peer is modified.
attr_hold ros_cdk_core.IResolvable Attribute Hold: The hold time.
attr_ip_version ros_cdk_core.IResolvable Attribute IpVersion: The version of the IP address.
attr_is_fake ros_cdk_core.IResolvable Attribute IsFake: Indicates whether a fake autonomous system number (ASN) is used.
attr_keepalive ros_cdk_core.IResolvable Attribute Keepalive: The Keepalive interval.
attr_local_asn ros_cdk_core.IResolvable Attribute LocalAsn: The ASN of the device on the Alibaba Cloud side.
attr_name ros_cdk_core.IResolvable Attribute Name: The name of the BGP peer.
attr_peer_asn ros_cdk_core.IResolvable Attribute PeerAsn: The autonomous system number (ASN)of the BGP peer.
attr_peer_ip_address ros_cdk_core.IResolvable Attribute PeerIpAddress: The IP address of the BGP peer.
attr_received_route_count ros_cdk_core.IResolvable Attribute ReceivedRouteCount: The number of received routes.
attr_route_limit ros_cdk_core.IResolvable Attribute RouteLimit: The maximum number of routes.
attr_router_id ros_cdk_core.IResolvable Attribute RouterId: The Router ID.
attr_status ros_cdk_core.IResolvable Attribute Status: The status of the BGP peer.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_advertised_route_countRequired 

attr_advertised_route_count: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AdvertisedRouteCount: The number of advertised routes.

attr_auth_keyRequired 

attr_auth_key: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute AuthKey: The authentication key of the BGP group.

attr_bfd_multi_hopRequired 

attr_bfd_multi_hop: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_bgp_group_idRequired 

attr_bgp_group_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BgpGroupId: The ID of the BGP group.

attr_bgp_peer_idRequired 

attr_bgp_peer_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute BgpPeerId: The ID of the BGP peer.

attr_bgp_statusRequired 

attr_bgp_status: IResolvable
  • Type: 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_descriptionRequired 

attr_description: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Description: The description of the BGP group.

attr_enable_bfdRequired 

attr_enable_bfd: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute EnableBfd: Indicates whether BFD is enabled.

Valid values: false true

attr_gmt_modifiedRequired 

attr_gmt_modified: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_holdRequired 

attr_hold: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Hold: The hold time.

attr_ip_versionRequired 

attr_ip_version: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute IpVersion: The version of the IP address.

attr_is_fakeRequired 

attr_is_fake: IResolvable
  • Type: ros_cdk_core.IResolvable

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

Valid values: false true

attr_keepaliveRequired 

attr_keepalive: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Keepalive: The Keepalive interval.

attr_local_asnRequired 

attr_local_asn: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_nameRequired 

attr_name: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Name: The name of the BGP peer.

attr_peer_asnRequired 

attr_peer_asn: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_peer_ip_addressRequired 

attr_peer_ip_address: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute PeerIpAddress: The IP address of the BGP peer.

attr_received_route_countRequired 

attr_received_route_count: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute ReceivedRouteCount: The number of received routes.

attr_route_limitRequired 

attr_route_limit: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RouteLimit: The maximum number of routes.

attr_router_idRequired 

attr_router_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute RouterId: The Router ID.

attr_statusRequired 

attr_status: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute Status: The status of the BGP peer.

Valid values: Pending Available Modifying Deleting Deleted