Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. compute
  5. compute/v1
  6. HttpHealthCheck

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.compute/v1.HttpHealthCheck

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

Creates a HttpHealthCheck resource in the specified project using the data included in the request.

Create HttpHealthCheck Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new HttpHealthCheck(name: string, args?: HttpHealthCheckArgs, opts?: CustomResourceOptions);
@overload
def HttpHealthCheck(resource_name: str,
                    args: Optional[HttpHealthCheckArgs] = None,
                    opts: Optional[ResourceOptions] = None)

@overload
def HttpHealthCheck(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    check_interval_sec: Optional[int] = None,
                    description: Optional[str] = None,
                    healthy_threshold: Optional[int] = None,
                    host: Optional[str] = None,
                    name: Optional[str] = None,
                    port: Optional[int] = None,
                    project: Optional[str] = None,
                    request_id: Optional[str] = None,
                    request_path: Optional[str] = None,
                    timeout_sec: Optional[int] = None,
                    unhealthy_threshold: Optional[int] = None)
func NewHttpHealthCheck(ctx *Context, name string, args *HttpHealthCheckArgs, opts ...ResourceOption) (*HttpHealthCheck, error)
public HttpHealthCheck(string name, HttpHealthCheckArgs? args = null, CustomResourceOptions? opts = null)
public HttpHealthCheck(String name, HttpHealthCheckArgs args)
public HttpHealthCheck(String name, HttpHealthCheckArgs args, CustomResourceOptions options)

type: google-native:compute/v1:HttpHealthCheck
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args HttpHealthCheckArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args HttpHealthCheckArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args HttpHealthCheckArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args HttpHealthCheckArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. HttpHealthCheckArgs
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 examplehttpHealthCheckResourceResourceFromComputev1 = new GoogleNative.Compute.V1.HttpHealthCheck("examplehttpHealthCheckResourceResourceFromComputev1", new()
{
    CheckIntervalSec = 0,
    Description = "string",
    HealthyThreshold = 0,
    Host = "string",
    Name = "string",
    Port = 0,
    Project = "string",
    RequestId = "string",
    RequestPath = "string",
    TimeoutSec = 0,
    UnhealthyThreshold = 0,
});
Copy
example, err := computev1.NewHttpHealthCheck(ctx, "examplehttpHealthCheckResourceResourceFromComputev1", &computev1.HttpHealthCheckArgs{
	CheckIntervalSec:   pulumi.Int(0),
	Description:        pulumi.String("string"),
	HealthyThreshold:   pulumi.Int(0),
	Host:               pulumi.String("string"),
	Name:               pulumi.String("string"),
	Port:               pulumi.Int(0),
	Project:            pulumi.String("string"),
	RequestId:          pulumi.String("string"),
	RequestPath:        pulumi.String("string"),
	TimeoutSec:         pulumi.Int(0),
	UnhealthyThreshold: pulumi.Int(0),
})
Copy
var examplehttpHealthCheckResourceResourceFromComputev1 = new HttpHealthCheck("examplehttpHealthCheckResourceResourceFromComputev1", HttpHealthCheckArgs.builder()
    .checkIntervalSec(0)
    .description("string")
    .healthyThreshold(0)
    .host("string")
    .name("string")
    .port(0)
    .project("string")
    .requestId("string")
    .requestPath("string")
    .timeoutSec(0)
    .unhealthyThreshold(0)
    .build());
Copy
examplehttp_health_check_resource_resource_from_computev1 = google_native.compute.v1.HttpHealthCheck("examplehttpHealthCheckResourceResourceFromComputev1",
    check_interval_sec=0,
    description="string",
    healthy_threshold=0,
    host="string",
    name="string",
    port=0,
    project="string",
    request_id="string",
    request_path="string",
    timeout_sec=0,
    unhealthy_threshold=0)
Copy
const examplehttpHealthCheckResourceResourceFromComputev1 = new google_native.compute.v1.HttpHealthCheck("examplehttpHealthCheckResourceResourceFromComputev1", {
    checkIntervalSec: 0,
    description: "string",
    healthyThreshold: 0,
    host: "string",
    name: "string",
    port: 0,
    project: "string",
    requestId: "string",
    requestPath: "string",
    timeoutSec: 0,
    unhealthyThreshold: 0,
});
Copy
type: google-native:compute/v1:HttpHealthCheck
properties:
    checkIntervalSec: 0
    description: string
    healthyThreshold: 0
    host: string
    name: string
    port: 0
    project: string
    requestId: string
    requestPath: string
    timeoutSec: 0
    unhealthyThreshold: 0
Copy

HttpHealthCheck 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 HttpHealthCheck resource accepts the following input properties:

CheckIntervalSec int
How often (in seconds) to send a health check. The default value is 5 seconds.
Description string
An optional description of this resource. Provide this property when you create the resource.
HealthyThreshold int
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
Host string
The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
Name string
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Port int
The TCP port number for the HTTP health check request. The default value is 80.
Project Changes to this property will trigger replacement. string
RequestId string
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
RequestPath string
The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986.
TimeoutSec int
How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
UnhealthyThreshold int
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
CheckIntervalSec int
How often (in seconds) to send a health check. The default value is 5 seconds.
Description string
An optional description of this resource. Provide this property when you create the resource.
HealthyThreshold int
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
Host string
The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
Name string
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
Port int
The TCP port number for the HTTP health check request. The default value is 80.
Project Changes to this property will trigger replacement. string
RequestId string
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
RequestPath string
The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986.
TimeoutSec int
How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
UnhealthyThreshold int
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
checkIntervalSec Integer
How often (in seconds) to send a health check. The default value is 5 seconds.
description String
An optional description of this resource. Provide this property when you create the resource.
healthyThreshold Integer
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
host String
The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
name String
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
port Integer
The TCP port number for the HTTP health check request. The default value is 80.
project Changes to this property will trigger replacement. String
requestId String
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
requestPath String
The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986.
timeoutSec Integer
How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
unhealthyThreshold Integer
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
checkIntervalSec number
How often (in seconds) to send a health check. The default value is 5 seconds.
description string
An optional description of this resource. Provide this property when you create the resource.
healthyThreshold number
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
host string
The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
name string
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
port number
The TCP port number for the HTTP health check request. The default value is 80.
project Changes to this property will trigger replacement. string
requestId string
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
requestPath string
The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986.
timeoutSec number
How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
unhealthyThreshold number
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
check_interval_sec int
How often (in seconds) to send a health check. The default value is 5 seconds.
description str
An optional description of this resource. Provide this property when you create the resource.
healthy_threshold int
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
host str
The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
name str
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
port int
The TCP port number for the HTTP health check request. The default value is 80.
project Changes to this property will trigger replacement. str
request_id str
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
request_path str
The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986.
timeout_sec int
How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
unhealthy_threshold int
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
checkIntervalSec Number
How often (in seconds) to send a health check. The default value is 5 seconds.
description String
An optional description of this resource. Provide this property when you create the resource.
healthyThreshold Number
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
host String
The value of the host header in the HTTP health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
name String
Name of the resource. Provided by the client when the resource is created. The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression [a-z]([-a-z0-9]*[a-z0-9])? which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash.
port Number
The TCP port number for the HTTP health check request. The default value is 80.
project Changes to this property will trigger replacement. String
requestId String
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported ( 00000000-0000-0000-0000-000000000000).
requestPath String
The request path of the HTTP health check request. The default value is /. This field does not support query parameters. Must comply with RFC3986.
timeoutSec Number
How long (in seconds) to wait before claiming failure. The default value is 5 seconds. It is invalid for timeoutSec to have greater value than checkIntervalSec.
unhealthyThreshold Number
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Outputs

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

CreationTimestamp string
Creation timestamp in RFC3339 text format.
Id string
The provider-assigned unique ID for this managed resource.
Kind string
Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
SelfLink string
Server-defined URL for the resource.
CreationTimestamp string
Creation timestamp in RFC3339 text format.
Id string
The provider-assigned unique ID for this managed resource.
Kind string
Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
SelfLink string
Server-defined URL for the resource.
creationTimestamp String
Creation timestamp in RFC3339 text format.
id String
The provider-assigned unique ID for this managed resource.
kind String
Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
selfLink String
Server-defined URL for the resource.
creationTimestamp string
Creation timestamp in RFC3339 text format.
id string
The provider-assigned unique ID for this managed resource.
kind string
Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
selfLink string
Server-defined URL for the resource.
creation_timestamp str
Creation timestamp in RFC3339 text format.
id str
The provider-assigned unique ID for this managed resource.
kind str
Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
self_link str
Server-defined URL for the resource.
creationTimestamp String
Creation timestamp in RFC3339 text format.
id String
The provider-assigned unique ID for this managed resource.
kind String
Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
selfLink String
Server-defined URL for the resource.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native