Google Native

v0.26.0 published on Friday, Sep 16, 2022 by Pulumi

HttpHealthCheck

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

Create a HttpHealthCheck Resource

new HttpHealthCheck(name: string, args?: HttpHealthCheckArgs, opts?: CustomResourceOptions);
@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)
@overload
def HttpHealthCheck(resource_name: str,
                    args: Optional[HttpHealthCheckArgs] = None,
                    opts: Optional[ResourceOptions] = 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/alpha:HttpHealthCheck
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name 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 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 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 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 String
The unique name of the resource.
args HttpHealthCheckArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

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 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.

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 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.

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 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.

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 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.

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 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.

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 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.

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.

SelfLinkWithId string

Server-defined URL for this resource with the resource id.

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.

SelfLinkWithId string

Server-defined URL for this resource with the resource id.

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.

selfLinkWithId String

Server-defined URL for this resource with the resource id.

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.

selfLinkWithId string

Server-defined URL for this resource with the resource id.

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.

self_link_with_id str

Server-defined URL for this resource with the resource id.

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.

selfLinkWithId String

Server-defined URL for this resource with the resource id.

Package Details

Repository
https://github.com/pulumi/pulumi-google-native
License
Apache-2.0