1. Packages
  2. Alibaba Cloud Provider
  3. API Docs
  4. alb
  5. HealthCheckTemplate
Alibaba Cloud v3.75.0 published on Friday, Mar 7, 2025 by Pulumi

alicloud.alb.HealthCheckTemplate

Explore with Pulumi AI

Provides an Application Load Balancer (ALB) Health Check Template resource.

For information about Application Load Balancer (ALB) Health Check Template and how to use it, see What is Health Check Template.

NOTE: Available since v1.134.0.

Example Usage

Basic Usage

import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const config = new pulumi.Config();
const name = config.get("name") || "terraform-example";
const example = new alicloud.alb.HealthCheckTemplate("example", {healthCheckTemplateName: name});
Copy
import pulumi
import pulumi_alicloud as alicloud

config = pulumi.Config()
name = config.get("name")
if name is None:
    name = "terraform-example"
example = alicloud.alb.HealthCheckTemplate("example", health_check_template_name=name)
Copy
package main

import (
	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/alb"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		name := "terraform-example"
		if param := cfg.Get("name"); param != "" {
			name = param
		}
		_, err := alb.NewHealthCheckTemplate(ctx, "example", &alb.HealthCheckTemplateArgs{
			HealthCheckTemplateName: pulumi.String(name),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var name = config.Get("name") ?? "terraform-example";
    var example = new AliCloud.Alb.HealthCheckTemplate("example", new()
    {
        HealthCheckTemplateName = name,
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.alb.HealthCheckTemplate;
import com.pulumi.alicloud.alb.HealthCheckTemplateArgs;
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) {
        final var config = ctx.config();
        final var name = config.get("name").orElse("terraform-example");
        var example = new HealthCheckTemplate("example", HealthCheckTemplateArgs.builder()
            .healthCheckTemplateName(name)
            .build());

    }
}
Copy
configuration:
  name:
    type: string
    default: terraform-example
resources:
  example:
    type: alicloud:alb:HealthCheckTemplate
    properties:
      healthCheckTemplateName: ${name}
Copy

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_host: Optional[str] = None,
                        health_check_connect_port: Optional[int] = None,
                        dry_run: Optional[bool] = None,
                        health_check_http_version: Optional[str] = None,
                        health_check_interval: Optional[int] = None,
                        health_check_method: Optional[str] = None,
                        health_check_path: Optional[str] = None,
                        health_check_protocol: Optional[str] = None,
                        health_check_codes: Optional[Sequence[str]] = None,
                        health_check_timeout: Optional[int] = None,
                        healthy_threshold: Optional[int] = 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: alicloud:alb:HealthCheckTemplate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. HealthCheckTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. HealthCheckTemplateArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. HealthCheckTemplateArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. HealthCheckTemplateArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var healthCheckTemplateResource = new AliCloud.Alb.HealthCheckTemplate("healthCheckTemplateResource", new()
{
    HealthCheckTemplateName = "string",
    HealthCheckHost = "string",
    HealthCheckConnectPort = 0,
    DryRun = false,
    HealthCheckHttpVersion = "string",
    HealthCheckInterval = 0,
    HealthCheckMethod = "string",
    HealthCheckPath = "string",
    HealthCheckProtocol = "string",
    HealthCheckCodes = new[]
    {
        "string",
    },
    HealthCheckTimeout = 0,
    HealthyThreshold = 0,
    UnhealthyThreshold = 0,
});
Copy
example, err := alb.NewHealthCheckTemplate(ctx, "healthCheckTemplateResource", &alb.HealthCheckTemplateArgs{
	HealthCheckTemplateName: pulumi.String("string"),
	HealthCheckHost:         pulumi.String("string"),
	HealthCheckConnectPort:  pulumi.Int(0),
	DryRun:                  pulumi.Bool(false),
	HealthCheckHttpVersion:  pulumi.String("string"),
	HealthCheckInterval:     pulumi.Int(0),
	HealthCheckMethod:       pulumi.String("string"),
	HealthCheckPath:         pulumi.String("string"),
	HealthCheckProtocol:     pulumi.String("string"),
	HealthCheckCodes: pulumi.StringArray{
		pulumi.String("string"),
	},
	HealthCheckTimeout: pulumi.Int(0),
	HealthyThreshold:   pulumi.Int(0),
	UnhealthyThreshold: pulumi.Int(0),
})
Copy
var healthCheckTemplateResource = new HealthCheckTemplate("healthCheckTemplateResource", HealthCheckTemplateArgs.builder()
    .healthCheckTemplateName("string")
    .healthCheckHost("string")
    .healthCheckConnectPort(0)
    .dryRun(false)
    .healthCheckHttpVersion("string")
    .healthCheckInterval(0)
    .healthCheckMethod("string")
    .healthCheckPath("string")
    .healthCheckProtocol("string")
    .healthCheckCodes("string")
    .healthCheckTimeout(0)
    .healthyThreshold(0)
    .unhealthyThreshold(0)
    .build());
Copy
health_check_template_resource = alicloud.alb.HealthCheckTemplate("healthCheckTemplateResource",
    health_check_template_name="string",
    health_check_host="string",
    health_check_connect_port=0,
    dry_run=False,
    health_check_http_version="string",
    health_check_interval=0,
    health_check_method="string",
    health_check_path="string",
    health_check_protocol="string",
    health_check_codes=["string"],
    health_check_timeout=0,
    healthy_threshold=0,
    unhealthy_threshold=0)
Copy
const healthCheckTemplateResource = new alicloud.alb.HealthCheckTemplate("healthCheckTemplateResource", {
    healthCheckTemplateName: "string",
    healthCheckHost: "string",
    healthCheckConnectPort: 0,
    dryRun: false,
    healthCheckHttpVersion: "string",
    healthCheckInterval: 0,
    healthCheckMethod: "string",
    healthCheckPath: "string",
    healthCheckProtocol: "string",
    healthCheckCodes: ["string"],
    healthCheckTimeout: 0,
    healthyThreshold: 0,
    unhealthyThreshold: 0,
});
Copy
type: alicloud:alb:HealthCheckTemplate
properties:
    dryRun: false
    healthCheckCodes:
        - string
    healthCheckConnectPort: 0
    healthCheckHost: string
    healthCheckHttpVersion: string
    healthCheckInterval: 0
    healthCheckMethod: string
    healthCheckPath: string
    healthCheckProtocol: string
    healthCheckTemplateName: string
    healthCheckTimeout: 0
    healthyThreshold: 0
    unhealthyThreshold: 0
Copy

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:

HealthCheckTemplateName This property is required. string
The name of the health check template. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
DryRun bool
Whether to precheck the API request.
HealthCheckCodes List<string>
The HTTP status codes that are used to indicate whether the backend server passes the health check. Default value: http_2xx. Valid values: http_2xx, http_3xx, http_4xx, and http_5xx. NOTE: health_check_codes takes effect only if health_check_protocol is set to HTTP.
HealthCheckConnectPort int
The port that is used for health checks. Default value: 0. Valid values: 0 to 65535.
HealthCheckHost string
The domain name that is used for health checks. NOTE: health_check_host takes effect only if health_check_protocol is set to HTTP.
HealthCheckHttpVersion string
The version of the HTTP protocol. Default value: HTTP1.1. Valid values: HTTP1.0, HTTP1.1. NOTE: health_check_http_version takes effect only if health_check_protocol is set to HTTP.
HealthCheckInterval int
The interval at which health checks are performed. Unit: seconds. Default value: 2. Valid values: 1 to 50.
HealthCheckMethod string
The HTTP method that is used for health checks. Default value: HEAD. Valid values: HEAD, GET. NOTE: health_check_method takes effect only if health_check_protocol is set to HTTP.
HealthCheckPath string
The URL that is used for health checks. NOTE: health_check_path takes effect only if health_check_protocol is set to HTTP.
HealthCheckProtocol string
The protocol that is used for health checks. Default value: HTTP. Valid values: HTTP, TCP.
HealthCheckTimeout int
The timeout period of a health check. Default value: 5. Valid values: 1 to 300.
HealthyThreshold int
The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. Default value: 3. Valid values: 2 to 10.
UnhealthyThreshold int
The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. Default value: 3. Valid values: 2 to 10.
HealthCheckTemplateName This property is required. string
The name of the health check template. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
DryRun bool
Whether to precheck the API request.
HealthCheckCodes []string
The HTTP status codes that are used to indicate whether the backend server passes the health check. Default value: http_2xx. Valid values: http_2xx, http_3xx, http_4xx, and http_5xx. NOTE: health_check_codes takes effect only if health_check_protocol is set to HTTP.
HealthCheckConnectPort int
The port that is used for health checks. Default value: 0. Valid values: 0 to 65535.
HealthCheckHost string
The domain name that is used for health checks. NOTE: health_check_host takes effect only if health_check_protocol is set to HTTP.
HealthCheckHttpVersion string
The version of the HTTP protocol. Default value: HTTP1.1. Valid values: HTTP1.0, HTTP1.1. NOTE: health_check_http_version takes effect only if health_check_protocol is set to HTTP.
HealthCheckInterval int
The interval at which health checks are performed. Unit: seconds. Default value: 2. Valid values: 1 to 50.
HealthCheckMethod string
The HTTP method that is used for health checks. Default value: HEAD. Valid values: HEAD, GET. NOTE: health_check_method takes effect only if health_check_protocol is set to HTTP.
HealthCheckPath string
The URL that is used for health checks. NOTE: health_check_path takes effect only if health_check_protocol is set to HTTP.
HealthCheckProtocol string
The protocol that is used for health checks. Default value: HTTP. Valid values: HTTP, TCP.
HealthCheckTimeout int
The timeout period of a health check. Default value: 5. Valid values: 1 to 300.
HealthyThreshold int
The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. Default value: 3. Valid values: 2 to 10.
UnhealthyThreshold int
The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. Default value: 3. Valid values: 2 to 10.
healthCheckTemplateName This property is required. String
The name of the health check template. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
dryRun Boolean
Whether to precheck the API request.
healthCheckCodes List<String>
The HTTP status codes that are used to indicate whether the backend server passes the health check. Default value: http_2xx. Valid values: http_2xx, http_3xx, http_4xx, and http_5xx. NOTE: health_check_codes takes effect only if health_check_protocol is set to HTTP.
healthCheckConnectPort Integer
The port that is used for health checks. Default value: 0. Valid values: 0 to 65535.
healthCheckHost String
The domain name that is used for health checks. NOTE: health_check_host takes effect only if health_check_protocol is set to HTTP.
healthCheckHttpVersion String
The version of the HTTP protocol. Default value: HTTP1.1. Valid values: HTTP1.0, HTTP1.1. NOTE: health_check_http_version takes effect only if health_check_protocol is set to HTTP.
healthCheckInterval Integer
The interval at which health checks are performed. Unit: seconds. Default value: 2. Valid values: 1 to 50.
healthCheckMethod String
The HTTP method that is used for health checks. Default value: HEAD. Valid values: HEAD, GET. NOTE: health_check_method takes effect only if health_check_protocol is set to HTTP.
healthCheckPath String
The URL that is used for health checks. NOTE: health_check_path takes effect only if health_check_protocol is set to HTTP.
healthCheckProtocol String
The protocol that is used for health checks. Default value: HTTP. Valid values: HTTP, TCP.
healthCheckTimeout Integer
The timeout period of a health check. Default value: 5. Valid values: 1 to 300.
healthyThreshold Integer
The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. Default value: 3. Valid values: 2 to 10.
unhealthyThreshold Integer
The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. Default value: 3. Valid values: 2 to 10.
healthCheckTemplateName This property is required. string
The name of the health check template. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
dryRun boolean
Whether to precheck the API request.
healthCheckCodes string[]
The HTTP status codes that are used to indicate whether the backend server passes the health check. Default value: http_2xx. Valid values: http_2xx, http_3xx, http_4xx, and http_5xx. NOTE: health_check_codes takes effect only if health_check_protocol is set to HTTP.
healthCheckConnectPort number
The port that is used for health checks. Default value: 0. Valid values: 0 to 65535.
healthCheckHost string
The domain name that is used for health checks. NOTE: health_check_host takes effect only if health_check_protocol is set to HTTP.
healthCheckHttpVersion string
The version of the HTTP protocol. Default value: HTTP1.1. Valid values: HTTP1.0, HTTP1.1. NOTE: health_check_http_version takes effect only if health_check_protocol is set to HTTP.
healthCheckInterval number
The interval at which health checks are performed. Unit: seconds. Default value: 2. Valid values: 1 to 50.
healthCheckMethod string
The HTTP method that is used for health checks. Default value: HEAD. Valid values: HEAD, GET. NOTE: health_check_method takes effect only if health_check_protocol is set to HTTP.
healthCheckPath string
The URL that is used for health checks. NOTE: health_check_path takes effect only if health_check_protocol is set to HTTP.
healthCheckProtocol string
The protocol that is used for health checks. Default value: HTTP. Valid values: HTTP, TCP.
healthCheckTimeout number
The timeout period of a health check. Default value: 5. Valid values: 1 to 300.
healthyThreshold number
The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. Default value: 3. Valid values: 2 to 10.
unhealthyThreshold number
The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. Default value: 3. Valid values: 2 to 10.
health_check_template_name This property is required. str
The name of the health check template. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
dry_run bool
Whether to precheck the API request.
health_check_codes Sequence[str]
The HTTP status codes that are used to indicate whether the backend server passes the health check. Default value: http_2xx. Valid values: http_2xx, http_3xx, http_4xx, and http_5xx. NOTE: health_check_codes takes effect only if health_check_protocol is set to HTTP.
health_check_connect_port int
The port that is used for health checks. Default value: 0. Valid values: 0 to 65535.
health_check_host str
The domain name that is used for health checks. NOTE: health_check_host takes effect only if health_check_protocol is set to HTTP.
health_check_http_version str
The version of the HTTP protocol. Default value: HTTP1.1. Valid values: HTTP1.0, HTTP1.1. NOTE: health_check_http_version takes effect only if health_check_protocol is set to HTTP.
health_check_interval int
The interval at which health checks are performed. Unit: seconds. Default value: 2. Valid values: 1 to 50.
health_check_method str
The HTTP method that is used for health checks. Default value: HEAD. Valid values: HEAD, GET. NOTE: health_check_method takes effect only if health_check_protocol is set to HTTP.
health_check_path str
The URL that is used for health checks. NOTE: health_check_path takes effect only if health_check_protocol is set to HTTP.
health_check_protocol str
The protocol that is used for health checks. Default value: HTTP. Valid values: HTTP, TCP.
health_check_timeout int
The timeout period of a health check. Default value: 5. Valid values: 1 to 300.
healthy_threshold int
The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. Default value: 3. Valid values: 2 to 10.
unhealthy_threshold int
The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. Default value: 3. Valid values: 2 to 10.
healthCheckTemplateName This property is required. String
The name of the health check template. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
dryRun Boolean
Whether to precheck the API request.
healthCheckCodes List<String>
The HTTP status codes that are used to indicate whether the backend server passes the health check. Default value: http_2xx. Valid values: http_2xx, http_3xx, http_4xx, and http_5xx. NOTE: health_check_codes takes effect only if health_check_protocol is set to HTTP.
healthCheckConnectPort Number
The port that is used for health checks. Default value: 0. Valid values: 0 to 65535.
healthCheckHost String
The domain name that is used for health checks. NOTE: health_check_host takes effect only if health_check_protocol is set to HTTP.
healthCheckHttpVersion String
The version of the HTTP protocol. Default value: HTTP1.1. Valid values: HTTP1.0, HTTP1.1. NOTE: health_check_http_version takes effect only if health_check_protocol is set to HTTP.
healthCheckInterval Number
The interval at which health checks are performed. Unit: seconds. Default value: 2. Valid values: 1 to 50.
healthCheckMethod String
The HTTP method that is used for health checks. Default value: HEAD. Valid values: HEAD, GET. NOTE: health_check_method takes effect only if health_check_protocol is set to HTTP.
healthCheckPath String
The URL that is used for health checks. NOTE: health_check_path takes effect only if health_check_protocol is set to HTTP.
healthCheckProtocol String
The protocol that is used for health checks. Default value: HTTP. Valid values: HTTP, TCP.
healthCheckTimeout Number
The timeout period of a health check. Default value: 5. Valid values: 1 to 300.
healthyThreshold Number
The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. Default value: 3. Valid values: 2 to 10.
unhealthyThreshold Number
The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. Default value: 3. Valid values: 2 to 10.

Outputs

All input properties are implicitly available as output properties. Additionally, the HealthCheckTemplate resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

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,
        dry_run: Optional[bool] = None,
        health_check_codes: Optional[Sequence[str]] = None,
        health_check_connect_port: Optional[int] = None,
        health_check_host: Optional[str] = None,
        health_check_http_version: Optional[str] = None,
        health_check_interval: Optional[int] = None,
        health_check_method: Optional[str] = None,
        health_check_path: Optional[str] = None,
        health_check_protocol: Optional[str] = None,
        health_check_template_name: Optional[str] = None,
        health_check_timeout: Optional[int] = None,
        healthy_threshold: Optional[int] = None,
        unhealthy_threshold: Optional[int] = None) -> HealthCheckTemplate
func 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: alicloud:alb:HealthCheckTemplate    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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.
The following state arguments are supported:
DryRun bool
Whether to precheck the API request.
HealthCheckCodes List<string>
The HTTP status codes that are used to indicate whether the backend server passes the health check. Default value: http_2xx. Valid values: http_2xx, http_3xx, http_4xx, and http_5xx. NOTE: health_check_codes takes effect only if health_check_protocol is set to HTTP.
HealthCheckConnectPort int
The port that is used for health checks. Default value: 0. Valid values: 0 to 65535.
HealthCheckHost string
The domain name that is used for health checks. NOTE: health_check_host takes effect only if health_check_protocol is set to HTTP.
HealthCheckHttpVersion string
The version of the HTTP protocol. Default value: HTTP1.1. Valid values: HTTP1.0, HTTP1.1. NOTE: health_check_http_version takes effect only if health_check_protocol is set to HTTP.
HealthCheckInterval int
The interval at which health checks are performed. Unit: seconds. Default value: 2. Valid values: 1 to 50.
HealthCheckMethod string
The HTTP method that is used for health checks. Default value: HEAD. Valid values: HEAD, GET. NOTE: health_check_method takes effect only if health_check_protocol is set to HTTP.
HealthCheckPath string
The URL that is used for health checks. NOTE: health_check_path takes effect only if health_check_protocol is set to HTTP.
HealthCheckProtocol string
The protocol that is used for health checks. Default value: HTTP. Valid values: HTTP, TCP.
HealthCheckTemplateName string
The name of the health check template. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
HealthCheckTimeout int
The timeout period of a health check. Default value: 5. Valid values: 1 to 300.
HealthyThreshold int
The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. Default value: 3. Valid values: 2 to 10.
UnhealthyThreshold int
The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. Default value: 3. Valid values: 2 to 10.
DryRun bool
Whether to precheck the API request.
HealthCheckCodes []string
The HTTP status codes that are used to indicate whether the backend server passes the health check. Default value: http_2xx. Valid values: http_2xx, http_3xx, http_4xx, and http_5xx. NOTE: health_check_codes takes effect only if health_check_protocol is set to HTTP.
HealthCheckConnectPort int
The port that is used for health checks. Default value: 0. Valid values: 0 to 65535.
HealthCheckHost string
The domain name that is used for health checks. NOTE: health_check_host takes effect only if health_check_protocol is set to HTTP.
HealthCheckHttpVersion string
The version of the HTTP protocol. Default value: HTTP1.1. Valid values: HTTP1.0, HTTP1.1. NOTE: health_check_http_version takes effect only if health_check_protocol is set to HTTP.
HealthCheckInterval int
The interval at which health checks are performed. Unit: seconds. Default value: 2. Valid values: 1 to 50.
HealthCheckMethod string
The HTTP method that is used for health checks. Default value: HEAD. Valid values: HEAD, GET. NOTE: health_check_method takes effect only if health_check_protocol is set to HTTP.
HealthCheckPath string
The URL that is used for health checks. NOTE: health_check_path takes effect only if health_check_protocol is set to HTTP.
HealthCheckProtocol string
The protocol that is used for health checks. Default value: HTTP. Valid values: HTTP, TCP.
HealthCheckTemplateName string
The name of the health check template. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
HealthCheckTimeout int
The timeout period of a health check. Default value: 5. Valid values: 1 to 300.
HealthyThreshold int
The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. Default value: 3. Valid values: 2 to 10.
UnhealthyThreshold int
The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. Default value: 3. Valid values: 2 to 10.
dryRun Boolean
Whether to precheck the API request.
healthCheckCodes List<String>
The HTTP status codes that are used to indicate whether the backend server passes the health check. Default value: http_2xx. Valid values: http_2xx, http_3xx, http_4xx, and http_5xx. NOTE: health_check_codes takes effect only if health_check_protocol is set to HTTP.
healthCheckConnectPort Integer
The port that is used for health checks. Default value: 0. Valid values: 0 to 65535.
healthCheckHost String
The domain name that is used for health checks. NOTE: health_check_host takes effect only if health_check_protocol is set to HTTP.
healthCheckHttpVersion String
The version of the HTTP protocol. Default value: HTTP1.1. Valid values: HTTP1.0, HTTP1.1. NOTE: health_check_http_version takes effect only if health_check_protocol is set to HTTP.
healthCheckInterval Integer
The interval at which health checks are performed. Unit: seconds. Default value: 2. Valid values: 1 to 50.
healthCheckMethod String
The HTTP method that is used for health checks. Default value: HEAD. Valid values: HEAD, GET. NOTE: health_check_method takes effect only if health_check_protocol is set to HTTP.
healthCheckPath String
The URL that is used for health checks. NOTE: health_check_path takes effect only if health_check_protocol is set to HTTP.
healthCheckProtocol String
The protocol that is used for health checks. Default value: HTTP. Valid values: HTTP, TCP.
healthCheckTemplateName String
The name of the health check template. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
healthCheckTimeout Integer
The timeout period of a health check. Default value: 5. Valid values: 1 to 300.
healthyThreshold Integer
The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. Default value: 3. Valid values: 2 to 10.
unhealthyThreshold Integer
The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. Default value: 3. Valid values: 2 to 10.
dryRun boolean
Whether to precheck the API request.
healthCheckCodes string[]
The HTTP status codes that are used to indicate whether the backend server passes the health check. Default value: http_2xx. Valid values: http_2xx, http_3xx, http_4xx, and http_5xx. NOTE: health_check_codes takes effect only if health_check_protocol is set to HTTP.
healthCheckConnectPort number
The port that is used for health checks. Default value: 0. Valid values: 0 to 65535.
healthCheckHost string
The domain name that is used for health checks. NOTE: health_check_host takes effect only if health_check_protocol is set to HTTP.
healthCheckHttpVersion string
The version of the HTTP protocol. Default value: HTTP1.1. Valid values: HTTP1.0, HTTP1.1. NOTE: health_check_http_version takes effect only if health_check_protocol is set to HTTP.
healthCheckInterval number
The interval at which health checks are performed. Unit: seconds. Default value: 2. Valid values: 1 to 50.
healthCheckMethod string
The HTTP method that is used for health checks. Default value: HEAD. Valid values: HEAD, GET. NOTE: health_check_method takes effect only if health_check_protocol is set to HTTP.
healthCheckPath string
The URL that is used for health checks. NOTE: health_check_path takes effect only if health_check_protocol is set to HTTP.
healthCheckProtocol string
The protocol that is used for health checks. Default value: HTTP. Valid values: HTTP, TCP.
healthCheckTemplateName string
The name of the health check template. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
healthCheckTimeout number
The timeout period of a health check. Default value: 5. Valid values: 1 to 300.
healthyThreshold number
The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. Default value: 3. Valid values: 2 to 10.
unhealthyThreshold number
The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. Default value: 3. Valid values: 2 to 10.
dry_run bool
Whether to precheck the API request.
health_check_codes Sequence[str]
The HTTP status codes that are used to indicate whether the backend server passes the health check. Default value: http_2xx. Valid values: http_2xx, http_3xx, http_4xx, and http_5xx. NOTE: health_check_codes takes effect only if health_check_protocol is set to HTTP.
health_check_connect_port int
The port that is used for health checks. Default value: 0. Valid values: 0 to 65535.
health_check_host str
The domain name that is used for health checks. NOTE: health_check_host takes effect only if health_check_protocol is set to HTTP.
health_check_http_version str
The version of the HTTP protocol. Default value: HTTP1.1. Valid values: HTTP1.0, HTTP1.1. NOTE: health_check_http_version takes effect only if health_check_protocol is set to HTTP.
health_check_interval int
The interval at which health checks are performed. Unit: seconds. Default value: 2. Valid values: 1 to 50.
health_check_method str
The HTTP method that is used for health checks. Default value: HEAD. Valid values: HEAD, GET. NOTE: health_check_method takes effect only if health_check_protocol is set to HTTP.
health_check_path str
The URL that is used for health checks. NOTE: health_check_path takes effect only if health_check_protocol is set to HTTP.
health_check_protocol str
The protocol that is used for health checks. Default value: HTTP. Valid values: HTTP, TCP.
health_check_template_name str
The name of the health check template. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
health_check_timeout int
The timeout period of a health check. Default value: 5. Valid values: 1 to 300.
healthy_threshold int
The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. Default value: 3. Valid values: 2 to 10.
unhealthy_threshold int
The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. Default value: 3. Valid values: 2 to 10.
dryRun Boolean
Whether to precheck the API request.
healthCheckCodes List<String>
The HTTP status codes that are used to indicate whether the backend server passes the health check. Default value: http_2xx. Valid values: http_2xx, http_3xx, http_4xx, and http_5xx. NOTE: health_check_codes takes effect only if health_check_protocol is set to HTTP.
healthCheckConnectPort Number
The port that is used for health checks. Default value: 0. Valid values: 0 to 65535.
healthCheckHost String
The domain name that is used for health checks. NOTE: health_check_host takes effect only if health_check_protocol is set to HTTP.
healthCheckHttpVersion String
The version of the HTTP protocol. Default value: HTTP1.1. Valid values: HTTP1.0, HTTP1.1. NOTE: health_check_http_version takes effect only if health_check_protocol is set to HTTP.
healthCheckInterval Number
The interval at which health checks are performed. Unit: seconds. Default value: 2. Valid values: 1 to 50.
healthCheckMethod String
The HTTP method that is used for health checks. Default value: HEAD. Valid values: HEAD, GET. NOTE: health_check_method takes effect only if health_check_protocol is set to HTTP.
healthCheckPath String
The URL that is used for health checks. NOTE: health_check_path takes effect only if health_check_protocol is set to HTTP.
healthCheckProtocol String
The protocol that is used for health checks. Default value: HTTP. Valid values: HTTP, TCP.
healthCheckTemplateName String
The name of the health check template. The name must be 2 to 128 characters in length, and can contain letters, digits, periods (.), underscores (_), and hyphens (-). The name must start with a letter.
healthCheckTimeout Number
The timeout period of a health check. Default value: 5. Valid values: 1 to 300.
healthyThreshold Number
The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. Default value: 3. Valid values: 2 to 10.
unhealthyThreshold Number
The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. Default value: 3. Valid values: 2 to 10.

Import

Application Load Balancer (ALB) Health Check Template can be imported using the id, e.g.

$ pulumi import alicloud:alb/healthCheckTemplate:HealthCheckTemplate example <id>
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes
This Pulumi package is based on the alicloud Terraform Provider.