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 com.aliyun.ros.cdk.vpc.datasource.BgpPeer;
BgpPeer.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .bgpPeerId(java.lang.String)
//  .bgpPeerId(IResolvable)
//  .refreshOptions(java.lang.String)
//  .refreshOptions(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
bgpPeerId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property bgpPeerId: The ID of the BGP peer.
refreshOptions java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property refreshOptions: The refresh strategy for the datasource resource when the stack is updated.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

bgpPeerIdOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property bgpPeerId: The ID of the BGP peer.

refreshOptionsOptional

  • Type: java.lang.String OR com.aliyun.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.

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 java.lang.String toString()

Returns a string representation of this construct.

synthesize 

public void synthesize(ISynthesisSession session)

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: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.

addCondition 

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount 

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency 

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc 

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy 

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

getAtt 

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata 

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

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

isConstruct 

import com.aliyun.ros.cdk.vpc.datasource.BgpPeer;
BgpPeer.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

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

nodeRequired 

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

refRequired 

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired 

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

resourceOptional 

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrAdvertisedRouteCountRequired 

public IResolvable getAttrAdvertisedRouteCount();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AdvertisedRouteCount: The number of advertised routes.

attrAuthKeyRequired 

public IResolvable getAttrAuthKey();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AuthKey: The authentication key of the BGP group.

attrBfdMultiHopRequired 

public IResolvable getAttrBfdMultiHop();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrBgpGroupIdRequired 

public IResolvable getAttrBgpGroupId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute BgpGroupId: The ID of the BGP group.

attrBgpPeerIdRequired 

public IResolvable getAttrBgpPeerId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute BgpPeerId: The ID of the BGP peer.

attrBgpStatusRequired 

public IResolvable getAttrBgpStatus();
  • Type: com.aliyun.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 IResolvable getAttrDescription();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Description: The description of the BGP group.

attrEnableBfdRequired 

public IResolvable getAttrEnableBfd();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute EnableBfd: Indicates whether BFD is enabled.

Valid values: false true

attrGmtModifiedRequired 

public IResolvable getAttrGmtModified();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrHoldRequired 

public IResolvable getAttrHold();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Hold: The hold time.

attrIpVersionRequired 

public IResolvable getAttrIpVersion();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute IpVersion: The version of the IP address.

attrIsFakeRequired 

public IResolvable getAttrIsFake();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

Valid values: false true

attrKeepaliveRequired 

public IResolvable getAttrKeepalive();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Keepalive: The Keepalive interval.

attrLocalAsnRequired 

public IResolvable getAttrLocalAsn();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrNameRequired 

public IResolvable getAttrName();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Name: The name of the BGP peer.

attrPeerAsnRequired 

public IResolvable getAttrPeerAsn();
  • Type: com.aliyun.ros.cdk.core.IResolvable

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

attrPeerIpAddressRequired 

public IResolvable getAttrPeerIpAddress();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PeerIpAddress: The IP address of the BGP peer.

attrReceivedRouteCountRequired 

public IResolvable getAttrReceivedRouteCount();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute ReceivedRouteCount: The number of received routes.

attrRouteLimitRequired 

public IResolvable getAttrRouteLimit();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute RouteLimit: The maximum number of routes.

attrRouterIdRequired 

public IResolvable getAttrRouterId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute RouterId: The Router ID.

attrStatusRequired 

public IResolvable getAttrStatus();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute Status: The status of the BGP peer.

Valid values: Pending Available Modifying Deleting Deleted