HealthCheck

Health Checks determine whether instances are responsive and able to do work. They are an important part of a comprehensive load balancing configuration, as they enable monitoring instances behind load balancers.

Health Checks poll instances at a specified interval. Instances that do not respond successfully to some number of probes in a row are marked as unhealthy. No new connections are sent to unhealthy instances, though existing connections will continue. The health check will continue to poll unhealthy instances. If an instance later responds successfully to some number of consecutive probes, it is marked healthy again and can receive new connections.

To get more information about HealthCheck, see:

API documentation
How-to Guides
- Official Documentation

Create a HealthCheck Resource

new HealthCheck(name: string, args?: HealthCheckArgs, opts?: CustomResourceOptions);

def HealthCheck(resource_name, opts=None, check_interval_sec=None, description=None, healthy_threshold=None, http2_health_check=None, http_health_check=None, https_health_check=None, log_config=None, name=None, project=None, ssl_health_check=None, tcp_health_check=None, timeout_sec=None, unhealthy_threshold=None, __props__=None);

func NewHealthCheck(ctx *Context, name string, args *HealthCheckArgs, opts ...ResourceOption) (*HealthCheck, error)

public HealthCheck(string name, HealthCheckArgs? args = null, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args HealthCheckArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args HealthCheckArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args HealthCheckArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

HealthCheck Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The HealthCheck 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.
Http2HealthCheck HealthCheckHttp2HealthCheckArgs: A nested object resource Structure is documented below.
HttpHealthCheck HealthCheckHttpHealthCheckArgs: A nested object resource Structure is documented below.
HttpsHealthCheck HealthCheckHttpsHealthCheckArgs: A nested object resource Structure is documented below.
LogConfig HealthCheckLogConfigArgs: Configure logging on this health check. Structure is documented below.
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? 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.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SslHealthCheck HealthCheckSslHealthCheckArgs: A nested object resource Structure is documented below.
TcpHealthCheck HealthCheckTcpHealthCheckArgs: A nested object resource Structure is documented below.
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.
Http2HealthCheck HealthCheckHttp2HealthCheck: A nested object resource Structure is documented below.
HttpHealthCheck HealthCheckHttpHealthCheck: A nested object resource Structure is documented below.
HttpsHealthCheck HealthCheckHttpsHealthCheck: A nested object resource Structure is documented below.
LogConfig HealthCheckLogConfig: Configure logging on this health check. Structure is documented below.
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? 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.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SslHealthCheck HealthCheckSslHealthCheck: A nested object resource Structure is documented below.
TcpHealthCheck HealthCheckTcpHealthCheck: A nested object resource Structure is documented below.
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 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.
http2HealthCheck HealthCheckHttp2HealthCheck: A nested object resource Structure is documented below.
httpHealthCheck HealthCheckHttpHealthCheck: A nested object resource Structure is documented below.
httpsHealthCheck HealthCheckHttpsHealthCheck: A nested object resource Structure is documented below.
logConfig HealthCheckLogConfig: Configure logging on this health check. Structure is documented below.
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? 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.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
sslHealthCheck HealthCheckSslHealthCheck: A nested object resource Structure is documented below.
tcpHealthCheck HealthCheckTcpHealthCheck: A nested object resource Structure is documented below.
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 float: 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 float: A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
http2_health_check Dict[HealthCheckHttp2HealthCheck]: A nested object resource Structure is documented below.
http_health_check Dict[HealthCheckHttpHealthCheck]: A nested object resource Structure is documented below.
https_health_check Dict[HealthCheckHttpsHealthCheck]: A nested object resource Structure is documented below.
log_config Dict[HealthCheckLogConfig]: Configure logging on this health check. Structure is documented below.
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? 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.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
ssl_health_check Dict[HealthCheckSslHealthCheck]: A nested object resource Structure is documented below.
tcp_health_check Dict[HealthCheckTcpHealthCheck]: A nested object resource Structure is documented below.
timeout_sec float: 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 float: 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 HealthCheck 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.
SelfLink string: The URI of the created resource.
Type string: The type of the health check. One of HTTP, HTTPS, TCP, or SSL.

CreationTimestamp string: Creation timestamp in RFC3339 text format.
Id string: The provider-assigned unique ID for this managed resource.
SelfLink string: The URI of the created resource.
Type string: The type of the health check. One of HTTP, HTTPS, TCP, or SSL.

creationTimestamp string: Creation timestamp in RFC3339 text format.
id string: The provider-assigned unique ID for this managed resource.
selfLink string: The URI of the created resource.
type string: The type of the health check. One of HTTP, HTTPS, TCP, or SSL.

creation_timestamp str: Creation timestamp in RFC3339 text format.
id str: The provider-assigned unique ID for this managed resource.
self_link str: The URI of the created resource.
type str: The type of the health check. One of HTTP, HTTPS, TCP, or SSL.

Look up an Existing HealthCheck Resource

Get an existing HealthCheck 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?: HealthCheckState, opts?: CustomResourceOptions): HealthCheck

static get(resource_name, id, opts=None, check_interval_sec=None, creation_timestamp=None, description=None, healthy_threshold=None, http2_health_check=None, http_health_check=None, https_health_check=None, log_config=None, name=None, project=None, self_link=None, ssl_health_check=None, tcp_health_check=None, timeout_sec=None, type=None, unhealthy_threshold=None, __props__=None);

func GetHealthCheck(ctx *Context, name string, id IDInput, state *HealthCheckState, opts ...ResourceOption) (*HealthCheck, error)

public static HealthCheck Get(string name, Input<string> id, HealthCheckState? state, CustomResourceOptions? opts = null)

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.

The following state arguments are supported:

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.
Http2HealthCheck HealthCheckHttp2HealthCheckArgs: A nested object resource Structure is documented below.
HttpHealthCheck HealthCheckHttpHealthCheckArgs: A nested object resource Structure is documented below.
HttpsHealthCheck HealthCheckHttpsHealthCheckArgs: A nested object resource Structure is documented below.
LogConfig HealthCheckLogConfigArgs: Configure logging on this health check. Structure is documented below.
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? 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.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SelfLink string: The URI of the created resource.
SslHealthCheck HealthCheckSslHealthCheckArgs: A nested object resource Structure is documented below.
TcpHealthCheck HealthCheckTcpHealthCheckArgs: A nested object resource Structure is documented below.
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.
Type string: The type of the health check. One of HTTP, HTTPS, TCP, or SSL.
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.
Http2HealthCheck HealthCheckHttp2HealthCheck: A nested object resource Structure is documented below.
HttpHealthCheck HealthCheckHttpHealthCheck: A nested object resource Structure is documented below.
HttpsHealthCheck HealthCheckHttpsHealthCheck: A nested object resource Structure is documented below.
LogConfig HealthCheckLogConfig: Configure logging on this health check. Structure is documented below.
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? 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.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SelfLink string: The URI of the created resource.
SslHealthCheck HealthCheckSslHealthCheck: A nested object resource Structure is documented below.
TcpHealthCheck HealthCheckTcpHealthCheck: A nested object resource Structure is documented below.
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.
Type string: The type of the health check. One of HTTP, HTTPS, TCP, or SSL.
UnhealthyThreshold 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.
http2HealthCheck HealthCheckHttp2HealthCheck: A nested object resource Structure is documented below.
httpHealthCheck HealthCheckHttpHealthCheck: A nested object resource Structure is documented below.
httpsHealthCheck HealthCheckHttpsHealthCheck: A nested object resource Structure is documented below.
logConfig HealthCheckLogConfig: Configure logging on this health check. Structure is documented below.
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? 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.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
selfLink string: The URI of the created resource.
sslHealthCheck HealthCheckSslHealthCheck: A nested object resource Structure is documented below.
tcpHealthCheck HealthCheckTcpHealthCheck: A nested object resource Structure is documented below.
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.
type string: The type of the health check. One of HTTP, HTTPS, TCP, or SSL.
unhealthyThreshold number: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

check_interval_sec float: 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 float: A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
http2_health_check Dict[HealthCheckHttp2HealthCheck]: A nested object resource Structure is documented below.
http_health_check Dict[HealthCheckHttpHealthCheck]: A nested object resource Structure is documented below.
https_health_check Dict[HealthCheckHttpsHealthCheck]: A nested object resource Structure is documented below.
log_config Dict[HealthCheckLogConfig]: Configure logging on this health check. Structure is documented below.
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? 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.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
self_link str: The URI of the created resource.
ssl_health_check Dict[HealthCheckSslHealthCheck]: A nested object resource Structure is documented below.
tcp_health_check Dict[HealthCheckTcpHealthCheck]: A nested object resource Structure is documented below.
timeout_sec float: 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.
type str: The type of the health check. One of HTTP, HTTPS, TCP, or SSL.
unhealthy_threshold float: A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Supporting Types

HealthCheckHttp2HealthCheck

See the input and output API doc for this type.

Host string: The value of the host header in the HTTP2 health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
Port int: The TCP port number for the HTTP2 health check request. The default value is 443.
PortName string: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
PortSpecification string: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
ProxyHeader string: Specifies the type of proxy header to append before sending data to the backend.
RequestPath string: The request path of the HTTP2 health check request. The default value is /.
Response string: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

Host string: The value of the host header in the HTTP2 health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
Port int: The TCP port number for the HTTP2 health check request. The default value is 443.
PortName string: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
PortSpecification string: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
ProxyHeader string: Specifies the type of proxy header to append before sending data to the backend.
RequestPath string: The request path of the HTTP2 health check request. The default value is /.
Response string: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

host string: The value of the host header in the HTTP2 health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
port number: The TCP port number for the HTTP2 health check request. The default value is 443.
portName string: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
portSpecification string: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
proxyHeader string: Specifies the type of proxy header to append before sending data to the backend.
requestPath string: The request path of the HTTP2 health check request. The default value is /.
response string: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

host str: The value of the host header in the HTTP2 health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
port float: The TCP port number for the HTTP2 health check request. The default value is 443.
portSpecification str: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
port_name str: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
proxy_header str: Specifies the type of proxy header to append before sending data to the backend.
request_path str: The request path of the HTTP2 health check request. The default value is /.
response str: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

HealthCheckHttpHealthCheck

See the input and output API doc for this type.

Host string: The value of the host header in the HTTP2 health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
Port int: The TCP port number for the HTTP2 health check request. The default value is 443.
PortName string: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
PortSpecification string: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
ProxyHeader string: Specifies the type of proxy header to append before sending data to the backend.
RequestPath string: The request path of the HTTP2 health check request. The default value is /.
Response string: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

Host string: The value of the host header in the HTTP2 health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
Port int: The TCP port number for the HTTP2 health check request. The default value is 443.
PortName string: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
PortSpecification string: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
ProxyHeader string: Specifies the type of proxy header to append before sending data to the backend.
RequestPath string: The request path of the HTTP2 health check request. The default value is /.
Response string: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

host string: The value of the host header in the HTTP2 health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
port number: The TCP port number for the HTTP2 health check request. The default value is 443.
portName string: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
portSpecification string: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
proxyHeader string: Specifies the type of proxy header to append before sending data to the backend.
requestPath string: The request path of the HTTP2 health check request. The default value is /.
response string: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

host str: The value of the host header in the HTTP2 health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
port float: The TCP port number for the HTTP2 health check request. The default value is 443.
portSpecification str: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
port_name str: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
proxy_header str: Specifies the type of proxy header to append before sending data to the backend.
request_path str: The request path of the HTTP2 health check request. The default value is /.
response str: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

HealthCheckHttpsHealthCheck

See the input and output API doc for this type.

Host string: The value of the host header in the HTTP2 health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
Port int: The TCP port number for the HTTP2 health check request. The default value is 443.
PortName string: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
PortSpecification string: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
ProxyHeader string: Specifies the type of proxy header to append before sending data to the backend.
RequestPath string: The request path of the HTTP2 health check request. The default value is /.
Response string: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

Host string: The value of the host header in the HTTP2 health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
Port int: The TCP port number for the HTTP2 health check request. The default value is 443.
PortName string: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
PortSpecification string: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
ProxyHeader string: Specifies the type of proxy header to append before sending data to the backend.
RequestPath string: The request path of the HTTP2 health check request. The default value is /.
Response string: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

host string: The value of the host header in the HTTP2 health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
port number: The TCP port number for the HTTP2 health check request. The default value is 443.
portName string: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
portSpecification string: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
proxyHeader string: Specifies the type of proxy header to append before sending data to the backend.
requestPath string: The request path of the HTTP2 health check request. The default value is /.
response string: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

host str: The value of the host header in the HTTP2 health check request. If left empty (default value), the public IP on behalf of which this health check is performed will be used.
port float: The TCP port number for the HTTP2 health check request. The default value is 443.
portSpecification str: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
port_name str: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
proxy_header str: Specifies the type of proxy header to append before sending data to the backend.
request_path str: The request path of the HTTP2 health check request. The default value is /.
response str: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

HealthCheckLogConfig

See the input and output API doc for this type.

Enable bool: Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.

Enable bool: Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.

enable boolean: Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.

enable bool: Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.

HealthCheckSslHealthCheck

See the input and output API doc for this type.

Port int: The TCP port number for the HTTP2 health check request. The default value is 443.
PortName string: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
PortSpecification string: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
ProxyHeader string: Specifies the type of proxy header to append before sending data to the backend.
Request string: The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
Response string: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

Port int: The TCP port number for the HTTP2 health check request. The default value is 443.
PortName string: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
PortSpecification string: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
ProxyHeader string: Specifies the type of proxy header to append before sending data to the backend.
Request string: The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
Response string: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

port number: The TCP port number for the HTTP2 health check request. The default value is 443.
portName string: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
portSpecification string: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
proxyHeader string: Specifies the type of proxy header to append before sending data to the backend.
request string: The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
response string: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

port float: The TCP port number for the HTTP2 health check request. The default value is 443.
portSpecification str: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
port_name str: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
proxy_header str: Specifies the type of proxy header to append before sending data to the backend.
request str: The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
response str: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

HealthCheckTcpHealthCheck

See the input and output API doc for this type.

Port int: The TCP port number for the HTTP2 health check request. The default value is 443.
PortName string: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
PortSpecification string: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
ProxyHeader string: Specifies the type of proxy header to append before sending data to the backend.
Request string: The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
Response string: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

Port int: The TCP port number for the HTTP2 health check request. The default value is 443.
PortName string: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
PortSpecification string: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
ProxyHeader string: Specifies the type of proxy header to append before sending data to the backend.
Request string: The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
Response string: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

port number: The TCP port number for the HTTP2 health check request. The default value is 443.
portName string: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
portSpecification string: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
proxyHeader string: Specifies the type of proxy header to append before sending data to the backend.
request string: The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
response string: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

port float: The TCP port number for the HTTP2 health check request. The default value is 443.
portSpecification str: Specifies how port is selected for health checking, can be one of the following values: * USE_FIXED_PORT: The port number in port is used for health checking. * USE_NAMED_PORT: The portName is used for health checking. * USE_SERVING_PORT: For NetworkEndpointGroup, the port specified for each network endpoint is used for health checking. For other backends, the port or named port specified in the Backend Service is used for health checking. If not specified, HTTP2 health check follows behavior specified in port and portName fields.
port_name str: Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
proxy_header str: Specifies the type of proxy header to append before sending data to the backend.
request str: The application data to send once the SSL connection has been established (default value is empty). If both request and response are empty, the connection establishment alone will indicate health. The request data can only be ASCII.
response str: The bytes to match against the beginning of the response data. If left empty (the default value), any response will indicate health. The response data can only be ASCII.

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

HealthCheck

Create a HealthCheck Resource

HealthCheck Resource Properties

Inputs

Outputs

Look up an Existing HealthCheck Resource

Supporting Types

HealthCheckHttp2HealthCheck

HealthCheckHttpHealthCheck

HealthCheckHttpsHealthCheck

HealthCheckLogConfig

HealthCheckSslHealthCheck

HealthCheckTcpHealthCheck

Package Details

On This Page