Skip to content

BgpPeer

  • Implements: com.aliyun.ros.cdk.vpc.datasource.IBgpPeer

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

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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
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 java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AdvertisedRouteCount: The number of advertised routes.
attrAuthKey java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute AuthKey: The authentication key of the BGP group.
attrBfdMultiHop java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute BfdMultiHop: The Bidirectional Forwarding Detection (BFD) hop count.
attrBgpGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute BgpGroupId: The ID of the BGP group.
attrBgpPeerId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute BgpPeerId: The ID of the BGP peer.
attrBgpStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute BgpStatus: The status of the BGP connection.
attrDescription java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Description: The description of the BGP group.
attrEnableBfd java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute EnableBfd: Indicates whether BFD is enabled.
attrGmtModified java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute GmtModified: The time when the BGP peer is modified.
attrHold java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Hold: The hold time.
attrIpVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute IpVersion: The version of the IP address.
attrIsFake java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute IsFake: Indicates whether a fake autonomous system number (ASN) is used.
attrKeepalive java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Keepalive: The Keepalive interval.
attrLocalAsn java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute LocalAsn: The ASN of the device on the Alibaba Cloud side.
attrName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Name: The name of the BGP peer.
attrPeerAsn java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PeerAsn: The autonomous system number (ASN)of the BGP peer.
attrPeerIpAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PeerIpAddress: The IP address of the BGP peer.
attrReceivedRouteCount java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute ReceivedRouteCount: The number of received routes.
attrRouteLimit java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RouteLimit: The maximum number of routes.
attrRouterId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute RouterId: The Router ID.
attrStatus java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Status: The status of the BGP peer.
props BgpPeerProps No description.

nodeRequired

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

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.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.


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 java.lang.Object getAttrAdvertisedRouteCount();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AdvertisedRouteCount: The number of advertised routes.


attrAuthKeyRequired

public java.lang.Object getAttrAuthKey();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute AuthKey: The authentication key of the BGP group.


attrBfdMultiHopRequired

public java.lang.Object getAttrBfdMultiHop();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrBgpGroupIdRequired

public java.lang.Object getAttrBgpGroupId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute BgpGroupId: The ID of the BGP group.


attrBgpPeerIdRequired

public java.lang.Object getAttrBgpPeerId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute BgpPeerId: The ID of the BGP peer.


attrBgpStatusRequired

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

Attribute Description: The description of the BGP group.


attrEnableBfdRequired

public java.lang.Object getAttrEnableBfd();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute EnableBfd: Indicates whether BFD is enabled.

Valid values: false true


attrGmtModifiedRequired

public java.lang.Object getAttrGmtModified();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrHoldRequired

public java.lang.Object getAttrHold();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Hold: The hold time.


attrIpVersionRequired

public java.lang.Object getAttrIpVersion();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute IpVersion: The version of the IP address.


attrIsFakeRequired

public java.lang.Object getAttrIsFake();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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

Valid values: false true


attrKeepaliveRequired

public java.lang.Object getAttrKeepalive();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Keepalive: The Keepalive interval.


attrLocalAsnRequired

public java.lang.Object getAttrLocalAsn();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrNameRequired

public java.lang.Object getAttrName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Name: The name of the BGP peer.


attrPeerAsnRequired

public java.lang.Object getAttrPeerAsn();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

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


attrPeerIpAddressRequired

public java.lang.Object getAttrPeerIpAddress();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute PeerIpAddress: The IP address of the BGP peer.


attrReceivedRouteCountRequired

public java.lang.Object getAttrReceivedRouteCount();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute ReceivedRouteCount: The number of received routes.


attrRouteLimitRequired

public java.lang.Object getAttrRouteLimit();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute RouteLimit: The maximum number of routes.


attrRouterIdRequired

public java.lang.Object getAttrRouterId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute RouterId: The Router ID.


attrStatusRequired

public java.lang.Object getAttrStatus();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Status: The status of the BGP peer.

Valid values: Pending Available Modifying Deleting Deleted


propsRequired

public BgpPeerProps getProps();