CenVbrHealthCheck

• Implements: ICenVbrHealthCheck

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
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

cen_id^Required

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

Property cenId: The ID of the CEN instance.

health_check_target_ip^Required

• 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_id^Required

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

Property vbrInstanceId: The ID of the VBR instance.

vbr_instance_region_id^Required

• 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_interval^Optional

• 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_ip^Optional

• 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_threshold^Optional

• 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_id^Optional

• 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_constraint^Optional

• Type: bool

Methods

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

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

count^Required

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

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

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

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

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

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

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

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_cen_id^Required

attr_cen_id: typing.Union[str, IResolvable]

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

Attribute CenId: The ID of the CEN instance.

attr_health_check_interval^Required

attr_health_check_interval: typing.Union[str, IResolvable]

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

attr_health_check_source_ip: typing.Union[str, IResolvable]

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

attr_health_check_target_ip: typing.Union[str, IResolvable]

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

attr_healthy_threshold: typing.Union[str, IResolvable]

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

attr_vbr_instance_id: typing.Union[str, IResolvable]

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

Attribute VbrInstanceId: The ID of the VBR instance.

attr_vbr_instance_owner_id^Required

attr_vbr_instance_owner_id: typing.Union[str, IResolvable]

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

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

attr_vbr_instance_region_id^Required

attr_vbr_instance_region_id: typing.Union[str, IResolvable]

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

props^Required

props: CenVbrHealthCheckProps

• Type: CenVbrHealthCheckProps