Skip to content

BgpPeer

This class encapsulates and extends the ROS resource type ALIYUN::VPC::BgpPeer, which is used to add a Border Gateway Protocol (BGP) peer to a specific BGP group.

Initializers

import com.aliyun.ros.cdk.vpc.BgpPeer;
BgpPeer.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .bgpGroupId(java.lang.String)
    .bgpGroupId(IResolvable)
//  .enableBfd(java.lang.Boolean)
//  .enableBfd(IResolvable)
//  .peerIpAddress(java.lang.String)
//  .peerIpAddress(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.
bgpGroupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property bgpGroupId: The ID of the BGP group.
enableBfd java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property enableBfd: Specifies whether to enable the Bidirectional Forwarding Detection (BFD) feature.
peerIpAddress java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property peerIpAddress: The IP address of the BGP peer.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

bgpGroupIdRequired

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

Property bgpGroupId: The ID of the BGP group.


enableBfdOptional

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

Property enableBfd: Specifies whether to enable the Bidirectional Forwarding Detection (BFD) feature.

Valid values: true: enables BFD. false: disables BFD.


peerIpAddressOptional

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

Property peerIpAddress: The IP address of the BGP peer.


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.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.
attrBgpPeerId com.aliyun.ros.cdk.core.IResolvable Attribute BgpPeerId: The ID 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

attrBgpPeerIdRequired

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

Attribute BgpPeerId: The ID of the BGP peer.