import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * Health checks are essential for ensuring application availability. ALB regularly performs health checks on backend servers to verify whether they can accept new requests. If a backend server fails to respond properly to ALB's health check requests, client traffic will not be routed to that server. ALB forwards traffic to other servers with a healthy status, ensuring service continuity and reliability. ALB health checks are performed based on server groups. Once health checks are enabled for a server group, ALB periodically checks the status of backend servers within the group. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as volcenginecc from "@volcengine/pulumi-volcenginecc"; * * const aLBHealthCheckTemplateDemo = new volcenginecc.alb.HealthCheckTemplate("ALBHealthCheckTemplateDemo", { * description: "asdfgh", * healthCheckDomain: "test.com", * healthCheckHttpCode: "http_2xx,http_3xx", * healthCheckHttpVersion: "HTTP1.0", * healthCheckInterval: 2, * healthCheckMethod: "HEAD", * healthCheckPort: 0, * healthCheckProtocol: "HTTP", * healthCheckTemplateName: "test-test-1001", * healthCheckTimeout: 2, * healthCheckUri: "/", * healthyThreshold: 3, * unhealthyThreshold: 3, * projectName: "default", * tags: [{ * key: "env", * value: "test", * }], * }); * ``` * * ## Import * * ```sh * $ pulumi import volcenginecc:alb/healthCheckTemplate:HealthCheckTemplate example "health_check_template_id" * ``` */ export declare class HealthCheckTemplate extends pulumi.CustomResource { /** * Get an existing HealthCheckTemplate resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: HealthCheckTemplateState, opts?: pulumi.CustomResourceOptions): HealthCheckTemplate; /** * Returns true if the given object is an instance of HealthCheckTemplate. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is HealthCheckTemplate; /** * Creation time of the health check template. */ readonly createTime: pulumi.Output; /** * Description of the health check. Cannot start with http:// or https://. Must begin with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (,), and Chinese periods (。). Length must be 1–255 characters. If not specified, defaults to an empty string. */ readonly description: pulumi.Output; /** * Domain name for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must contain at least one '.', and cannot start or end with '.'. The string can contain letters, numbers, '-', and '.' characters. '-' cannot appear at the beginning or end of the string. Length must be between 1 and 128 characters. If not specified, this parameter is empty and the load balancer uses the private IP address of each backend server for health checks. */ readonly healthCheckDomain: pulumi.Output; /** * HTTP status codes indicating a successful health check. Separate multiple codes with commas. This parameter is only effective when HealthCheckProtocol is set to HTTP. Options: http*2xx (default), http*3xx (default), http*4xx, http*5xx. */ readonly healthCheckHttpCode: pulumi.Output; /** * HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1. */ readonly healthCheckHttpVersion: pulumi.Output; /** * Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds. */ readonly healthCheckInterval: pulumi.Output; /** * Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method) */ readonly healthCheckMethod: pulumi.Output; /** * Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks. */ readonly healthCheckPort: pulumi.Output; /** * Protocol for the health check. HTTP or TCP. */ readonly healthCheckProtocol: pulumi.Output; /** * Health check template ID. */ readonly healthCheckTemplateId: pulumi.Output; /** * Name of the health check template. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can contain numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. */ readonly healthCheckTemplateName: pulumi.Output; /** * Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds. */ readonly healthCheckTimeout: pulumi.Output; /** * Path for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must start with '/'. Can only contain letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' characters. Length must be between 1 and 128 characters. If not specified, defaults to '/'. */ readonly healthCheckUri: pulumi.Output; /** * Health threshold for the health check. Default is 3. Range: 2–10 times. */ readonly healthyThreshold: pulumi.Output; /** * Project name to which the health check template belongs. */ readonly projectName: pulumi.Output; readonly tags: pulumi.Output; /** * Unhealthy threshold for health checks. Default is 3; range is 2–10 times. */ readonly unhealthyThreshold: pulumi.Output; /** * Last operation time of the health check template. */ readonly updateTime: pulumi.Output; /** * Create a HealthCheckTemplate resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: HealthCheckTemplateArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering HealthCheckTemplate resources. */ export interface HealthCheckTemplateState { /** * Creation time of the health check template. */ createTime?: pulumi.Input; /** * Description of the health check. Cannot start with http:// or https://. Must begin with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (,), and Chinese periods (。). Length must be 1–255 characters. If not specified, defaults to an empty string. */ description?: pulumi.Input; /** * Domain name for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must contain at least one '.', and cannot start or end with '.'. The string can contain letters, numbers, '-', and '.' characters. '-' cannot appear at the beginning or end of the string. Length must be between 1 and 128 characters. If not specified, this parameter is empty and the load balancer uses the private IP address of each backend server for health checks. */ healthCheckDomain?: pulumi.Input; /** * HTTP status codes indicating a successful health check. Separate multiple codes with commas. This parameter is only effective when HealthCheckProtocol is set to HTTP. Options: http*2xx (default), http*3xx (default), http*4xx, http*5xx. */ healthCheckHttpCode?: pulumi.Input; /** * HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1. */ healthCheckHttpVersion?: pulumi.Input; /** * Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds. */ healthCheckInterval?: pulumi.Input; /** * Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method) */ healthCheckMethod?: pulumi.Input; /** * Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks. */ healthCheckPort?: pulumi.Input; /** * Protocol for the health check. HTTP or TCP. */ healthCheckProtocol?: pulumi.Input; /** * Health check template ID. */ healthCheckTemplateId?: pulumi.Input; /** * Name of the health check template. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can contain numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. */ healthCheckTemplateName?: pulumi.Input; /** * Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds. */ healthCheckTimeout?: pulumi.Input; /** * Path for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must start with '/'. Can only contain letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' characters. Length must be between 1 and 128 characters. If not specified, defaults to '/'. */ healthCheckUri?: pulumi.Input; /** * Health threshold for the health check. Default is 3. Range: 2–10 times. */ healthyThreshold?: pulumi.Input; /** * Project name to which the health check template belongs. */ projectName?: pulumi.Input; tags?: pulumi.Input[]>; /** * Unhealthy threshold for health checks. Default is 3; range is 2–10 times. */ unhealthyThreshold?: pulumi.Input; /** * Last operation time of the health check template. */ updateTime?: pulumi.Input; } /** * The set of arguments for constructing a HealthCheckTemplate resource. */ export interface HealthCheckTemplateArgs { /** * Description of the health check. Cannot start with http:// or https://. Must begin with a letter or Chinese character. May include numbers, English commas (,), periods (.), underscores (_), spaces ( ), equals signs (=), hyphens (-), Chinese commas (,), and Chinese periods (。). Length must be 1–255 characters. If not specified, defaults to an empty string. */ description?: pulumi.Input; /** * Domain name for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must contain at least one '.', and cannot start or end with '.'. The string can contain letters, numbers, '-', and '.' characters. '-' cannot appear at the beginning or end of the string. Length must be between 1 and 128 characters. If not specified, this parameter is empty and the load balancer uses the private IP address of each backend server for health checks. */ healthCheckDomain?: pulumi.Input; /** * HTTP status codes indicating a successful health check. Separate multiple codes with commas. This parameter is only effective when HealthCheckProtocol is set to HTTP. Options: http*2xx (default), http*3xx (default), http*4xx, http*5xx. */ healthCheckHttpCode?: pulumi.Input; /** * HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1. */ healthCheckHttpVersion?: pulumi.Input; /** * Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds. */ healthCheckInterval?: pulumi.Input; /** * Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method) */ healthCheckMethod?: pulumi.Input; /** * Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks. */ healthCheckPort?: pulumi.Input; /** * Protocol for the health check. HTTP or TCP. */ healthCheckProtocol?: pulumi.Input; /** * Name of the health check template. Cannot start with http:// or https://. Must start with a letter or Chinese character. Can contain numbers, periods (.), underscores (_), and hyphens (-). Length must be between 1 and 128 characters. */ healthCheckTemplateName: pulumi.Input; /** * Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds. */ healthCheckTimeout?: pulumi.Input; /** * Path for the health check. This parameter is only effective when HealthCheckProtocol is set to HTTP. Requirements: Must start with '/'. Can only contain letters, numbers, '-', '_', '/', '.', '%', '?', '#', '&', '=' characters. Length must be between 1 and 128 characters. If not specified, defaults to '/'. */ healthCheckUri?: pulumi.Input; /** * Health threshold for the health check. Default is 3. Range: 2–10 times. */ healthyThreshold?: pulumi.Input; /** * Project name to which the health check template belongs. */ projectName?: pulumi.Input; tags?: pulumi.Input[]>; /** * Unhealthy threshold for health checks. Default is 3; range is 2–10 times. */ unhealthyThreshold?: pulumi.Input; }