volcengine.alb.HealthCheckTemplate
Explore with Pulumi AI
Provides a resource to manage alb health check template
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Volcengine = Pulumi.Volcengine;
return await Deployment.RunAsync(() =>
{
var foo = new Volcengine.Alb.HealthCheckTemplate("foo", new()
{
Description = "acc-test3",
HealthCheckDomain = "test.com",
HealthCheckHttpCode = "http_2xx",
HealthCheckHttpVersion = "HTTP1.1",
HealthCheckInterval = 8,
HealthCheckMethod = "HEAD",
HealthCheckProtocol = "HTTP",
HealthCheckTemplateName = "acc-test-template-1",
HealthCheckTimeout = 11,
HealthCheckUri = "/",
HealthyThreshold = 2,
UnhealthyThreshold = 3,
});
});
package main
import (
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/volcengine/pulumi-volcengine/sdk/go/volcengine/alb"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := alb.NewHealthCheckTemplate(ctx, "foo", &alb.HealthCheckTemplateArgs{
Description: pulumi.String("acc-test3"),
HealthCheckDomain: pulumi.String("test.com"),
HealthCheckHttpCode: pulumi.String("http_2xx"),
HealthCheckHttpVersion: pulumi.String("HTTP1.1"),
HealthCheckInterval: pulumi.Int(8),
HealthCheckMethod: pulumi.String("HEAD"),
HealthCheckProtocol: pulumi.String("HTTP"),
HealthCheckTemplateName: pulumi.String("acc-test-template-1"),
HealthCheckTimeout: pulumi.Int(11),
HealthCheckUri: pulumi.String("/"),
HealthyThreshold: pulumi.Int(2),
UnhealthyThreshold: pulumi.Int(3),
})
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.volcengine.alb.HealthCheckTemplate;
import com.pulumi.volcengine.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 foo = new HealthCheckTemplate("foo", HealthCheckTemplateArgs.builder()
.description("acc-test3")
.healthCheckDomain("test.com")
.healthCheckHttpCode("http_2xx")
.healthCheckHttpVersion("HTTP1.1")
.healthCheckInterval(8)
.healthCheckMethod("HEAD")
.healthCheckProtocol("HTTP")
.healthCheckTemplateName("acc-test-template-1")
.healthCheckTimeout(11)
.healthCheckUri("/")
.healthyThreshold(2)
.unhealthyThreshold(3)
.build());
}
}
import pulumi
import pulumi_volcengine as volcengine
foo = volcengine.alb.HealthCheckTemplate("foo",
description="acc-test3",
health_check_domain="test.com",
health_check_http_code="http_2xx",
health_check_http_version="HTTP1.1",
health_check_interval=8,
health_check_method="HEAD",
health_check_protocol="HTTP",
health_check_template_name="acc-test-template-1",
health_check_timeout=11,
health_check_uri="/",
healthy_threshold=2,
unhealthy_threshold=3)
import * as pulumi from "@pulumi/pulumi";
import * as volcengine from "@volcengine/pulumi";
const foo = new volcengine.alb.HealthCheckTemplate("foo", {
description: "acc-test3",
healthCheckDomain: "test.com",
healthCheckHttpCode: "http_2xx",
healthCheckHttpVersion: "HTTP1.1",
healthCheckInterval: 8,
healthCheckMethod: "HEAD",
healthCheckProtocol: "HTTP",
healthCheckTemplateName: "acc-test-template-1",
healthCheckTimeout: 11,
healthCheckUri: "/",
healthyThreshold: 2,
unhealthyThreshold: 3,
});
resources:
foo:
type: volcengine:alb:HealthCheckTemplate
properties:
description: acc-test3
healthCheckDomain: test.com
healthCheckHttpCode: http_2xx
healthCheckHttpVersion: HTTP1.1
healthCheckInterval: 8
healthCheckMethod: HEAD
healthCheckProtocol: HTTP
healthCheckTemplateName: acc-test-template-1
healthCheckTimeout: 11
healthCheckUri: /
healthyThreshold: 2
unhealthyThreshold: 3
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,
description: Optional[str] = None,
health_check_domain: Optional[str] = None,
health_check_http_code: Optional[str] = None,
health_check_http_version: Optional[str] = None,
health_check_interval: Optional[int] = None,
health_check_method: Optional[str] = None,
health_check_protocol: Optional[str] = None,
health_check_timeout: Optional[int] = None,
health_check_uri: Optional[str] = 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: volcengine:alb:HealthCheckTemplate
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args HealthCheckTemplateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args HealthCheckTemplateArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args HealthCheckTemplateArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args HealthCheckTemplateArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args HealthCheckTemplateArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var healthCheckTemplateResource = new Volcengine.Alb.HealthCheckTemplate("healthCheckTemplateResource", new()
{
HealthCheckTemplateName = "string",
Description = "string",
HealthCheckDomain = "string",
HealthCheckHttpCode = "string",
HealthCheckHttpVersion = "string",
HealthCheckInterval = 0,
HealthCheckMethod = "string",
HealthCheckProtocol = "string",
HealthCheckTimeout = 0,
HealthCheckUri = "string",
HealthyThreshold = 0,
UnhealthyThreshold = 0,
});
example, err := alb.NewHealthCheckTemplate(ctx, "healthCheckTemplateResource", &alb.HealthCheckTemplateArgs{
HealthCheckTemplateName: pulumi.String("string"),
Description: pulumi.String("string"),
HealthCheckDomain: pulumi.String("string"),
HealthCheckHttpCode: pulumi.String("string"),
HealthCheckHttpVersion: pulumi.String("string"),
HealthCheckInterval: pulumi.Int(0),
HealthCheckMethod: pulumi.String("string"),
HealthCheckProtocol: pulumi.String("string"),
HealthCheckTimeout: pulumi.Int(0),
HealthCheckUri: pulumi.String("string"),
HealthyThreshold: pulumi.Int(0),
UnhealthyThreshold: pulumi.Int(0),
})
var healthCheckTemplateResource = new HealthCheckTemplate("healthCheckTemplateResource", HealthCheckTemplateArgs.builder()
.healthCheckTemplateName("string")
.description("string")
.healthCheckDomain("string")
.healthCheckHttpCode("string")
.healthCheckHttpVersion("string")
.healthCheckInterval(0)
.healthCheckMethod("string")
.healthCheckProtocol("string")
.healthCheckTimeout(0)
.healthCheckUri("string")
.healthyThreshold(0)
.unhealthyThreshold(0)
.build());
health_check_template_resource = volcengine.alb.HealthCheckTemplate("healthCheckTemplateResource",
health_check_template_name="string",
description="string",
health_check_domain="string",
health_check_http_code="string",
health_check_http_version="string",
health_check_interval=0,
health_check_method="string",
health_check_protocol="string",
health_check_timeout=0,
health_check_uri="string",
healthy_threshold=0,
unhealthy_threshold=0)
const healthCheckTemplateResource = new volcengine.alb.HealthCheckTemplate("healthCheckTemplateResource", {
healthCheckTemplateName: "string",
description: "string",
healthCheckDomain: "string",
healthCheckHttpCode: "string",
healthCheckHttpVersion: "string",
healthCheckInterval: 0,
healthCheckMethod: "string",
healthCheckProtocol: "string",
healthCheckTimeout: 0,
healthCheckUri: "string",
healthyThreshold: 0,
unhealthyThreshold: 0,
});
type: volcengine:alb:HealthCheckTemplate
properties:
description: string
healthCheckDomain: string
healthCheckHttpCode: string
healthCheckHttpVersion: string
healthCheckInterval: 0
healthCheckMethod: string
healthCheckProtocol: string
healthCheckTemplateName: string
healthCheckTimeout: 0
healthCheckUri: string
healthyThreshold: 0
unhealthyThreshold: 0
HealthCheckTemplate Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The HealthCheckTemplate resource accepts the following input properties:
- Health
Check stringTemplate Name - The health check template name.
- Description string
- The description of health check template.
- Health
Check stringDomain - The domain name to health check.
- Health
Check stringHttp Code - The normal HTTP status code for health check, the default is http_2xx, http_3xx, separated by commas.
- Health
Check stringHttp Version - The HTTP version of health check.
- Health
Check intInterval - The interval for performing health checks, the default value is 2, and the value is 1-300.
- Health
Check stringMethod - The health check method,default is
GET
, supportGET
andHEAD
. - Health
Check stringProtocol - THe protocol of health check,only support HTTP.
- Health
Check intTimeout - The timeout of health check response,the default value is 2, and the value is 1-60.
- Health
Check stringUri - The uri to health check,default is
/
. - Healthy
Threshold int - The healthy threshold of the health check, the default is 3, the value is 2-10.
- Unhealthy
Threshold int - The unhealthy threshold of the health check, the default is 3, the value is 2-10.
- Health
Check stringTemplate Name - The health check template name.
- Description string
- The description of health check template.
- Health
Check stringDomain - The domain name to health check.
- Health
Check stringHttp Code - The normal HTTP status code for health check, the default is http_2xx, http_3xx, separated by commas.
- Health
Check stringHttp Version - The HTTP version of health check.
- Health
Check intInterval - The interval for performing health checks, the default value is 2, and the value is 1-300.
- Health
Check stringMethod - The health check method,default is
GET
, supportGET
andHEAD
. - Health
Check stringProtocol - THe protocol of health check,only support HTTP.
- Health
Check intTimeout - The timeout of health check response,the default value is 2, and the value is 1-60.
- Health
Check stringUri - The uri to health check,default is
/
. - Healthy
Threshold int - The healthy threshold of the health check, the default is 3, the value is 2-10.
- Unhealthy
Threshold int - The unhealthy threshold of the health check, the default is 3, the value is 2-10.
- health
Check StringTemplate Name - The health check template name.
- description String
- The description of health check template.
- health
Check StringDomain - The domain name to health check.
- health
Check StringHttp Code - The normal HTTP status code for health check, the default is http_2xx, http_3xx, separated by commas.
- health
Check StringHttp Version - The HTTP version of health check.
- health
Check IntegerInterval - The interval for performing health checks, the default value is 2, and the value is 1-300.
- health
Check StringMethod - The health check method,default is
GET
, supportGET
andHEAD
. - health
Check StringProtocol - THe protocol of health check,only support HTTP.
- health
Check IntegerTimeout - The timeout of health check response,the default value is 2, and the value is 1-60.
- health
Check StringUri - The uri to health check,default is
/
. - healthy
Threshold Integer - The healthy threshold of the health check, the default is 3, the value is 2-10.
- unhealthy
Threshold Integer - The unhealthy threshold of the health check, the default is 3, the value is 2-10.
- health
Check stringTemplate Name - The health check template name.
- description string
- The description of health check template.
- health
Check stringDomain - The domain name to health check.
- health
Check stringHttp Code - The normal HTTP status code for health check, the default is http_2xx, http_3xx, separated by commas.
- health
Check stringHttp Version - The HTTP version of health check.
- health
Check numberInterval - The interval for performing health checks, the default value is 2, and the value is 1-300.
- health
Check stringMethod - The health check method,default is
GET
, supportGET
andHEAD
. - health
Check stringProtocol - THe protocol of health check,only support HTTP.
- health
Check numberTimeout - The timeout of health check response,the default value is 2, and the value is 1-60.
- health
Check stringUri - The uri to health check,default is
/
. - healthy
Threshold number - The healthy threshold of the health check, the default is 3, the value is 2-10.
- unhealthy
Threshold number - The unhealthy threshold of the health check, the default is 3, the value is 2-10.
- health_
check_ strtemplate_ name - The health check template name.
- description str
- The description of health check template.
- health_
check_ strdomain - The domain name to health check.
- health_
check_ strhttp_ code - The normal HTTP status code for health check, the default is http_2xx, http_3xx, separated by commas.
- health_
check_ strhttp_ version - The HTTP version of health check.
- health_
check_ intinterval - The interval for performing health checks, the default value is 2, and the value is 1-300.
- health_
check_ strmethod - The health check method,default is
GET
, supportGET
andHEAD
. - health_
check_ strprotocol - THe protocol of health check,only support HTTP.
- health_
check_ inttimeout - The timeout of health check response,the default value is 2, and the value is 1-60.
- health_
check_ struri - The uri to health check,default is
/
. - healthy_
threshold int - The healthy threshold of the health check, the default is 3, the value is 2-10.
- unhealthy_
threshold int - The unhealthy threshold of the health check, the default is 3, the value is 2-10.
- health
Check StringTemplate Name - The health check template name.
- description String
- The description of health check template.
- health
Check StringDomain - The domain name to health check.
- health
Check StringHttp Code - The normal HTTP status code for health check, the default is http_2xx, http_3xx, separated by commas.
- health
Check StringHttp Version - The HTTP version of health check.
- health
Check NumberInterval - The interval for performing health checks, the default value is 2, and the value is 1-300.
- health
Check StringMethod - The health check method,default is
GET
, supportGET
andHEAD
. - health
Check StringProtocol - THe protocol of health check,only support HTTP.
- health
Check NumberTimeout - The timeout of health check response,the default value is 2, and the value is 1-60.
- health
Check StringUri - The uri to health check,default is
/
. - healthy
Threshold Number - The healthy threshold of the health check, the default is 3, the value is 2-10.
- unhealthy
Threshold Number - The unhealthy threshold of the health check, the default is 3, the value is 2-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,
description: Optional[str] = None,
health_check_domain: Optional[str] = None,
health_check_http_code: Optional[str] = None,
health_check_http_version: Optional[str] = None,
health_check_interval: Optional[int] = None,
health_check_method: Optional[str] = None,
health_check_protocol: Optional[str] = None,
health_check_template_name: Optional[str] = None,
health_check_timeout: Optional[int] = None,
health_check_uri: Optional[str] = None,
healthy_threshold: Optional[int] = None,
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.
- Description string
- The description of health check template.
- Health
Check stringDomain - The domain name to health check.
- Health
Check stringHttp Code - The normal HTTP status code for health check, the default is http_2xx, http_3xx, separated by commas.
- Health
Check stringHttp Version - The HTTP version of health check.
- Health
Check intInterval - The interval for performing health checks, the default value is 2, and the value is 1-300.
- Health
Check stringMethod - The health check method,default is
GET
, supportGET
andHEAD
. - Health
Check stringProtocol - THe protocol of health check,only support HTTP.
- Health
Check stringTemplate Name - The health check template name.
- Health
Check intTimeout - The timeout of health check response,the default value is 2, and the value is 1-60.
- Health
Check stringUri - The uri to health check,default is
/
. - Healthy
Threshold int - The healthy threshold of the health check, the default is 3, the value is 2-10.
- Unhealthy
Threshold int - The unhealthy threshold of the health check, the default is 3, the value is 2-10.
- Description string
- The description of health check template.
- Health
Check stringDomain - The domain name to health check.
- Health
Check stringHttp Code - The normal HTTP status code for health check, the default is http_2xx, http_3xx, separated by commas.
- Health
Check stringHttp Version - The HTTP version of health check.
- Health
Check intInterval - The interval for performing health checks, the default value is 2, and the value is 1-300.
- Health
Check stringMethod - The health check method,default is
GET
, supportGET
andHEAD
. - Health
Check stringProtocol - THe protocol of health check,only support HTTP.
- Health
Check stringTemplate Name - The health check template name.
- Health
Check intTimeout - The timeout of health check response,the default value is 2, and the value is 1-60.
- Health
Check stringUri - The uri to health check,default is
/
. - Healthy
Threshold int - The healthy threshold of the health check, the default is 3, the value is 2-10.
- Unhealthy
Threshold int - The unhealthy threshold of the health check, the default is 3, the value is 2-10.
- description String
- The description of health check template.
- health
Check StringDomain - The domain name to health check.
- health
Check StringHttp Code - The normal HTTP status code for health check, the default is http_2xx, http_3xx, separated by commas.
- health
Check StringHttp Version - The HTTP version of health check.
- health
Check IntegerInterval - The interval for performing health checks, the default value is 2, and the value is 1-300.
- health
Check StringMethod - The health check method,default is
GET
, supportGET
andHEAD
. - health
Check StringProtocol - THe protocol of health check,only support HTTP.
- health
Check StringTemplate Name - The health check template name.
- health
Check IntegerTimeout - The timeout of health check response,the default value is 2, and the value is 1-60.
- health
Check StringUri - The uri to health check,default is
/
. - healthy
Threshold Integer - The healthy threshold of the health check, the default is 3, the value is 2-10.
- unhealthy
Threshold Integer - The unhealthy threshold of the health check, the default is 3, the value is 2-10.
- description string
- The description of health check template.
- health
Check stringDomain - The domain name to health check.
- health
Check stringHttp Code - The normal HTTP status code for health check, the default is http_2xx, http_3xx, separated by commas.
- health
Check stringHttp Version - The HTTP version of health check.
- health
Check numberInterval - The interval for performing health checks, the default value is 2, and the value is 1-300.
- health
Check stringMethod - The health check method,default is
GET
, supportGET
andHEAD
. - health
Check stringProtocol - THe protocol of health check,only support HTTP.
- health
Check stringTemplate Name - The health check template name.
- health
Check numberTimeout - The timeout of health check response,the default value is 2, and the value is 1-60.
- health
Check stringUri - The uri to health check,default is
/
. - healthy
Threshold number - The healthy threshold of the health check, the default is 3, the value is 2-10.
- unhealthy
Threshold number - The unhealthy threshold of the health check, the default is 3, the value is 2-10.
- description str
- The description of health check template.
- health_
check_ strdomain - The domain name to health check.
- health_
check_ strhttp_ code - The normal HTTP status code for health check, the default is http_2xx, http_3xx, separated by commas.
- health_
check_ strhttp_ version - The HTTP version of health check.
- health_
check_ intinterval - The interval for performing health checks, the default value is 2, and the value is 1-300.
- health_
check_ strmethod - The health check method,default is
GET
, supportGET
andHEAD
. - health_
check_ strprotocol - THe protocol of health check,only support HTTP.
- health_
check_ strtemplate_ name - The health check template name.
- health_
check_ inttimeout - The timeout of health check response,the default value is 2, and the value is 1-60.
- health_
check_ struri - The uri to health check,default is
/
. - healthy_
threshold int - The healthy threshold of the health check, the default is 3, the value is 2-10.
- unhealthy_
threshold int - The unhealthy threshold of the health check, the default is 3, the value is 2-10.
- description String
- The description of health check template.
- health
Check StringDomain - The domain name to health check.
- health
Check StringHttp Code - The normal HTTP status code for health check, the default is http_2xx, http_3xx, separated by commas.
- health
Check StringHttp Version - The HTTP version of health check.
- health
Check NumberInterval - The interval for performing health checks, the default value is 2, and the value is 1-300.
- health
Check StringMethod - The health check method,default is
GET
, supportGET
andHEAD
. - health
Check StringProtocol - THe protocol of health check,only support HTTP.
- health
Check StringTemplate Name - The health check template name.
- health
Check NumberTimeout - The timeout of health check response,the default value is 2, and the value is 1-60.
- health
Check StringUri - The uri to health check,default is
/
. - healthy
Threshold Number - The healthy threshold of the health check, the default is 3, the value is 2-10.
- unhealthy
Threshold Number - The unhealthy threshold of the health check, the default is 3, the value is 2-10.
Import
AlbHealthCheckTemplate can be imported using the id, e.g.
$ pulumi import volcengine:alb/healthCheckTemplate:HealthCheckTemplate default hctpl-123*****432
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- volcengine volcengine/pulumi-volcengine
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
volcengine
Terraform Provider.