BgpPeer
- Implements: IBgpPeer
This class encapsulates and extends the ROS resource type ALIYUN::VPC::BgpPeer.
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)
// .bfdMultiHop(java.lang.Number)
// .bfdMultiHop(IResolvable)
// .enableBfd(java.lang.Boolean)
// .enableBfd(IResolvable)
// .ipVersion(java.lang.String)
// .ipVersion(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. |
bfdMultiHop | java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable | Property bfdMultiHop: The BFD hop count. |
enableBfd | java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable | Property enableBfd: Specifies whether to enable the Bidirectional Forwarding Detection (BFD) feature. |
ipVersion | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property ipVersion: The IP version. |
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.
bfdMultiHopOptional
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
Property bfdMultiHop: The BFD hop count.
Valid values: 1 to 255. When enabling BFD, this parameter must be configured. It specifies the maximum number of hops that a packet can traverse from source to destination. You can set different hop counts based on actual physical link conditions. When using BFD in a multi-cloud environment or direct fiber connection without intermediate bridging devices, change the default BFD hop count from 255 to 1.
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.
ipVersionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property ipVersion: The IP version.
Valid values:
- IPv4 (default): IPv4 version.
- IPv6: IPv6 version. IPv6 is supported only when the VBR associated with the BGP group has IPv6 enabled.
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. |
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- 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.
- 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. |
attrBgpPeerId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute BgpPeerId: The ID 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
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.
propsRequired
public BgpPeerProps getProps();
- Type: BgpPeerProps