Alibaba Cloud v3.37.0, May 15 23

alicloud.alb.getHealthCheckTemplates

Explore with Pulumi AI

This data source provides the Alb Health Check Templates of the current Alibaba Cloud user.

NOTE: Available in v1.134.0+.

Example Usage

Basic Usage

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

return await Deployment.RunAsync(() => 
{
    var ids = AliCloud.Alb.GetHealthCheckTemplates.Invoke(new()
    {
        Ids = new[]
        {
            "example_id",
        },
    });

    var nameRegex = AliCloud.Alb.GetHealthCheckTemplates.Invoke(new()
    {
        NameRegex = "^my-HealthCheckTemplate",
    });

    return new Dictionary<string, object?>
    {
        ["albHealthCheckTemplateId1"] = ids.Apply(getHealthCheckTemplatesResult => getHealthCheckTemplatesResult.Templates[0]?.Id),
        ["albHealthCheckTemplateId2"] = nameRegex.Apply(getHealthCheckTemplatesResult => getHealthCheckTemplatesResult.Templates[0]?.Id),
    };
});

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 {
		ids, err := alb.GetHealthCheckTemplates(ctx, &alb.GetHealthCheckTemplatesArgs{
			Ids: []string{
				"example_id",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("albHealthCheckTemplateId1", ids.Templates[0].Id)
		nameRegex, err := alb.GetHealthCheckTemplates(ctx, &alb.GetHealthCheckTemplatesArgs{
			NameRegex: pulumi.StringRef("^my-HealthCheckTemplate"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("albHealthCheckTemplateId2", nameRegex.Templates[0].Id)
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.alb.AlbFunctions;
import com.pulumi.alicloud.alb.inputs.GetHealthCheckTemplatesArgs;
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 ids = AlbFunctions.getHealthCheckTemplates(GetHealthCheckTemplatesArgs.builder()
            .ids("example_id")
            .build());

        ctx.export("albHealthCheckTemplateId1", ids.applyValue(getHealthCheckTemplatesResult -> getHealthCheckTemplatesResult.templates()[0].id()));
        final var nameRegex = AlbFunctions.getHealthCheckTemplates(GetHealthCheckTemplatesArgs.builder()
            .nameRegex("^my-HealthCheckTemplate")
            .build());

        ctx.export("albHealthCheckTemplateId2", nameRegex.applyValue(getHealthCheckTemplatesResult -> getHealthCheckTemplatesResult.templates()[0].id()));
    }
}

import pulumi
import pulumi_alicloud as alicloud

ids = alicloud.alb.get_health_check_templates(ids=["example_id"])
pulumi.export("albHealthCheckTemplateId1", ids.templates[0].id)
name_regex = alicloud.alb.get_health_check_templates(name_regex="^my-HealthCheckTemplate")
pulumi.export("albHealthCheckTemplateId2", name_regex.templates[0].id)

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

const ids = alicloud.alb.getHealthCheckTemplates({
    ids: ["example_id"],
});
export const albHealthCheckTemplateId1 = ids.then(ids => ids.templates?.[0]?.id);
const nameRegex = alicloud.alb.getHealthCheckTemplates({
    nameRegex: "^my-HealthCheckTemplate",
});
export const albHealthCheckTemplateId2 = nameRegex.then(nameRegex => nameRegex.templates?.[0]?.id);

variables:
  ids:
    fn::invoke:
      Function: alicloud:alb:getHealthCheckTemplates
      Arguments:
        ids:
          - example_id
  nameRegex:
    fn::invoke:
      Function: alicloud:alb:getHealthCheckTemplates
      Arguments:
        nameRegex: ^my-HealthCheckTemplate
outputs:
  albHealthCheckTemplateId1: ${ids.templates[0].id}
  albHealthCheckTemplateId2: ${nameRegex.templates[0].id}

Using getHealthCheckTemplates

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getHealthCheckTemplates(args: GetHealthCheckTemplatesArgs, opts?: InvokeOptions): Promise<GetHealthCheckTemplatesResult>
function getHealthCheckTemplatesOutput(args: GetHealthCheckTemplatesOutputArgs, opts?: InvokeOptions): Output<GetHealthCheckTemplatesResult>

def get_health_check_templates(health_check_template_ids: Optional[Sequence[str]] = None,
                               health_check_template_name: Optional[str] = None,
                               ids: Optional[Sequence[str]] = None,
                               name_regex: Optional[str] = None,
                               output_file: Optional[str] = None,
                               opts: Optional[InvokeOptions] = None) -> GetHealthCheckTemplatesResult
def get_health_check_templates_output(health_check_template_ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                               health_check_template_name: Optional[pulumi.Input[str]] = None,
                               ids: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                               name_regex: Optional[pulumi.Input[str]] = None,
                               output_file: Optional[pulumi.Input[str]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetHealthCheckTemplatesResult]

func GetHealthCheckTemplates(ctx *Context, args *GetHealthCheckTemplatesArgs, opts ...InvokeOption) (*GetHealthCheckTemplatesResult, error)
func GetHealthCheckTemplatesOutput(ctx *Context, args *GetHealthCheckTemplatesOutputArgs, opts ...InvokeOption) GetHealthCheckTemplatesResultOutput

> Note: This function is named GetHealthCheckTemplates in the Go SDK.

public static class GetHealthCheckTemplates 
{
    public static Task<GetHealthCheckTemplatesResult> InvokeAsync(GetHealthCheckTemplatesArgs args, InvokeOptions? opts = null)
    public static Output<GetHealthCheckTemplatesResult> Invoke(GetHealthCheckTemplatesInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetHealthCheckTemplatesResult> getHealthCheckTemplates(GetHealthCheckTemplatesArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: alicloud:alb/getHealthCheckTemplates:getHealthCheckTemplates
  arguments:
    # arguments dictionary

The following arguments are supported:

HealthCheckTemplateIds List<string>: The health check template ids.
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.
Ids List<string>: A list of Health Check Template IDs.
NameRegex string: A regex string to filter results by Health Check Template name.
OutputFile string: File name where to save data source results (after running pulumi preview).

HealthCheckTemplateIds []string: The health check template ids.
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.
Ids []string: A list of Health Check Template IDs.
NameRegex string: A regex string to filter results by Health Check Template name.
OutputFile string: File name where to save data source results (after running pulumi preview).

healthCheckTemplateIds List<String>: The health check template ids.
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.
ids List<String>: A list of Health Check Template IDs.
nameRegex String: A regex string to filter results by Health Check Template name.
outputFile String: File name where to save data source results (after running pulumi preview).

healthCheckTemplateIds string[]: The health check template ids.
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.
ids string[]: A list of Health Check Template IDs.
nameRegex string: A regex string to filter results by Health Check Template name.
outputFile string: File name where to save data source results (after running pulumi preview).

health_check_template_ids Sequence[str]: The health check template ids.
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.
ids Sequence[str]: A list of Health Check Template IDs.
name_regex str: A regex string to filter results by Health Check Template name.
output_file str: File name where to save data source results (after running pulumi preview).

healthCheckTemplateIds List<String>: The health check template ids.
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.
ids List<String>: A list of Health Check Template IDs.
nameRegex String: A regex string to filter results by Health Check Template name.
outputFile String: File name where to save data source results (after running pulumi preview).

getHealthCheckTemplates Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
Ids List<string>
Names List<string>
Templates List<Pulumi.AliCloud.Alb.Outputs.GetHealthCheckTemplatesTemplate>
HealthCheckTemplateIds List<string>
HealthCheckTemplateName string
NameRegex string
OutputFile string

Id string: The provider-assigned unique ID for this managed resource.
Ids []string
Names []string
Templates []GetHealthCheckTemplatesTemplate
HealthCheckTemplateIds []string
HealthCheckTemplateName string
NameRegex string
OutputFile string

id String: The provider-assigned unique ID for this managed resource.
ids List<String>
names List<String>
templates List<GetHealthCheckTemplatesTemplate>
healthCheckTemplateIds List<String>
healthCheckTemplateName String
nameRegex String
outputFile String

id string: The provider-assigned unique ID for this managed resource.
ids string[]
names string[]
templates GetHealthCheckTemplatesTemplate[]
healthCheckTemplateIds string[]
healthCheckTemplateName string
nameRegex string
outputFile string

id str: The provider-assigned unique ID for this managed resource.
ids Sequence[str]
names Sequence[str]
templates Sequence[GetHealthCheckTemplatesTemplate]
health_check_template_ids Sequence[str]
health_check_template_name str
name_regex str
output_file str

id String: The provider-assigned unique ID for this managed resource.
ids List<String>
names List<String>
templates List<Property Map>
healthCheckTemplateIds List<String>
healthCheckTemplateName String
nameRegex String
outputFile String

Supporting Types

GetHealthCheckTemplatesTemplate

HealthCheckCodes List<string>: The HTTP status code that indicates a successful health check.
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.
HealthCheckHttpVersion string: The version of the HTTP protocol. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1.
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.
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 (/).
HealthCheckProtocol string: The protocol that is used for health checks. Valid values: HTTP and TCP. Default value: HTTP.
HealthCheckTemplateId string: The ID of the resource.
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.
Id string: The ID of the Health Check Template.
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.

HealthCheckCodes []string: The HTTP status code that indicates a successful health check.
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.
HealthCheckHttpVersion string: The version of the HTTP protocol. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1.
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.
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 (/).
HealthCheckProtocol string: The protocol that is used for health checks. Valid values: HTTP and TCP. Default value: HTTP.
HealthCheckTemplateId string: The ID of the resource.
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.
Id string: The ID of the Health Check Template.
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.

healthCheckCodes List<String>: The HTTP status code that indicates a successful health check.
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.
healthCheckHttpVersion String: The version of the HTTP protocol. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1.
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.
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 (/).
healthCheckProtocol String: The protocol that is used for health checks. Valid values: HTTP and TCP. Default value: HTTP.
healthCheckTemplateId String: The ID of the resource.
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.
id String: The ID of the Health Check Template.
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.

healthCheckCodes string[]: The HTTP status code that indicates a successful health check.
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.
healthCheckHttpVersion string: The version of the HTTP protocol. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1.
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.
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 (/).
healthCheckProtocol string: The protocol that is used for health checks. Valid values: HTTP and TCP. Default value: HTTP.
healthCheckTemplateId string: The ID of the resource.
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.
id string: The ID of the Health Check Template.
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_codes Sequence[str]: The HTTP status code that indicates a successful health check.
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.
health_check_http_version str: The version of the HTTP protocol. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1.
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.
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 (/).
health_check_protocol str: The protocol that is used for health checks. Valid values: HTTP and TCP. Default value: HTTP.
health_check_template_id str: The ID of the resource.
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.
id str: The ID of the Health Check Template.
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.

healthCheckCodes List<String>: The HTTP status code that indicates a successful health check.
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.
healthCheckHttpVersion String: The version of the HTTP protocol. Valid values: HTTP1.0 and HTTP1.1. Default value: HTTP1.1.
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.
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 (/).
healthCheckProtocol String: The protocol that is used for health checks. Valid values: HTTP and TCP. Default value: HTTP.
healthCheckTemplateId String: The ID of the resource.
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.
id String: The ID of the Health Check Template.
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.

Package Details

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