alicloud logo
Alibaba Cloud v3.34.0, Mar 17 23

alicloud.alb.HealthCheckTemplate

Provides a 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 in v1.134.0+.

Example Usage

Basic Usage

using System.Collections.Generic;
using Pulumi;
using AliCloud = Pulumi.AliCloud;

return await Deployment.RunAsync(() => 
{
    var example = new AliCloud.Alb.HealthCheckTemplate("example", new()
    {
        HealthCheckTemplateName = "example_name",
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := alb.NewHealthCheckTemplate(ctx, "example", &alb.HealthCheckTemplateArgs{
			HealthCheckTemplateName: pulumi.String("example_name"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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) {
        var example = new HealthCheckTemplate("example", HealthCheckTemplateArgs.builder()        
            .healthCheckTemplateName("example_name")
            .build());

    }
}
import pulumi
import pulumi_alicloud as alicloud

example = alicloud.alb.HealthCheckTemplate("example", health_check_template_name="example_name")
import * as pulumi from "@pulumi/pulumi";
import * as alicloud from "@pulumi/alicloud";

const example = new alicloud.alb.HealthCheckTemplate("example", {healthCheckTemplateName: "example_name"});
resources:
  example:
    type: alicloud:alb:HealthCheckTemplate
    properties:
      healthCheckTemplateName: example_name

Create HealthCheckTemplate Resource

new HealthCheckTemplate(name: string, args: HealthCheckTemplateArgs, opts?: CustomResourceOptions);
@overload
def HealthCheckTemplate(resource_name: 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)
@overload
def HealthCheckTemplate(resource_name: str,
                        args: HealthCheckTemplateArgs,
                        opts: Optional[ResourceOptions] = 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.

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

The HealthCheckTemplate resource accepts the following input properties:

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.

DryRun bool

Whether to precheck the API request.

HealthCheckCodes List<string>

The HTTP status code that indicates a successful health check. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckConnectPort int

The number of the port that is used for health checks. Valid values: 0 to 65535. Default value: 0. This default value indicates that the backend server is used for health checks.

HealthCheckHost string

The domain name that is used for health checks. Default value: $SERVER_IP. The domain name must be 1 to 80 characters in length. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckHttpVersion string

The version of the HTTP protocol. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckInterval int

The time interval between two consecutive health checks. Valid values: 1 to 50. Unit: seconds. Default value: 2.

HealthCheckMethod string

The health check method. Valid values: GET and HEAD. Default value: HEAD. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckPath string

The URL that is used for health checks. The URL must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL can also contain the following extended characters: _ ; ~ ! ( )* [ ] @ $ ^ : ' , +. The URL must start with a forward slash (/). **NOTE:** The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckProtocol string

The protocol that is used for health checks. Valid values: HTTP and TCP. Default value: HTTP.

HealthCheckTimeout int

The timeout period of a health check response. If the backend Elastic Compute Service (ECS) instance does not send an expected response within the specified period of time, the health check fails. Valid values: 1 to 300. Unit: seconds. Default value: 5.

HealthyThreshold int

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy (from fail to success). Valid values: 2 to 10. Default value: 3. Unit: seconds.

UnhealthyThreshold int

The number of times that an healthy backend server must consecutively fail health checks before it is declared unhealthy (from success to fail). Valid values: 2 to 10. Default value: 3. Unit: seconds.

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.

DryRun bool

Whether to precheck the API request.

HealthCheckCodes []string

The HTTP status code that indicates a successful health check. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckConnectPort int

The number of the port that is used for health checks. Valid values: 0 to 65535. Default value: 0. This default value indicates that the backend server is used for health checks.

HealthCheckHost string

The domain name that is used for health checks. Default value: $SERVER_IP. The domain name must be 1 to 80 characters in length. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckHttpVersion string

The version of the HTTP protocol. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckInterval int

The time interval between two consecutive health checks. Valid values: 1 to 50. Unit: seconds. Default value: 2.

HealthCheckMethod string

The health check method. Valid values: GET and HEAD. Default value: HEAD. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckPath string

The URL that is used for health checks. The URL must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL can also contain the following extended characters: _ ; ~ ! ( )* [ ] @ $ ^ : ' , +. The URL must start with a forward slash (/). **NOTE:** The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckProtocol string

The protocol that is used for health checks. Valid values: HTTP and TCP. Default value: HTTP.

HealthCheckTimeout int

The timeout period of a health check response. If the backend Elastic Compute Service (ECS) instance does not send an expected response within the specified period of time, the health check fails. Valid values: 1 to 300. Unit: seconds. Default value: 5.

HealthyThreshold int

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy (from fail to success). Valid values: 2 to 10. Default value: 3. Unit: seconds.

UnhealthyThreshold int

The number of times that an healthy backend server must consecutively fail health checks before it is declared unhealthy (from success to fail). Valid values: 2 to 10. Default value: 3. Unit: seconds.

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.

dryRun Boolean

Whether to precheck the API request.

healthCheckCodes List<String>

The HTTP status code that indicates a successful health check. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckConnectPort Integer

The number of the port that is used for health checks. Valid values: 0 to 65535. Default value: 0. This default value indicates that the backend server is used for health checks.

healthCheckHost String

The domain name that is used for health checks. Default value: $SERVER_IP. The domain name must be 1 to 80 characters in length. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckHttpVersion String

The version of the HTTP protocol. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckInterval Integer

The time interval between two consecutive health checks. Valid values: 1 to 50. Unit: seconds. Default value: 2.

healthCheckMethod String

The health check method. Valid values: GET and HEAD. Default value: HEAD. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckPath String

The URL that is used for health checks. The URL must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL can also contain the following extended characters: _ ; ~ ! ( )* [ ] @ $ ^ : ' , +. The URL must start with a forward slash (/). **NOTE:** The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckProtocol String

The protocol that is used for health checks. Valid values: HTTP and TCP. Default value: HTTP.

healthCheckTimeout Integer

The timeout period of a health check response. If the backend Elastic Compute Service (ECS) instance does not send an expected response within the specified period of time, the health check fails. Valid values: 1 to 300. Unit: seconds. Default value: 5.

healthyThreshold Integer

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy (from fail to success). Valid values: 2 to 10. Default value: 3. Unit: seconds.

unhealthyThreshold Integer

The number of times that an healthy backend server must consecutively fail health checks before it is declared unhealthy (from success to fail). Valid values: 2 to 10. Default value: 3. Unit: seconds.

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.

dryRun boolean

Whether to precheck the API request.

healthCheckCodes string[]

The HTTP status code that indicates a successful health check. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckConnectPort number

The number of the port that is used for health checks. Valid values: 0 to 65535. Default value: 0. This default value indicates that the backend server is used for health checks.

healthCheckHost string

The domain name that is used for health checks. Default value: $SERVER_IP. The domain name must be 1 to 80 characters in length. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckHttpVersion string

The version of the HTTP protocol. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckInterval number

The time interval between two consecutive health checks. Valid values: 1 to 50. Unit: seconds. Default value: 2.

healthCheckMethod string

The health check method. Valid values: GET and HEAD. Default value: HEAD. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckPath string

The URL that is used for health checks. The URL must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL can also contain the following extended characters: _ ; ~ ! ( )* [ ] @ $ ^ : ' , +. The URL must start with a forward slash (/). **NOTE:** The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckProtocol string

The protocol that is used for health checks. Valid values: HTTP and TCP. Default value: HTTP.

healthCheckTimeout number

The timeout period of a health check response. If the backend Elastic Compute Service (ECS) instance does not send an expected response within the specified period of time, the health check fails. Valid values: 1 to 300. Unit: seconds. Default value: 5.

healthyThreshold number

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy (from fail to success). Valid values: 2 to 10. Default value: 3. Unit: seconds.

unhealthyThreshold number

The number of times that an healthy backend server must consecutively fail health checks before it is declared unhealthy (from success to fail). Valid values: 2 to 10. Default value: 3. Unit: seconds.

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.

dry_run bool

Whether to precheck the API request.

health_check_codes Sequence[str]

The HTTP status code that indicates a successful health check. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

health_check_connect_port int

The number of the port that is used for health checks. Valid values: 0 to 65535. Default value: 0. This default value indicates that the backend server is used for health checks.

health_check_host str

The domain name that is used for health checks. Default value: $SERVER_IP. The domain name must be 1 to 80 characters in length. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

health_check_http_version str

The version of the HTTP protocol. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

health_check_interval int

The time interval between two consecutive health checks. Valid values: 1 to 50. Unit: seconds. Default value: 2.

health_check_method str

The health check method. Valid values: GET and HEAD. Default value: HEAD. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

health_check_path str

The URL that is used for health checks. The URL must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL can also contain the following extended characters: _ ; ~ ! ( )* [ ] @ $ ^ : ' , +. The URL must start with a forward slash (/). **NOTE:** The attribute HealthCheckProtocol is valid when the attribute is HTTP .

health_check_protocol str

The protocol that is used for health checks. Valid values: HTTP and TCP. Default value: HTTP.

health_check_timeout int

The timeout period of a health check response. If the backend Elastic Compute Service (ECS) instance does not send an expected response within the specified period of time, the health check fails. Valid values: 1 to 300. Unit: seconds. Default value: 5.

healthy_threshold int

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy (from fail to success). Valid values: 2 to 10. Default value: 3. Unit: seconds.

unhealthy_threshold int

The number of times that an healthy backend server must consecutively fail health checks before it is declared unhealthy (from success to fail). Valid values: 2 to 10. Default value: 3. Unit: seconds.

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.

dryRun Boolean

Whether to precheck the API request.

healthCheckCodes List<String>

The HTTP status code that indicates a successful health check. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckConnectPort Number

The number of the port that is used for health checks. Valid values: 0 to 65535. Default value: 0. This default value indicates that the backend server is used for health checks.

healthCheckHost String

The domain name that is used for health checks. Default value: $SERVER_IP. The domain name must be 1 to 80 characters in length. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckHttpVersion String

The version of the HTTP protocol. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckInterval Number

The time interval between two consecutive health checks. Valid values: 1 to 50. Unit: seconds. Default value: 2.

healthCheckMethod String

The health check method. Valid values: GET and HEAD. Default value: HEAD. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckPath String

The URL that is used for health checks. The URL must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL can also contain the following extended characters: _ ; ~ ! ( )* [ ] @ $ ^ : ' , +. The URL must start with a forward slash (/). **NOTE:** The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckProtocol String

The protocol that is used for health checks. Valid values: HTTP and TCP. Default value: HTTP.

healthCheckTimeout Number

The timeout period of a health check response. If the backend Elastic Compute Service (ECS) instance does not send an expected response within the specified period of time, the health check fails. Valid values: 1 to 300. Unit: seconds. Default value: 5.

healthyThreshold Number

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy (from fail to success). Valid values: 2 to 10. Default value: 3. Unit: seconds.

unhealthyThreshold Number

The number of times that an healthy backend server must consecutively fail health checks before it is declared unhealthy (from success to fail). Valid values: 2 to 10. Default value: 3. Unit: seconds.

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)
Resource lookup is not supported in YAML
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.
The following state arguments are supported:
DryRun bool

Whether to precheck the API request.

HealthCheckCodes List<string>

The HTTP status code that indicates a successful health check. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckConnectPort int

The number of the port that is used for health checks. Valid values: 0 to 65535. Default value: 0. This default value indicates that the backend server is used for health checks.

HealthCheckHost string

The domain name that is used for health checks. Default value: $SERVER_IP. The domain name must be 1 to 80 characters in length. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckHttpVersion string

The version of the HTTP protocol. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckInterval int

The time interval between two consecutive health checks. Valid values: 1 to 50. Unit: seconds. Default value: 2.

HealthCheckMethod string

The health check method. Valid values: GET and HEAD. Default value: HEAD. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckPath string

The URL that is used for health checks. The URL must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL can also contain the following extended characters: _ ; ~ ! ( )* [ ] @ $ ^ : ' , +. The URL must start with a forward slash (/). **NOTE:** The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckProtocol string

The protocol that is used for health checks. Valid values: HTTP and TCP. Default value: HTTP.

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 response. If the backend Elastic Compute Service (ECS) instance does not send an expected response within the specified period of time, the health check fails. Valid values: 1 to 300. Unit: seconds. Default value: 5.

HealthyThreshold int

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy (from fail to success). Valid values: 2 to 10. Default value: 3. Unit: seconds.

UnhealthyThreshold int

The number of times that an healthy backend server must consecutively fail health checks before it is declared unhealthy (from success to fail). Valid values: 2 to 10. Default value: 3. Unit: seconds.

DryRun bool

Whether to precheck the API request.

HealthCheckCodes []string

The HTTP status code that indicates a successful health check. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckConnectPort int

The number of the port that is used for health checks. Valid values: 0 to 65535. Default value: 0. This default value indicates that the backend server is used for health checks.

HealthCheckHost string

The domain name that is used for health checks. Default value: $SERVER_IP. The domain name must be 1 to 80 characters in length. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckHttpVersion string

The version of the HTTP protocol. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckInterval int

The time interval between two consecutive health checks. Valid values: 1 to 50. Unit: seconds. Default value: 2.

HealthCheckMethod string

The health check method. Valid values: GET and HEAD. Default value: HEAD. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckPath string

The URL that is used for health checks. The URL must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL can also contain the following extended characters: _ ; ~ ! ( )* [ ] @ $ ^ : ' , +. The URL must start with a forward slash (/). **NOTE:** The attribute HealthCheckProtocol is valid when the attribute is HTTP .

HealthCheckProtocol string

The protocol that is used for health checks. Valid values: HTTP and TCP. Default value: HTTP.

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 response. If the backend Elastic Compute Service (ECS) instance does not send an expected response within the specified period of time, the health check fails. Valid values: 1 to 300. Unit: seconds. Default value: 5.

HealthyThreshold int

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy (from fail to success). Valid values: 2 to 10. Default value: 3. Unit: seconds.

UnhealthyThreshold int

The number of times that an healthy backend server must consecutively fail health checks before it is declared unhealthy (from success to fail). Valid values: 2 to 10. Default value: 3. Unit: seconds.

dryRun Boolean

Whether to precheck the API request.

healthCheckCodes List<String>

The HTTP status code that indicates a successful health check. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckConnectPort Integer

The number of the port that is used for health checks. Valid values: 0 to 65535. Default value: 0. This default value indicates that the backend server is used for health checks.

healthCheckHost String

The domain name that is used for health checks. Default value: $SERVER_IP. The domain name must be 1 to 80 characters in length. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckHttpVersion String

The version of the HTTP protocol. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckInterval Integer

The time interval between two consecutive health checks. Valid values: 1 to 50. Unit: seconds. Default value: 2.

healthCheckMethod String

The health check method. Valid values: GET and HEAD. Default value: HEAD. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckPath String

The URL that is used for health checks. The URL must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL can also contain the following extended characters: _ ; ~ ! ( )* [ ] @ $ ^ : ' , +. The URL must start with a forward slash (/). **NOTE:** The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckProtocol String

The protocol that is used for health checks. Valid values: HTTP and TCP. Default value: HTTP.

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 response. If the backend Elastic Compute Service (ECS) instance does not send an expected response within the specified period of time, the health check fails. Valid values: 1 to 300. Unit: seconds. Default value: 5.

healthyThreshold Integer

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy (from fail to success). Valid values: 2 to 10. Default value: 3. Unit: seconds.

unhealthyThreshold Integer

The number of times that an healthy backend server must consecutively fail health checks before it is declared unhealthy (from success to fail). Valid values: 2 to 10. Default value: 3. Unit: seconds.

dryRun boolean

Whether to precheck the API request.

healthCheckCodes string[]

The HTTP status code that indicates a successful health check. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckConnectPort number

The number of the port that is used for health checks. Valid values: 0 to 65535. Default value: 0. This default value indicates that the backend server is used for health checks.

healthCheckHost string

The domain name that is used for health checks. Default value: $SERVER_IP. The domain name must be 1 to 80 characters in length. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckHttpVersion string

The version of the HTTP protocol. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckInterval number

The time interval between two consecutive health checks. Valid values: 1 to 50. Unit: seconds. Default value: 2.

healthCheckMethod string

The health check method. Valid values: GET and HEAD. Default value: HEAD. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckPath string

The URL that is used for health checks. The URL must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL can also contain the following extended characters: _ ; ~ ! ( )* [ ] @ $ ^ : ' , +. The URL must start with a forward slash (/). **NOTE:** The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckProtocol string

The protocol that is used for health checks. Valid values: HTTP and TCP. Default value: HTTP.

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 response. If the backend Elastic Compute Service (ECS) instance does not send an expected response within the specified period of time, the health check fails. Valid values: 1 to 300. Unit: seconds. Default value: 5.

healthyThreshold number

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy (from fail to success). Valid values: 2 to 10. Default value: 3. Unit: seconds.

unhealthyThreshold number

The number of times that an healthy backend server must consecutively fail health checks before it is declared unhealthy (from success to fail). Valid values: 2 to 10. Default value: 3. Unit: seconds.

dry_run bool

Whether to precheck the API request.

health_check_codes Sequence[str]

The HTTP status code that indicates a successful health check. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

health_check_connect_port int

The number of the port that is used for health checks. Valid values: 0 to 65535. Default value: 0. This default value indicates that the backend server is used for health checks.

health_check_host str

The domain name that is used for health checks. Default value: $SERVER_IP. The domain name must be 1 to 80 characters in length. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

health_check_http_version str

The version of the HTTP protocol. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

health_check_interval int

The time interval between two consecutive health checks. Valid values: 1 to 50. Unit: seconds. Default value: 2.

health_check_method str

The health check method. Valid values: GET and HEAD. Default value: HEAD. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

health_check_path str

The URL that is used for health checks. The URL must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL can also contain the following extended characters: _ ; ~ ! ( )* [ ] @ $ ^ : ' , +. The URL must start with a forward slash (/). **NOTE:** The attribute HealthCheckProtocol is valid when the attribute is HTTP .

health_check_protocol str

The protocol that is used for health checks. Valid values: HTTP and TCP. Default value: HTTP.

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 response. If the backend Elastic Compute Service (ECS) instance does not send an expected response within the specified period of time, the health check fails. Valid values: 1 to 300. Unit: seconds. Default value: 5.

healthy_threshold int

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy (from fail to success). Valid values: 2 to 10. Default value: 3. Unit: seconds.

unhealthy_threshold int

The number of times that an healthy backend server must consecutively fail health checks before it is declared unhealthy (from success to fail). Valid values: 2 to 10. Default value: 3. Unit: seconds.

dryRun Boolean

Whether to precheck the API request.

healthCheckCodes List<String>

The HTTP status code that indicates a successful health check. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckConnectPort Number

The number of the port that is used for health checks. Valid values: 0 to 65535. Default value: 0. This default value indicates that the backend server is used for health checks.

healthCheckHost String

The domain name that is used for health checks. Default value: $SERVER_IP. The domain name must be 1 to 80 characters in length. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckHttpVersion String

The version of the HTTP protocol. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckInterval Number

The time interval between two consecutive health checks. Valid values: 1 to 50. Unit: seconds. Default value: 2.

healthCheckMethod String

The health check method. Valid values: GET and HEAD. Default value: HEAD. NOTE: The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckPath String

The URL that is used for health checks. The URL must be 1 to 80 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), percent signs (%), question marks (?), number signs (#), and ampersands (&). The URL can also contain the following extended characters: _ ; ~ ! ( )* [ ] @ $ ^ : ' , +. The URL must start with a forward slash (/). **NOTE:** The attribute HealthCheckProtocol is valid when the attribute is HTTP .

healthCheckProtocol String

The protocol that is used for health checks. Valid values: HTTP and TCP. Default value: HTTP.

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 response. If the backend Elastic Compute Service (ECS) instance does not send an expected response within the specified period of time, the health check fails. Valid values: 1 to 300. Unit: seconds. Default value: 5.

healthyThreshold Number

The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy (from fail to success). Valid values: 2 to 10. Default value: 3. Unit: seconds.

unhealthyThreshold Number

The number of times that an healthy backend server must consecutively fail health checks before it is declared unhealthy (from success to fail). Valid values: 2 to 10. Default value: 3. Unit: seconds.

Import

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

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

Package Details

Repository
Alibaba Cloud pulumi/pulumi-alicloud
License
Apache-2.0
Notes

This Pulumi package is based on the alicloud Terraform Provider.