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 configurations for a virtual border router (VBR).

Initializers 

import ros_cdk_cen
ros_cdk_cen.CenVbrHealthCheck(
  scope: Construct,
  id: str,
  cen_id: typing.Union[str, IResolvable],
  health_check_target_ip: typing.Union[str, IResolvable],
  vbr_instance_id: typing.Union[str, IResolvable],
  vbr_instance_region_id: typing.Union[str, IResolvable],
  health_check_interval: typing.Union[typing.Union[int, float], IResolvable] = None,
  health_check_source_ip: typing.Union[str, IResolvable] = None,
  healthy_threshold: typing.Union[typing.Union[int, float], IResolvable] = None,
  vbr_instance_owner_id: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)
Name Type Description
scope ros_cdk_core.Construct No description.
id str No description.
cen_id typing.Union[str, ros_cdk_core.IResolvable] Property cenId: The ID of the CEN instance.
health_check_target_ip typing.Union[str, ros_cdk_core.IResolvable] Property healthCheckTargetIp: Specifies the destination IP address of the health check.
vbr_instance_id typing.Union[str, ros_cdk_core.IResolvable] Property vbrInstanceId: The ID of the VBR instance.
vbr_instance_region_id typing.Union[str, ros_cdk_core.IResolvable] Property vbrInstanceRegionId: The ID of the region where the VBR instance is deployed.
health_check_interval typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property healthCheckInterval: Specifies the time interval at which probe packets are sent during the health check.
health_check_source_ip typing.Union[str, ros_cdk_core.IResolvable] Property healthCheckSourceIp: You can use either of the following methods to specify the source IP address of the health check.
healthy_threshold typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property healthyThreshold: Specifies the number of probe packets to be sent during the health check.
vbr_instance_owner_id typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable] Property vbrInstanceOwnerId: The User ID (UID) of the account to which the VBR instance belongs.
enable_resource_property_constraint bool No description.

scopeRequired

  • Type: ros_cdk_core.Construct

idRequired

  • Type: str

cen_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property cenId: The ID of the CEN instance.

health_check_target_ipRequired

  • Type: typing.Union[str, 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.

vbr_instance_idRequired

  • Type: typing.Union[str, ros_cdk_core.IResolvable]

Property vbrInstanceId: The ID of the VBR instance.

vbr_instance_region_idRequired

  • Type: typing.Union[str, 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.

health_check_intervalOptional

  • Type: typing.Union[typing.Union[int, float], 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.

health_check_source_ipOptional

  • Type: typing.Union[str, 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.

healthy_thresholdOptional

  • Type: typing.Union[typing.Union[int, float], 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.

vbr_instance_owner_idOptional

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

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

enable_resource_property_constraintOptional

  • Type: bool

Methods

Name Description
to_string Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
add_condition No description.
add_count No description.
add_dependency No description.
add_resource_desc No description.
apply_removal_policy No description.
get_att No description.
set_metadata No description.

to_string 

def to_string() -> str

Returns a string representation of this construct.

synthesize 

def synthesize(
  session: ISynthesisSession
) -> None

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: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition 

def add_condition(
  condition: RosCondition
) -> None

conditionRequired

  • Type: ros_cdk_core.RosCondition

add_count 

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

countRequired

  • Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency 

def add_dependency(
  resource: Resource
) -> None

resourceRequired

  • Type: ros_cdk_core.Resource

add_resource_desc 

def add_resource_desc(
  desc: str
) -> None

descRequired

  • Type: str

apply_removal_policy 

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policyRequired

  • Type: ros_cdk_core.RemovalPolicy

get_att 

def get_att(
  name: str
) -> IResolvable

nameRequired

  • Type: str

set_metadata 

def set_metadata(
  key: str,
  value: typing.Any
) -> None

keyRequired

  • Type: str

valueRequired

  • Type: typing.Any

Static Functions

Name Description
is_construct Return whether the given object is a Construct.

is_construct 

import ros_cdk_cen
ros_cdk_cen.CenVbrHealthCheck.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

xRequired

  • Type: typing.Any

Properties

Name Type Description
node ros_cdk_core.ConstructNode The construct tree node associated with this construct.
ref str No description.
stack ros_cdk_core.Stack The stack in which this resource is defined.
resource ros_cdk_core.RosResource No description.
attr_cen_id ros_cdk_core.IResolvable Attribute CenId: The ID of the CEN instance.
attr_health_check_interval ros_cdk_core.IResolvable Attribute HealthCheckInterval: Specifies the time interval at which probe packets are sent during the health check.
attr_health_check_source_ip ros_cdk_core.IResolvable Attribute HealthCheckSourceIp: You can use either of the following methods to specify the source IP address of the health check.
attr_health_check_target_ip ros_cdk_core.IResolvable Attribute HealthCheckTargetIp: Specifies the destination IP address of the health check.
attr_healthy_threshold ros_cdk_core.IResolvable Attribute HealthyThreshold: Specifies the number of probe packets to be sent during the health check.
attr_vbr_instance_id ros_cdk_core.IResolvable Attribute VbrInstanceId: The ID of the VBR instance.
attr_vbr_instance_owner_id ros_cdk_core.IResolvable Attribute VbrInstanceOwnerId: The User ID (UID) of the account to which the VBR instance belongs.
attr_vbr_instance_region_id ros_cdk_core.IResolvable Attribute VbrInstanceRegionId: The ID of the region where the VBR instance is deployed.

nodeRequired 

node: ConstructNode
  • Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

refRequired 

ref: str
  • Type: str

stackRequired 

stack: Stack
  • Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resourceOptional 

resource: RosResource
  • Type: ros_cdk_core.RosResource

attr_cen_idRequired 

attr_cen_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute CenId: The ID of the CEN instance.

attr_health_check_intervalRequired 

attr_health_check_interval: IResolvable
  • Type: 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.

attr_health_check_source_ipRequired 

attr_health_check_source_ip: IResolvable
  • Type: 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.

attr_health_check_target_ipRequired 

attr_health_check_target_ip: IResolvable
  • Type: 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.

attr_healthy_thresholdRequired 

attr_healthy_threshold: IResolvable
  • Type: 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.

attr_vbr_instance_idRequired 

attr_vbr_instance_id: IResolvable
  • Type: ros_cdk_core.IResolvable

Attribute VbrInstanceId: The ID of the VBR instance.

attr_vbr_instance_owner_idRequired 

attr_vbr_instance_owner_id: IResolvable
  • Type: ros_cdk_core.IResolvable

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

attr_vbr_instance_region_idRequired 

attr_vbr_instance_region_id: IResolvable
  • Type: 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.