HealthCheckTemplateProps

Properties for defining a HealthCheckTemplate.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-alb-healthchecktemplate

Initializer

import { HealthCheckTemplateProps } from '@alicloud/ros-cdk-alb'
const healthCheckTemplateProps: HealthCheckTemplateProps = { ... }

Properties

healthCheckTemplateName^Required

public readonly healthCheckTemplateName: string | IResolvable;

• Type: string | @alicloud/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.

healthCheckCodes^Optional

public readonly healthCheckCodes: IResolvable | string | IResolvable[];

• Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

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

healthCheckConnectPort^Optional

public readonly healthCheckConnectPort: number | IResolvable;

• Type: number | @alicloud/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.

healthCheckHost^Optional

public readonly healthCheckHost: string | IResolvable;

• Type: string | @alicloud/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.

healthCheckHttpVersion^Optional

public readonly healthCheckHttpVersion: string | IResolvable;

• Type: string | @alicloud/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.

healthCheckInterval^Optional

public readonly healthCheckInterval: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property healthCheckInterval: The interval between two consecutive health checks.

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

healthCheckMethod^Optional

public readonly healthCheckMethod: string | IResolvable;

• Type: string | @alicloud/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.

healthCheckPath^Optional

public readonly healthCheckPath: string | IResolvable;

• Type: string | @alicloud/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.

healthCheckProtocol^Optional

public readonly healthCheckProtocol: string | IResolvable;

• Type: string | @alicloud/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.

healthCheckTimeout^Optional

public readonly healthCheckTimeout: number | IResolvable;

• Type: number | @alicloud/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.

healthyThreshold^Optional

public readonly healthyThreshold: number | IResolvable;

• Type: number | @alicloud/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.

resourceGroupId^Optional

public readonly resourceGroupId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property resourceGroupId: The ID of the resource group.

unhealthyThreshold^Optional

public readonly unhealthyThreshold: number | IResolvable;

• Type: number | @alicloud/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.