HealthCheckTemplate

• Implements: IHealthCheckTemplate

This class encapsulates and extends the ROS resource type ALIYUN::ALB::HealthCheckTemplate.

Initializers

import ros_cdk_alb
ros_cdk_alb.HealthCheckTemplate(
  scope: Construct,
  id: str,
  health_check_template_name: typing.Union[str, IResolvable],
  health_check_codes: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  health_check_connect_port: typing.Union[typing.Union[int, float], IResolvable] = None,
  health_check_host: typing.Union[str, IResolvable] = None,
  health_check_http_version: typing.Union[str, IResolvable] = None,
  health_check_interval: typing.Union[typing.Union[int, float], IResolvable] = None,
  health_check_method: typing.Union[str, IResolvable] = None,
  health_check_path: typing.Union[str, IResolvable] = None,
  health_check_protocol: typing.Union[str, IResolvable] = None,
  health_check_timeout: typing.Union[typing.Union[int, float], IResolvable] = None,
  healthy_threshold: typing.Union[typing.Union[int, float], IResolvable] = None,
  resource_group_id: typing.Union[str, IResolvable] = None,
  unhealthy_threshold: 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

health_check_template_name^Required

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

Property healthCheckTemplateName: The name of the health check template.

The name must be 2 to 128 characters in length, must start with a letter, a digit, or a Chinese character, and can contain digits, periods (.), underscores (_), hyphens (-), and spaces.

health_check_codes^Optional

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

Property healthCheckCodes: The HTTP status codes that indicate a successful health check.

health_check_connect_port^Optional

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

Property healthCheckConnectPort: The port that is used for health checks.

Valid values: 0 to 65535. Default value: 0. This value indicates that the port on a backend server is used for health checks.

health_check_host^Optional

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

Property healthCheckHost: The domain name used for the health check.

Valid values:

• $SERVER_IP: The private IP address of a backend server. If you set this parameter to $SERVER_IP or leave it empty, the load balancer uses the private IP address of the backend server as the domain name for the health check.
• domain: The domain name must be 1 to 80 characters in length and can contain letters, digits, periods (.), and hyphens (-).

This parameter takes effect only when the HealthCheckProtocol parameter is set to HTTP or HTTPS.

health_check_http_version^Optional

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

Property healthCheckHttpVersion: The HTTP version for health check protocol.

Valid values: HTTP1.0 or HTTP1.1. Default value: HTTP 1.1. This parameter is available only when HealthCheckProtocol is set to HTTP or HTTPS.

health_check_interval^Optional

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

Property healthCheckInterval: The interval between two consecutive health checks.

Unit: seconds. Valid values: 1 to 50. Default value: 2.

health_check_method^Optional

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

Property healthCheckMethod: The method used for the health check.

Valid values:

• HEAD (default): For HTTP and HTTPS listeners, the default health check method is HEAD.
• POST: For gRPC listeners, the default health check method is POST.
• GET: If the response body exceeds 8 KB, it is truncated. This does not affect the health check result.

This parameter takes effect only when the HealthCheckProtocol parameter is set to HTTP, HTTPS, or gRPC.

health_check_path^Optional

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

Property healthCheckPath: The URL that is used for health checks.

The URL must be 1 to 80 characters in length. It must start with a forward slash (/) and can contain letters, digits, and the following special characters: - \/ . % ? # & _;~!()*[]@$^:',+.

This parameter takes effect only when the HealthCheckProtocol parameter is set to HTTP or HTTPS.

health_check_protocol^Optional

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

Property healthCheckProtocol: The protocol used for the health check.

Valid values:

• HTTP (default): simulates browser access by sending HEAD or GET requests to check whether the server application is healthy.
• HTTPS: simulates browser access by sending HEAD or GET requests to check whether the server application is healthy. HTTPS provides encrypted data transmission and is more secure than HTTP.
• TCP: checks whether the server port is responsive by sending SYN packets.
• gRPC: checks whether the server application is healthy by sending POST or GET requests.

health_check_timeout^Optional

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

Property healthCheckTimeout: The timeout period of a health check.

Unit: seconds. If a backend server does not respond within the specified timeout period, the backend server fails the health check. Valid values: 1 to 300. Default value: 5. Note If the value of the HealthCheckTimeout parameter is smaller than that of the HealthCheckInterval parameter, the timeout period specified by the HealthCheckTimeout parameter is ignored and the value of the HealthCheckInterval parameter is used as the timeout period.

healthy_threshold^Optional

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

Property healthyThreshold: The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy.

In this case, the health status is changed from fail to success. Valid values: 2 to 10. Default value: 3.

resource_group_id^Optional

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

Property resourceGroupId: The ID of the resource group.

unhealthy_threshold^Optional

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

Property unhealthyThreshold: The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy.

In this case, the health status is changed from success to fail. Valid values: 2 to 10. Default value: 3.

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_alb
ros_cdk_alb.HealthCheckTemplate.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_health_check_template_id^Required

attr_health_check_template_id: typing.Union[str, IResolvable]

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

Attribute HealthCheckTemplateId: The ID of the health check template.

props^Required

props: HealthCheckTemplateProps

• Type: HealthCheckTemplateProps