published on Thursday, Apr 23, 2026 by Volcengine
published on Thursday, Apr 23, 2026 by Volcengine
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
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 pulumi
import pulumi_volcenginecc as volcenginecc
a_lb_health_check_template_demo = volcenginecc.alb.HealthCheckTemplate("ALBHealthCheckTemplateDemo",
description="asdfgh",
health_check_domain="test.com",
health_check_http_code="http_2xx,http_3xx",
health_check_http_version="HTTP1.0",
health_check_interval=2,
health_check_method="HEAD",
health_check_port=0,
health_check_protocol="HTTP",
health_check_template_name="test-test-1001",
health_check_timeout=2,
health_check_uri="/",
healthy_threshold=3,
unhealthy_threshold=3,
project_name="default",
tags=[{
"key": "env",
"value": "test",
}])
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/alb"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := alb.NewHealthCheckTemplate(ctx, "ALBHealthCheckTemplateDemo", &alb.HealthCheckTemplateArgs{
Description: pulumi.String("asdfgh"),
HealthCheckDomain: pulumi.String("test.com"),
HealthCheckHttpCode: pulumi.String("http_2xx,http_3xx"),
HealthCheckHttpVersion: pulumi.String("HTTP1.0"),
HealthCheckInterval: pulumi.Int(2),
HealthCheckMethod: pulumi.String("HEAD"),
HealthCheckPort: pulumi.Int(0),
HealthCheckProtocol: pulumi.String("HTTP"),
HealthCheckTemplateName: pulumi.String("test-test-1001"),
HealthCheckTimeout: pulumi.Int(2),
HealthCheckUri: pulumi.String("/"),
HealthyThreshold: pulumi.Int(3),
UnhealthyThreshold: pulumi.Int(3),
ProjectName: pulumi.String("default"),
Tags: alb.HealthCheckTemplateTagArray{
&alb.HealthCheckTemplateTagArgs{
Key: pulumi.String("env"),
Value: pulumi.String("test"),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcenginecc = Volcengine.Pulumi.Volcenginecc;
return await Deployment.RunAsync(() =>
{
var aLBHealthCheckTemplateDemo = new Volcenginecc.Alb.HealthCheckTemplate("ALBHealthCheckTemplateDemo", new()
{
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 = new[]
{
new Volcenginecc.Alb.Inputs.HealthCheckTemplateTagArgs
{
Key = "env",
Value = "test",
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.alb.HealthCheckTemplate;
import com.volcengine.volcenginecc.alb.HealthCheckTemplateArgs;
import com.pulumi.volcenginecc.alb.inputs.HealthCheckTemplateTagArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var aLBHealthCheckTemplateDemo = new HealthCheckTemplate("aLBHealthCheckTemplateDemo", HealthCheckTemplateArgs.builder()
.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(HealthCheckTemplateTagArgs.builder()
.key("env")
.value("test")
.build())
.build());
}
}
resources:
aLBHealthCheckTemplateDemo:
type: volcenginecc:alb:HealthCheckTemplate
name: ALBHealthCheckTemplateDemo
properties:
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
Create HealthCheckTemplate Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new HealthCheckTemplate(name: string, args: HealthCheckTemplateArgs, opts?: CustomResourceOptions);@overload
def HealthCheckTemplate(resource_name: str,
args: HealthCheckTemplateArgs,
opts: Optional[ResourceOptions] = None)
@overload
def HealthCheckTemplate(resource_name: str,
opts: Optional[ResourceOptions] = None,
health_check_template_name: Optional[str] = None,
health_check_port: Optional[int] = None,
health_check_domain: Optional[str] = None,
health_check_http_version: Optional[str] = None,
health_check_interval: Optional[int] = None,
health_check_method: Optional[str] = None,
description: Optional[str] = None,
health_check_protocol: Optional[str] = None,
health_check_http_code: Optional[str] = None,
health_check_timeout: Optional[int] = None,
health_check_uri: Optional[str] = None,
healthy_threshold: Optional[int] = None,
project_name: Optional[str] = None,
tags: Optional[Sequence[HealthCheckTemplateTagArgs]] = None,
unhealthy_threshold: Optional[int] = None)func NewHealthCheckTemplate(ctx *Context, name string, args HealthCheckTemplateArgs, opts ...ResourceOption) (*HealthCheckTemplate, error)public HealthCheckTemplate(string name, HealthCheckTemplateArgs args, CustomResourceOptions? opts = null)
public HealthCheckTemplate(String name, HealthCheckTemplateArgs args)
public HealthCheckTemplate(String name, HealthCheckTemplateArgs args, CustomResourceOptions options)
type: volcenginecc:alb:HealthCheckTemplate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args HealthCheckTemplateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args HealthCheckTemplateArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args HealthCheckTemplateArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args HealthCheckTemplateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args HealthCheckTemplateArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
HealthCheckTemplate Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The HealthCheckTemplate resource accepts the following input properties:
- Health
Check stringTemplate Name - 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.
- Description string
- 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.
- Health
Check stringDomain - 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.
- Health
Check stringHttp Code - 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: http2xx (default), http3xx (default), http4xx, http5xx.
- Health
Check stringHttp Version - HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.
- Health
Check intInterval - Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.
- Health
Check stringMethod - Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)
- Health
Check intPort - Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
- Health
Check stringProtocol - Protocol for the health check. HTTP or TCP.
- Health
Check intTimeout - Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.
- Health
Check stringUri - 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 '/'.
- Healthy
Threshold int - Health threshold for the health check. Default is 3. Range: 2–10 times.
- Project
Name string - Project name to which the health check template belongs.
-
List<Volcengine.
Health Check Template Tag> - Unhealthy
Threshold int - Unhealthy threshold for health checks. Default is 3; range is 2–10 times.
- Health
Check stringTemplate Name - 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.
- Description string
- 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.
- Health
Check stringDomain - 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.
- Health
Check stringHttp Code - 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: http2xx (default), http3xx (default), http4xx, http5xx.
- Health
Check stringHttp Version - HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.
- Health
Check intInterval - Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.
- Health
Check stringMethod - Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)
- Health
Check intPort - Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
- Health
Check stringProtocol - Protocol for the health check. HTTP or TCP.
- Health
Check intTimeout - Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.
- Health
Check stringUri - 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 '/'.
- Healthy
Threshold int - Health threshold for the health check. Default is 3. Range: 2–10 times.
- Project
Name string - Project name to which the health check template belongs.
-
[]Health
Check Template Tag Args - Unhealthy
Threshold int - Unhealthy threshold for health checks. Default is 3; range is 2–10 times.
- health
Check StringTemplate Name - 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.
- description String
- 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.
- health
Check StringDomain - 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.
- health
Check StringHttp Code - 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: http2xx (default), http3xx (default), http4xx, http5xx.
- health
Check StringHttp Version - HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.
- health
Check IntegerInterval - Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.
- health
Check StringMethod - Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)
- health
Check IntegerPort - Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
- health
Check StringProtocol - Protocol for the health check. HTTP or TCP.
- health
Check IntegerTimeout - Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.
- health
Check StringUri - 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 '/'.
- healthy
Threshold Integer - Health threshold for the health check. Default is 3. Range: 2–10 times.
- project
Name String - Project name to which the health check template belongs.
-
List<Health
Check Template Tag> - unhealthy
Threshold Integer - Unhealthy threshold for health checks. Default is 3; range is 2–10 times.
- health
Check stringTemplate Name - 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.
- description string
- 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.
- health
Check stringDomain - 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.
- health
Check stringHttp Code - 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: http2xx (default), http3xx (default), http4xx, http5xx.
- health
Check stringHttp Version - HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.
- health
Check numberInterval - Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.
- health
Check stringMethod - Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)
- health
Check numberPort - Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
- health
Check stringProtocol - Protocol for the health check. HTTP or TCP.
- health
Check numberTimeout - Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.
- health
Check stringUri - 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 '/'.
- healthy
Threshold number - Health threshold for the health check. Default is 3. Range: 2–10 times.
- project
Name string - Project name to which the health check template belongs.
-
Health
Check Template Tag[] - unhealthy
Threshold number - Unhealthy threshold for health checks. Default is 3; range is 2–10 times.
- health_
check_ strtemplate_ name - 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.
- description str
- 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.
- health_
check_ strdomain - 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.
- health_
check_ strhttp_ code - 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: http2xx (default), http3xx (default), http4xx, http5xx.
- health_
check_ strhttp_ version - HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.
- health_
check_ intinterval - Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.
- health_
check_ strmethod - Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)
- health_
check_ intport - Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
- health_
check_ strprotocol - Protocol for the health check. HTTP or TCP.
- health_
check_ inttimeout - Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.
- health_
check_ struri - 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 '/'.
- healthy_
threshold int - Health threshold for the health check. Default is 3. Range: 2–10 times.
- project_
name str - Project name to which the health check template belongs.
-
Sequence[Health
Check Template Tag Args] - unhealthy_
threshold int - Unhealthy threshold for health checks. Default is 3; range is 2–10 times.
- health
Check StringTemplate Name - 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.
- description String
- 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.
- health
Check StringDomain - 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.
- health
Check StringHttp Code - 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: http2xx (default), http3xx (default), http4xx, http5xx.
- health
Check StringHttp Version - HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.
- health
Check NumberInterval - Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.
- health
Check StringMethod - Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)
- health
Check NumberPort - Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
- health
Check StringProtocol - Protocol for the health check. HTTP or TCP.
- health
Check NumberTimeout - Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.
- health
Check StringUri - 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 '/'.
- healthy
Threshold Number - Health threshold for the health check. Default is 3. Range: 2–10 times.
- project
Name String - Project name to which the health check template belongs.
- List<Property Map>
- unhealthy
Threshold Number - Unhealthy threshold for health checks. Default is 3; range is 2–10 times.
Outputs
All input properties are implicitly available as output properties. Additionally, the HealthCheckTemplate resource produces the following output properties:
- Create
Time string - Creation time of the health check template.
- Health
Check stringTemplate Id - Health check template ID.
- Id string
- The provider-assigned unique ID for this managed resource.
- Update
Time string - Last operation time of the health check template.
- Create
Time string - Creation time of the health check template.
- Health
Check stringTemplate Id - Health check template ID.
- Id string
- The provider-assigned unique ID for this managed resource.
- Update
Time string - Last operation time of the health check template.
- create
Time String - Creation time of the health check template.
- health
Check StringTemplate Id - Health check template ID.
- id String
- The provider-assigned unique ID for this managed resource.
- update
Time String - Last operation time of the health check template.
- create
Time string - Creation time of the health check template.
- health
Check stringTemplate Id - Health check template ID.
- id string
- The provider-assigned unique ID for this managed resource.
- update
Time string - Last operation time of the health check template.
- create_
time str - Creation time of the health check template.
- health_
check_ strtemplate_ id - Health check template ID.
- id str
- The provider-assigned unique ID for this managed resource.
- update_
time str - Last operation time of the health check template.
- create
Time String - Creation time of the health check template.
- health
Check StringTemplate Id - Health check template ID.
- id String
- The provider-assigned unique ID for this managed resource.
- update
Time String - Last operation time of the health check template.
Look up Existing HealthCheckTemplate Resource
Get an existing HealthCheckTemplate resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: HealthCheckTemplateState, opts?: CustomResourceOptions): HealthCheckTemplate@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
create_time: Optional[str] = None,
description: Optional[str] = None,
health_check_domain: Optional[str] = None,
health_check_http_code: Optional[str] = None,
health_check_http_version: Optional[str] = None,
health_check_interval: Optional[int] = None,
health_check_method: Optional[str] = None,
health_check_port: Optional[int] = None,
health_check_protocol: Optional[str] = None,
health_check_template_id: Optional[str] = None,
health_check_template_name: Optional[str] = None,
health_check_timeout: Optional[int] = None,
health_check_uri: Optional[str] = None,
healthy_threshold: Optional[int] = None,
project_name: Optional[str] = None,
tags: Optional[Sequence[HealthCheckTemplateTagArgs]] = None,
unhealthy_threshold: Optional[int] = None,
update_time: Optional[str] = None) -> HealthCheckTemplatefunc GetHealthCheckTemplate(ctx *Context, name string, id IDInput, state *HealthCheckTemplateState, opts ...ResourceOption) (*HealthCheckTemplate, error)public static HealthCheckTemplate Get(string name, Input<string> id, HealthCheckTemplateState? state, CustomResourceOptions? opts = null)public static HealthCheckTemplate get(String name, Output<String> id, HealthCheckTemplateState state, CustomResourceOptions options)resources: _: type: volcenginecc:alb:HealthCheckTemplate get: id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Create
Time string - Creation time of the health check template.
- Description string
- 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.
- Health
Check stringDomain - 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.
- Health
Check stringHttp Code - 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: http2xx (default), http3xx (default), http4xx, http5xx.
- Health
Check stringHttp Version - HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.
- Health
Check intInterval - Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.
- Health
Check stringMethod - Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)
- Health
Check intPort - Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
- Health
Check stringProtocol - Protocol for the health check. HTTP or TCP.
- Health
Check stringTemplate Id - Health check template ID.
- Health
Check stringTemplate Name - 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.
- Health
Check intTimeout - Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.
- Health
Check stringUri - 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 '/'.
- Healthy
Threshold int - Health threshold for the health check. Default is 3. Range: 2–10 times.
- Project
Name string - Project name to which the health check template belongs.
-
List<Volcengine.
Health Check Template Tag> - Unhealthy
Threshold int - Unhealthy threshold for health checks. Default is 3; range is 2–10 times.
- Update
Time string - Last operation time of the health check template.
- Create
Time string - Creation time of the health check template.
- Description string
- 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.
- Health
Check stringDomain - 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.
- Health
Check stringHttp Code - 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: http2xx (default), http3xx (default), http4xx, http5xx.
- Health
Check stringHttp Version - HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.
- Health
Check intInterval - Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.
- Health
Check stringMethod - Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)
- Health
Check intPort - Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
- Health
Check stringProtocol - Protocol for the health check. HTTP or TCP.
- Health
Check stringTemplate Id - Health check template ID.
- Health
Check stringTemplate Name - 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.
- Health
Check intTimeout - Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.
- Health
Check stringUri - 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 '/'.
- Healthy
Threshold int - Health threshold for the health check. Default is 3. Range: 2–10 times.
- Project
Name string - Project name to which the health check template belongs.
-
[]Health
Check Template Tag Args - Unhealthy
Threshold int - Unhealthy threshold for health checks. Default is 3; range is 2–10 times.
- Update
Time string - Last operation time of the health check template.
- create
Time String - Creation time of the health check template.
- description String
- 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.
- health
Check StringDomain - 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.
- health
Check StringHttp Code - 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: http2xx (default), http3xx (default), http4xx, http5xx.
- health
Check StringHttp Version - HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.
- health
Check IntegerInterval - Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.
- health
Check StringMethod - Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)
- health
Check IntegerPort - Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
- health
Check StringProtocol - Protocol for the health check. HTTP or TCP.
- health
Check StringTemplate Id - Health check template ID.
- health
Check StringTemplate Name - 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.
- health
Check IntegerTimeout - Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.
- health
Check StringUri - 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 '/'.
- healthy
Threshold Integer - Health threshold for the health check. Default is 3. Range: 2–10 times.
- project
Name String - Project name to which the health check template belongs.
-
List<Health
Check Template Tag> - unhealthy
Threshold Integer - Unhealthy threshold for health checks. Default is 3; range is 2–10 times.
- update
Time String - Last operation time of the health check template.
- create
Time string - Creation time of the health check template.
- description string
- 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.
- health
Check stringDomain - 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.
- health
Check stringHttp Code - 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: http2xx (default), http3xx (default), http4xx, http5xx.
- health
Check stringHttp Version - HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.
- health
Check numberInterval - Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.
- health
Check stringMethod - Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)
- health
Check numberPort - Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
- health
Check stringProtocol - Protocol for the health check. HTTP or TCP.
- health
Check stringTemplate Id - Health check template ID.
- health
Check stringTemplate Name - 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.
- health
Check numberTimeout - Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.
- health
Check stringUri - 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 '/'.
- healthy
Threshold number - Health threshold for the health check. Default is 3. Range: 2–10 times.
- project
Name string - Project name to which the health check template belongs.
-
Health
Check Template Tag[] - unhealthy
Threshold number - Unhealthy threshold for health checks. Default is 3; range is 2–10 times.
- update
Time string - Last operation time of the health check template.
- create_
time str - Creation time of the health check template.
- description str
- 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.
- health_
check_ strdomain - 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.
- health_
check_ strhttp_ code - 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: http2xx (default), http3xx (default), http4xx, http5xx.
- health_
check_ strhttp_ version - HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.
- health_
check_ intinterval - Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.
- health_
check_ strmethod - Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)
- health_
check_ intport - Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
- health_
check_ strprotocol - Protocol for the health check. HTTP or TCP.
- health_
check_ strtemplate_ id - Health check template ID.
- health_
check_ strtemplate_ name - 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.
- health_
check_ inttimeout - Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.
- health_
check_ struri - 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 '/'.
- healthy_
threshold int - Health threshold for the health check. Default is 3. Range: 2–10 times.
- project_
name str - Project name to which the health check template belongs.
-
Sequence[Health
Check Template Tag Args] - unhealthy_
threshold int - Unhealthy threshold for health checks. Default is 3; range is 2–10 times.
- update_
time str - Last operation time of the health check template.
- create
Time String - Creation time of the health check template.
- description String
- 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.
- health
Check StringDomain - 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.
- health
Check StringHttp Code - 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: http2xx (default), http3xx (default), http4xx, http5xx.
- health
Check StringHttp Version - HTTP protocol version for health checks. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: HTTP1.0 (default), HTTP1.1.
- health
Check NumberInterval - Interval for performing health checks. Default is 2 seconds. Range: 1–300 seconds.
- health
Check StringMethod - Health check method. This parameter is effective only when HealthCheckProtocol is set to HTTP. Options: GETHEAD (default method)
- health
Check NumberPort - Port for the health check. Options: 0: Use the backend server port for health checks. 1–65535: Use the specified port for health checks.
- health
Check StringProtocol - Protocol for the health check. HTTP or TCP.
- health
Check StringTemplate Id - Health check template ID.
- health
Check StringTemplate Name - 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.
- health
Check NumberTimeout - Response timeout for the health check. Default is 2 seconds. Range: 1–60 seconds.
- health
Check StringUri - 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 '/'.
- healthy
Threshold Number - Health threshold for the health check. Default is 3. Range: 2–10 times.
- project
Name String - Project name to which the health check template belongs.
- List<Property Map>
- unhealthy
Threshold Number - Unhealthy threshold for health checks. Default is 3; range is 2–10 times.
- update
Time String - Last operation time of the health check template.
Supporting Types
HealthCheckTemplateTag, HealthCheckTemplateTagArgs
- Key string
- Tag key for user tags. Rules: Length must be 1–128 characters. Case-sensitive. Cannot start with any case combination of sys:. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Tag keys for the same resource must be unique.
- Value string
- Tag value for the user tag. If you specify this parameter, you must first specify Tags.N.Key. Rules: Length must be between 0 and 256 characters. Case-sensitive. Cannot start or end with a space. Supports characters from all languages, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.
- Key string
- Tag key for user tags. Rules: Length must be 1–128 characters. Case-sensitive. Cannot start with any case combination of sys:. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Tag keys for the same resource must be unique.
- Value string
- Tag value for the user tag. If you specify this parameter, you must first specify Tags.N.Key. Rules: Length must be between 0 and 256 characters. Case-sensitive. Cannot start or end with a space. Supports characters from all languages, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.
- key String
- Tag key for user tags. Rules: Length must be 1–128 characters. Case-sensitive. Cannot start with any case combination of sys:. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Tag keys for the same resource must be unique.
- value String
- Tag value for the user tag. If you specify this parameter, you must first specify Tags.N.Key. Rules: Length must be between 0 and 256 characters. Case-sensitive. Cannot start or end with a space. Supports characters from all languages, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.
- key string
- Tag key for user tags. Rules: Length must be 1–128 characters. Case-sensitive. Cannot start with any case combination of sys:. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Tag keys for the same resource must be unique.
- value string
- Tag value for the user tag. If you specify this parameter, you must first specify Tags.N.Key. Rules: Length must be between 0 and 256 characters. Case-sensitive. Cannot start or end with a space. Supports characters from all languages, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.
- key str
- Tag key for user tags. Rules: Length must be 1–128 characters. Case-sensitive. Cannot start with any case combination of sys:. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Tag keys for the same resource must be unique.
- value str
- Tag value for the user tag. If you specify this parameter, you must first specify Tags.N.Key. Rules: Length must be between 0 and 256 characters. Case-sensitive. Cannot start or end with a space. Supports characters from all languages, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.
- key String
- Tag key for user tags. Rules: Length must be 1–128 characters. Case-sensitive. Cannot start with any case combination of sys:. Cannot start or end with a space. May include characters from any language, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), hyphens (-), and @. Tag keys for the same resource must be unique.
- value String
- Tag value for the user tag. If you specify this parameter, you must first specify Tags.N.Key. Rules: Length must be between 0 and 256 characters. Case-sensitive. Cannot start or end with a space. Supports characters from all languages, numbers, spaces, underscores (_), periods (.), colons (:), slashes (/), equals signs (=), plus signs (+), minus signs (-), and @.
Import
$ pulumi import volcenginecc:alb/healthCheckTemplate:HealthCheckTemplate example "health_check_template_id"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- volcenginecc volcengine/pulumi-volcenginecc
- License
- MPL-2.0
- Notes
- This Pulumi package is based on the
volcengineccTerraform Provider.
published on Thursday, Apr 23, 2026 by Volcengine
