Skip to content

CenVbrHealthCheck

This class encapsulates and extends the ROS resource type ALIYUN::CEN::CenVbrHealthCheck, which is used to enable the health check feature or modify the health check configuration for a virtual border router (VBR).

Initializers 

import com.aliyun.ros.cdk.cen.CenVbrHealthCheck;
CenVbrHealthCheck.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .cenId(java.lang.String)
    .cenId(IResolvable)
    .healthCheckTargetIp(java.lang.String)
    .healthCheckTargetIp(IResolvable)
    .vbrInstanceId(java.lang.String)
    .vbrInstanceId(IResolvable)
    .vbrInstanceRegionId(java.lang.String)
    .vbrInstanceRegionId(IResolvable)
//  .healthCheckInterval(java.lang.Number)
//  .healthCheckInterval(IResolvable)
//  .healthCheckSourceIp(java.lang.String)
//  .healthCheckSourceIp(IResolvable)
//  .healthyThreshold(java.lang.Number)
//  .healthyThreshold(IResolvable)
//  .vbrInstanceOwnerId(java.lang.Number)
//  .vbrInstanceOwnerId(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.
cenId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property cenId: The ID of the CEN instance.
healthCheckTargetIp java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property healthCheckTargetIp: Specifies the destination IP address of the health check.
vbrInstanceId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vbrInstanceId: The ID of the VBR instance.
vbrInstanceRegionId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property vbrInstanceRegionId: The ID of the region where the VBR instance is deployed.
healthCheckInterval java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property healthCheckInterval: Specifies the time interval at which probe packets are sent during the health check.
healthCheckSourceIp java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property healthCheckSourceIp: You can use either of the following methods to specify the source IP address of the health check.
healthyThreshold java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property healthyThreshold: Specifies the number of probe packets to be sent during the health check.
vbrInstanceOwnerId java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property vbrInstanceOwnerId: The User ID (UID) of the account to which the VBR instance belongs.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

cenIdRequired

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

Property cenId: The ID of the CEN instance.

healthCheckTargetIpRequired

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

Property healthCheckTargetIp: Specifies the destination IP address of the health check.

The destination IP address is the IP address of the client-facing interface on the VBR instance.

vbrInstanceIdRequired

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

Property vbrInstanceId: The ID of the VBR instance.

vbrInstanceRegionIdRequired

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

Property vbrInstanceRegionId: The ID of the region where the VBR instance is deployed.

You can call the DescribeRegionsoperation to query region IDs.

healthCheckIntervalOptional

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

Property healthCheckInterval: Specifies the time interval at which probe packets are sent during the health check.

Default value: 2. Valid values: 2 to 3. Unit: second.

healthCheckSourceIpOptional

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

Property healthCheckSourceIp: You can use either of the following methods to specify the source IP address of the health check.

Automatic IP Address: The system automatically assigns an IP address within the CIDR block 100.96.0.0/16 (recommended). Custom IP Address: You can specify a source IP address that is available within the CIDR block 10.0.0.0/8, 192.168.0.0/16, or 172.16.0.0/12. The specified source IP address must not overlap with the IP addresses of the Alibaba Cloud-facing and client-facing interfaces on the VBR instance, or the IP addresses of the instances with which the VBR instance needs to communicate in the CEN.

healthyThresholdOptional

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

Property healthyThreshold: Specifies the number of probe packets to be sent during the health check.

Default value: 8. Valid values: 3 to 8. Unit: packet.

vbrInstanceOwnerIdOptional

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

Property vbrInstanceOwnerId: The User ID (UID) of the account to which the VBR instance belongs.

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.cen.CenVbrHealthCheck;
CenVbrHealthCheck.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.
attrCenId com.aliyun.ros.cdk.core.IResolvable Attribute CenId: The ID of the CEN instance.
attrHealthCheckInterval com.aliyun.ros.cdk.core.IResolvable Attribute HealthCheckInterval: Specifies the time interval at which probe packets are sent during the health check.
attrHealthCheckSourceIp com.aliyun.ros.cdk.core.IResolvable Attribute HealthCheckSourceIp: You can use either of the following methods to specify the source IP address of the health check.
attrHealthCheckTargetIp com.aliyun.ros.cdk.core.IResolvable Attribute HealthCheckTargetIp: Specifies the destination IP address of the health check.
attrHealthyThreshold com.aliyun.ros.cdk.core.IResolvable Attribute HealthyThreshold: Specifies the number of probe packets to be sent during the health check.
attrVbrInstanceId com.aliyun.ros.cdk.core.IResolvable Attribute VbrInstanceId: The ID of the VBR instance.
attrVbrInstanceOwnerId com.aliyun.ros.cdk.core.IResolvable Attribute VbrInstanceOwnerId: The User ID (UID) of the account to which the VBR instance belongs.
attrVbrInstanceRegionId com.aliyun.ros.cdk.core.IResolvable Attribute VbrInstanceRegionId: The ID of the region where the VBR instance is deployed.

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

attrCenIdRequired 

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

Attribute CenId: The ID of the CEN instance.

attrHealthCheckIntervalRequired 

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

Attribute HealthCheckInterval: Specifies the time interval at which probe packets are sent during the health check.

Default value: 2. Valid values: 2 to 3. Unit: second.

attrHealthCheckSourceIpRequired 

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

Attribute HealthCheckSourceIp: You can use either of the following methods to specify the source IP address of the health check.

Automatic IP Address: The system automatically assigns an IP address within the CIDR block 100.96.0.0/16 (recommended). Custom IP Address: You can specify a source IP address that is available within the CIDR block 10.0.0.0/8, 192.168.0.0/16, or 172.16.0.0/12. The specified source IP address must not overlap with the IP addresses of the Alibaba Cloud-facing and client-facing interfaces on the VBR instance, or the IP addresses of the instances with which the VBR instance needs to communicate in the CEN.

attrHealthCheckTargetIpRequired 

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

Attribute HealthCheckTargetIp: Specifies the destination IP address of the health check.

The destination IP address is the IP address of the client-facing interface on the VBR instance.

attrHealthyThresholdRequired 

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

Attribute HealthyThreshold: Specifies the number of probe packets to be sent during the health check.

Default value: 8. Valid values: 3 to 8. Unit: packet.

attrVbrInstanceIdRequired 

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

Attribute VbrInstanceId: The ID of the VBR instance.

attrVbrInstanceOwnerIdRequired 

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

Attribute VbrInstanceOwnerId: The User ID (UID) of the account to which the VBR instance belongs.

attrVbrInstanceRegionIdRequired 

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

Attribute VbrInstanceRegionId: The ID of the region where the VBR instance is deployed.

You can call the DescribeRegionsoperation to query region IDs.