Skip to content

BgpPeer

This class encapsulates and extends the ROS resource type DATASOURCE::VPC::BgpPeer, which is used to query the information about a Border Gateway Protocol (BGP) peer in a region.

Initializers 

import { datasource } from '@alicloud/ros-cdk-vpc'
new datasource.BgpPeer(scope: Construct, id: string, props?: BgpPeerProps, enableResourcePropertyConstraint?: boolean)
Name Type Description
scope @alicloud/ros-cdk-core.Construct No description.
id string No description.
props BgpPeerProps No description.
enableResourcePropertyConstraint boolean No description.

scopeRequired

  • Type: @alicloud/ros-cdk-core.Construct

idRequired

  • Type: string

propsOptional

enableResourcePropertyConstraintOptional

  • Type: boolean

Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
getAtt No description.
setMetadata No description.

toString 

public toString(): string

Returns a string representation of this construct.

synthesize 

public synthesize(session: ISynthesisSession): void

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: @alicloud/ros-cdk-core.ISynthesisSession

The synthesis session.

addCondition 

public addCondition(condition: RosCondition): void

conditionRequired

  • Type: @alicloud/ros-cdk-core.RosCondition

addCount 

public addCount(count: number | IResolvable): void

countRequired

  • Type: number | @alicloud/ros-cdk-core.IResolvable

addDependency 

public addDependency(resource: Resource): void

resourceRequired

  • Type: @alicloud/ros-cdk-core.Resource

addResourceDesc 

public addResourceDesc(desc: string): void

descRequired

  • Type: string

applyRemovalPolicy 

public applyRemovalPolicy(policy: RemovalPolicy): void

policyRequired

  • Type: @alicloud/ros-cdk-core.RemovalPolicy

getAtt 

public getAtt(name: string): IResolvable

nameRequired

  • Type: string

setMetadata 

public setMetadata(key: string, value: any): void

keyRequired

  • Type: string

valueRequired

  • Type: any

Static Functions

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

isConstruct 

import { datasource } from '@alicloud/ros-cdk-vpc'
datasource.BgpPeer.isConstruct(x: any)

Return whether the given object is a Construct.

xRequired

  • Type: any

Properties

Name Type Description
node @alicloud/ros-cdk-core.ConstructNode The construct tree node associated with this construct.
ref string No description.
stack @alicloud/ros-cdk-core.Stack The stack in which this resource is defined.
resource @alicloud/ros-cdk-core.RosResource No description.
attrAdvertisedRouteCount @alicloud/ros-cdk-core.IResolvable Attribute AdvertisedRouteCount: The number of advertised routes.
attrAuthKey @alicloud/ros-cdk-core.IResolvable Attribute AuthKey: The authentication key of the BGP group.
attrBfdMultiHop @alicloud/ros-cdk-core.IResolvable Attribute BfdMultiHop: The Bidirectional Forwarding Detection (BFD) hop count.
attrBgpGroupId @alicloud/ros-cdk-core.IResolvable Attribute BgpGroupId: The ID of the BGP group.
attrBgpPeerId @alicloud/ros-cdk-core.IResolvable Attribute BgpPeerId: The ID of the BGP peer.
attrBgpStatus @alicloud/ros-cdk-core.IResolvable Attribute BgpStatus: The status of the BGP connection.
attrDescription @alicloud/ros-cdk-core.IResolvable Attribute Description: The description of the BGP group.
attrEnableBfd @alicloud/ros-cdk-core.IResolvable Attribute EnableBfd: Indicates whether BFD is enabled.
attrGmtModified @alicloud/ros-cdk-core.IResolvable Attribute GmtModified: The time when the BGP peer is modified.
attrHold @alicloud/ros-cdk-core.IResolvable Attribute Hold: The hold time.
attrIpVersion @alicloud/ros-cdk-core.IResolvable Attribute IpVersion: The version of the IP address.
attrIsFake @alicloud/ros-cdk-core.IResolvable Attribute IsFake: Indicates whether a fake autonomous system number (ASN) is used.
attrKeepalive @alicloud/ros-cdk-core.IResolvable Attribute Keepalive: The Keepalive interval.
attrLocalAsn @alicloud/ros-cdk-core.IResolvable Attribute LocalAsn: The ASN of the device on the Alibaba Cloud side.
attrName @alicloud/ros-cdk-core.IResolvable Attribute Name: The name of the BGP peer.
attrPeerAsn @alicloud/ros-cdk-core.IResolvable Attribute PeerAsn: The autonomous system number (ASN)of the BGP peer.
attrPeerIpAddress @alicloud/ros-cdk-core.IResolvable Attribute PeerIpAddress: The IP address of the BGP peer.
attrReceivedRouteCount @alicloud/ros-cdk-core.IResolvable Attribute ReceivedRouteCount: The number of received routes.
attrRouteLimit @alicloud/ros-cdk-core.IResolvable Attribute RouteLimit: The maximum number of routes.
attrRouterId @alicloud/ros-cdk-core.IResolvable Attribute RouterId: The Router ID.
attrStatus @alicloud/ros-cdk-core.IResolvable Attribute Status: The status of the BGP peer.

nodeRequired 

public readonly node: ConstructNode;
  • Type: @alicloud/ros-cdk-core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public readonly ref: string;
  • Type: string

stackRequired 

public readonly stack: Stack;
  • Type: @alicloud/ros-cdk-core.Stack

The stack in which this resource is defined.

resourceOptional 

public readonly resource: RosResource;
  • Type: @alicloud/ros-cdk-core.RosResource

attrAdvertisedRouteCountRequired 

public readonly attrAdvertisedRouteCount: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AdvertisedRouteCount: The number of advertised routes.

attrAuthKeyRequired 

public readonly attrAuthKey: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute AuthKey: The authentication key of the BGP group.

attrBfdMultiHopRequired 

public readonly attrBfdMultiHop: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrBgpGroupIdRequired 

public readonly attrBgpGroupId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute BgpGroupId: The ID of the BGP group.

attrBgpPeerIdRequired 

public readonly attrBgpPeerId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute BgpPeerId: The ID of the BGP peer.

attrBgpStatusRequired 

public readonly attrBgpStatus: IResolvable;
  • Type: @alicloud/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.

attrDescriptionRequired 

public readonly attrDescription: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Description: The description of the BGP group.

attrEnableBfdRequired 

public readonly attrEnableBfd: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute EnableBfd: Indicates whether BFD is enabled.

Valid values: false true

attrGmtModifiedRequired 

public readonly attrGmtModified: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrHoldRequired 

public readonly attrHold: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Hold: The hold time.

attrIpVersionRequired 

public readonly attrIpVersion: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute IpVersion: The version of the IP address.

attrIsFakeRequired 

public readonly attrIsFake: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

Valid values: false true

attrKeepaliveRequired 

public readonly attrKeepalive: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Keepalive: The Keepalive interval.

attrLocalAsnRequired 

public readonly attrLocalAsn: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrNameRequired 

public readonly attrName: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Name: The name of the BGP peer.

attrPeerAsnRequired 

public readonly attrPeerAsn: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

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

attrPeerIpAddressRequired 

public readonly attrPeerIpAddress: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute PeerIpAddress: The IP address of the BGP peer.

attrReceivedRouteCountRequired 

public readonly attrReceivedRouteCount: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute ReceivedRouteCount: The number of received routes.

attrRouteLimitRequired 

public readonly attrRouteLimit: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute RouteLimit: The maximum number of routes.

attrRouterIdRequired 

public readonly attrRouterId: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute RouterId: The Router ID.

attrStatusRequired 

public readonly attrStatus: IResolvable;
  • Type: @alicloud/ros-cdk-core.IResolvable

Attribute Status: The status of the BGP peer.

Valid values: Pending Available Modifying Deleting Deleted