BgpPeer

• Implements: @alicloud/ros-cdk-vpc.datasource.IBgpPeer

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

Initializers

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

scope^Required

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

id^Required

• Type: string

props^Optional

• Type: BgpPeerProps

enableResourcePropertyConstraint^Optional

• Type: boolean

Methods

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.

session^Required

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

The synthesis session.

addCondition

public addCondition(condition: RosCondition): void

condition^Required

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

addCount

public addCount(count: number | IResolvable): void

count^Required

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

addDependency

public addDependency(resource: Resource): void

resource^Required

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

addResourceDesc

public addResourceDesc(desc: string): void

desc^Required

• Type: string

applyRemovalPolicy

public applyRemovalPolicy(policy: RemovalPolicy): void

policy^Required

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

fetchCondition

public fetchCondition(): RosCondition

fetchDependency

public fetchDependency(): string[]

fetchResourceDesc

public fetchResourceDesc(): string

getAtt

public getAtt(name: string): IResolvable

name^Required

• Type: string

setMetadata

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

key^Required

• Type: string

value^Required

• Type: any

Static Functions

isConstruct

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

Return whether the given object is a Construct.

x^Required

• Type: any

Properties

node^Required

public readonly node: ConstructNode;

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

The construct tree node associated with this construct.

env^Required

public readonly env: IResourceEnvironment;

• Type: @alicloud/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

public readonly ref: string;

• Type: string

stack^Required

public readonly stack: Stack;

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

The stack in which this resource is defined.

resource^Optional

public readonly resource: RosResource;

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

attrAdvertisedRouteCount^Required

public readonly attrAdvertisedRouteCount: string | IResolvable;

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

Attribute AdvertisedRouteCount: The number of advertised routes.

attrAuthKey^Required

public readonly attrAuthKey: string | IResolvable;

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

Attribute AuthKey: The authentication key of the BGP group.

attrBfdMultiHop^Required

public readonly attrBfdMultiHop: string | IResolvable;

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

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

attrBgpGroupId^Required

public readonly attrBgpGroupId: string | IResolvable;

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

Attribute BgpGroupId: The ID of the BGP group.

attrBgpPeerId^Required

public readonly attrBgpPeerId: string | IResolvable;

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

Attribute BgpPeerId: The ID of the BGP peer.

attrBgpStatus^Required

public readonly attrBgpStatus: string | IResolvable;

• Type: string | @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.

attrDescription^Required

public readonly attrDescription: string | IResolvable;

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

Attribute Description: The description of the BGP group.

attrEnableBfd^Required

public readonly attrEnableBfd: string | IResolvable;

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

Attribute EnableBfd: Indicates whether BFD is enabled.

Valid values: false true

attrGmtModified^Required

public readonly attrGmtModified: string | IResolvable;

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

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

attrHold^Required

public readonly attrHold: string | IResolvable;

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

Attribute Hold: The hold time.

attrIpVersion^Required

public readonly attrIpVersion: string | IResolvable;

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

Attribute IpVersion: The version of the IP address.

attrIsFake^Required

public readonly attrIsFake: string | IResolvable;

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

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

Valid values: false true

attrKeepalive^Required

public readonly attrKeepalive: string | IResolvable;

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

Attribute Keepalive: The Keepalive interval.

attrLocalAsn^Required

public readonly attrLocalAsn: string | IResolvable;

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

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

attrName^Required

public readonly attrName: string | IResolvable;

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

Attribute Name: The name of the BGP peer.

attrPeerAsn^Required

public readonly attrPeerAsn: string | IResolvable;

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

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

attrPeerIpAddress^Required

public readonly attrPeerIpAddress: string | IResolvable;

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

Attribute PeerIpAddress: The IP address of the BGP peer.

attrReceivedRouteCount^Required

public readonly attrReceivedRouteCount: string | IResolvable;

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

Attribute ReceivedRouteCount: The number of received routes.

attrRouteLimit^Required

public readonly attrRouteLimit: string | IResolvable;

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

Attribute RouteLimit: The maximum number of routes.

attrRouterId^Required

public readonly attrRouterId: string | IResolvable;

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

Attribute RouterId: The Router ID.

attrStatus^Required

public readonly attrStatus: string | IResolvable;

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

Attribute Status: The status of the BGP peer.

Valid values: Pending Available Modifying Deleting Deleted

props^Required

public readonly props: BgpPeerProps;

• Type: BgpPeerProps