CenVbrHealthCheck
- Implements: ICenVbrHealthCheck
This class encapsulates and extends the ROS resource type ALIYUN::CEN::CenVbrHealthCheck.
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. |
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.cen.CenVbrHealthCheck;
CenVbrHealthCheck.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. |
attrCenId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CenId: The ID of the CEN instance. |
attrHealthCheckInterval | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute HealthCheckInterval: Specifies the time interval at which probe packets are sent during the health check. |
attrHealthCheckSourceIp | java.lang.String OR 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 | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute HealthCheckTargetIp: Specifies the destination IP address of the health check. |
attrHealthyThreshold | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute HealthyThreshold: Specifies the number of probe packets to be sent during the health check. |
attrVbrInstanceId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VbrInstanceId: The ID of the VBR instance. |
attrVbrInstanceOwnerId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VbrInstanceOwnerId: The User ID (UID) of the account to which the VBR instance belongs. |
attrVbrInstanceRegionId | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute VbrInstanceRegionId: The ID of the region where the VBR instance is deployed. |
props | CenVbrHealthCheckProps | 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
attrCenIdRequired
public java.lang.Object getAttrCenId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CenId: The ID of the CEN instance.
attrHealthCheckIntervalRequired
public java.lang.Object getAttrHealthCheckInterval();
- Type: java.lang.String OR 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 java.lang.Object getAttrHealthCheckSourceIp();
- Type: java.lang.String OR 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 java.lang.Object getAttrHealthCheckTargetIp();
- Type: java.lang.String OR 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 java.lang.Object getAttrHealthyThreshold();
- Type: java.lang.String OR 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 java.lang.Object getAttrVbrInstanceId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VbrInstanceId: The ID of the VBR instance.
attrVbrInstanceOwnerIdRequired
public java.lang.Object getAttrVbrInstanceOwnerId();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute VbrInstanceOwnerId: The User ID (UID) of the account to which the VBR instance belongs.
attrVbrInstanceRegionIdRequired
public java.lang.Object getAttrVbrInstanceRegionId();
- Type: java.lang.String OR 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.
propsRequired
public CenVbrHealthCheckProps getProps();
- Type: CenVbrHealthCheckProps