google-native.compute/v1.getHttpHealthCheck

Explore with Pulumi AI

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

Google Cloud Native v0.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

Using getHttpHealthCheck

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 getHttpHealthCheck(args: GetHttpHealthCheckArgs, opts?: InvokeOptions): Promise<GetHttpHealthCheckResult>
function getHttpHealthCheckOutput(args: GetHttpHealthCheckOutputArgs, opts?: InvokeOptions): Output<GetHttpHealthCheckResult>

def get_http_health_check(http_health_check: Optional[str] = None,
                          project: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetHttpHealthCheckResult
def get_http_health_check_output(http_health_check: Optional[pulumi.Input[str]] = None,
                          project: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetHttpHealthCheckResult]

func LookupHttpHealthCheck(ctx *Context, args *LookupHttpHealthCheckArgs, opts ...InvokeOption) (*LookupHttpHealthCheckResult, error)
func LookupHttpHealthCheckOutput(ctx *Context, args *LookupHttpHealthCheckOutputArgs, opts ...InvokeOption) LookupHttpHealthCheckResultOutput

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

public static class GetHttpHealthCheck 
{
    public static Task<GetHttpHealthCheckResult> InvokeAsync(GetHttpHealthCheckArgs args, InvokeOptions? opts = null)
    public static Output<GetHttpHealthCheckResult> Invoke(GetHttpHealthCheckInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetHttpHealthCheckResult> getHttpHealthCheck(GetHttpHealthCheckArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: google-native:compute/v1:getHttpHealthCheck
  arguments:
    # arguments dictionary

The following arguments are supported:

HttpHealthCheck string
Project string

HttpHealthCheck string
Project string

httpHealthCheck String
project String

httpHealthCheck string
project string

http_health_check str
project str

httpHealthCheck String
project String

getHttpHealthCheck Result

The following output properties are available:

CheckIntervalSec int: How often (in seconds) to send a health check. The default value is 5 seconds.
CreationTimestamp string: Creation timestamp in RFC3339 text format.
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.
Kind string: Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
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.
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.
SelfLink string: Server-defined URL for the resource.
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.
CreationTimestamp string: Creation timestamp in RFC3339 text format.
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.
Kind string: Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
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.
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.
SelfLink string: Server-defined URL for the resource.
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.
creationTimestamp String: Creation timestamp in RFC3339 text format.
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.
kind String: Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
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.
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.
selfLink String: Server-defined URL for the resource.
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.
creationTimestamp string: Creation timestamp in RFC3339 text format.
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.
kind string: Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
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.
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.
selfLink string: Server-defined URL for the resource.
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.
creation_timestamp str: Creation timestamp in RFC3339 text format.
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.
kind str: Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
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.
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.
self_link str: Server-defined URL for the resource.
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.
creationTimestamp String: Creation timestamp in RFC3339 text format.
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.
kind String: Type of the resource. Always compute#httpHealthCheck for HTTP health checks.
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.
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.
selfLink String: Server-defined URL for the resource.
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.

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.31.1 published on Thursday, Jul 20, 2023 by Pulumi

pulumi/pulumi-google-native

google-native.compute/v1.getHttpHealthCheck

On this page

On this page

Using getHttpHealthCheck

getHttpHealthCheck Result

Package Details

On this page

On this page