health_check#
State module for managing HealthChecks.
- async idem_gcp.states.gcp.compute.health_check.present(hub, ctx, name: str, resource_id: str = None, request_id: str = None, project: str = None, health_check: str = None, ssl_health_check: ~types.SSLHealthCheck = None, https_health_check: ~types.HTTPSHealthCheck = None, type_: (<class 'str'>, 'alias=type') = None, description: str = None, http2_health_check: ~types.HTTP2HealthCheck = None, tcp_health_check: ~types.TCPHealthCheck = None, check_interval_sec: int = None, unhealthy_threshold: int = None, timeout_sec: int = None, log_config: ~types.HealthCheckLogConfig = None, grpc_health_check: ~types.GRPCHealthCheck = None, http_health_check: ~types.HTTPHealthCheck = None, healthy_threshold: int = None) Dict[str, Any][source]#
Creates or updates a HealthCheck resource in the specified project using the data included in the request.
- Parameters:
name (str) – An Idem name of the resource.
resource_id (str, Optional) – An identifier of the resource in the provider. Defaults to None.
request_id (str, Optional) – 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). Defaults to None.
project (str) – Project ID for this request.
ssl_health_check (Dict[str, Any], Optional) –
Defaults to None.
- port_name(str, Optional):
Not supported.
- response(str, Optional):
Creates a content-based SSL health check. In addition to establishing a TCP connection and the TLS handshake, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp
- proxy_header(str, Optional):
Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE.
- port_specification(str, Optional):
Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service’s named port in the instance group’s list of named ports. Enum type. Allowed values:
”USE_FIXED_PORT” - The port number in the health check’s port is used for health checking. Applies to network endpoint group and instance group backends. “USE_NAMED_PORT” - Not supported. “USE_SERVING_PORT” - For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service’s named port defined in the instance group’s named ports.
- port(int, Optional):
The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.
- request(str, Optional):
Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection and SSL handshake.
https_health_check (Dict[str, Any], Optional) –
Defaults to None.
- host(str, Optional):
The value of the host header in the HTTPS health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest
- port_specification (str, Optional):
Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service’s named port in the instance group’s list of named ports. Enum type. Allowed values:
”USE_FIXED_PORT” - The port number in the health check’s port is used for health checking. Applies to network endpoint group and instance group backends. “USE_NAMED_PORT” - Not supported. “USE_SERVING_PORT” - For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service’s named port defined in the instance group’s named ports.
- port_name (str, Optional):
Not supported.
- proxy_header (str, Optional):
Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Enum type. Allowed values:
”NONE” “PROXY_V1”
- request_path (str, Optional):
The request path of the HTTPS health check request. The default value is /.
- port (int, Optional):
The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.
- response (str, Optional):
Creates a content-based HTTPS health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http
type (str, Optional) –
Specifies the type of the healthCheck, either TCP, SSL, HTTP, HTTPS, HTTP2 or GRPC. Exactly one of the protocol-specific health check fields must be specified, which must match type field. Enum type. Allowed values:
”GRPC” “HTTP” “HTTP2” “HTTPS” “INVALID” “SSL” “TCP”. Defaults to None.
description (str, Optional) – An optional description of this resource. Provide this property when you create the resource. Defaults to None.
http2_health_check (Dict[str, Any], Optional) –
Defaults to None.
- port_specification (str, Optional):
Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service’s named port in the instance group’s list of named ports. Enum type. Allowed values:
”USE_FIXED_PORT” - The port number in the health check’s port is used for health checking. Applies to network endpoint group and instance group backends. “USE_NAMED_PORT” - Not supported. “USE_SERVING_PORT” - For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service’s named port defined in the instance group’s named ports.
- port (int, Optional):
The TCP port number to which the health check prober sends packets. The default value is 443. Valid values are 1 through 65535.
- port_name (str, Optional):
Not supported.
- request_path (str, Optional):
The request path of the HTTP/2 health check request. The default value is /.
- proxy_header (str, Optional):
Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Enum type. Allowed values:
”NONE” “PROXY_V1”
- response (str, Optional):
Creates a content-based HTTP/2 health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http
- host (str, Optional):
The value of the host header in the HTTP/2 health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest
tcp_health_check (Dict[str, Any], Optional) –
Defaults to None.
- proxy_header (str, Optional):
Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Enum type. Allowed values:
”NONE” “PROXY_V1”
- port_specification (str, Optional):
Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service’s named port in the instance group’s list of named ports. Enum type. Allowed values:
”USE_FIXED_PORT” - The port number in the health check’s port is used for health checking. Applies to network endpoint group and instance group backends. “USE_NAMED_PORT” - Not supported. “USE_SERVING_PORT” - For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service’s named port defined in the instance group’s named ports.
- response (str, Optional):
Creates a content-based TCP health check. In addition to establishing a TCP connection, you can configure the health check to pass only when the backend sends this exact response ASCII string, up to 1024 bytes in length. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-ssl-tcp
- request (str, Optional):
Instructs the health check prober to send this exact ASCII string, up to 1024 bytes in length, after establishing the TCP connection.
- port_name (str, Optional):
Not supported.
- port (int, Optional):
The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535.
check_interval_sec (int, Optional) – How often (in seconds) to send a health check. The default value is 5 seconds. Defaults to None.
unhealthy_threshold (int, Optional) – A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2. Defaults to None.
timeout_sec (int, Optional) – 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. Defaults to None.
log_config (Dict[str, Any], Optional) –
Configure logging on this health check. HealthCheckLogConfig: Configuration of logging on a health check. If logging is enabled, logs will be exported to Stackdriver. Defaults to None.
- enable (bool, Optional):
Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.
grpc_health_check (Dict[str, Any], Optional) –
Defaults to None.
- port_specification (str, Optional):
Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Not supported by target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service’s named port in the instance group’s list of named ports. Enum type. Allowed values:
”USE_FIXED_PORT” - The port number in the health check’s port is used for health checking. Applies to network endpoint group and instance group backends. “USE_NAMED_PORT” - Not supported. “USE_SERVING_PORT” - For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service’s named port defined in the instance group’s named ports.
- grpc_service_name (str, Optional):
The gRPC service name for the health check. This field is optional. The value of grpc_service_name has the following meanings by convention: - Empty service_name means the overall status of all services at the backend. - Non-empty service_name means the health of that gRPC service, as defined by the owner of the service. The grpc_service_name can only be ASCII.
- port_name (str, Optional):
Not supported.
- port (int, Optional):
The TCP port number to which the health check prober sends packets. Valid values are 1 through 65535.
http_health_check (Dict[str, Any], Optional) –
Defaults to None.
- request_path (str, Optional):
The request path of the HTTP health check request. The default value is /.
- port (int, Optional):
The TCP port number to which the health check prober sends packets. The default value is 80. Valid values are 1 through 65535.
- host (str, Optional):
The value of the host header in the HTTP health check request. If left empty (default value), the host header is set to the destination IP address to which health check packets are sent. The destination IP address depends on the type of load balancer. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#hc-packet-dest
- response (str, Optional):
Creates a content-based HTTP health check. In addition to the required HTTP 200 (OK) status code, you can configure the health check to pass only when the backend sends this specific ASCII response string within the first 1024 bytes of the HTTP response body. For details, see: https://cloud.google.com/load-balancing/docs/health-check-concepts#criteria-protocol-http
- port_specification (str, Optional):
Specifies how a port is selected for health checking. Can be one of the following values: USE_FIXED_PORT: Specifies a port number explicitly using the port field in the health check. Supported by backend services for pass-through load balancers and backend services for proxy load balancers. Also supported in legacy HTTP health checks for target pools. The health check supports all backends supported by the backend service provided the backend can be health checked. For example, GCE_VM_IP network endpoint groups, GCE_VM_IP_PORT network endpoint groups, and instance group backends. USE_NAMED_PORT: Not supported. USE_SERVING_PORT: Provides an indirect method of specifying the health check port by referring to the backend service. Only supported by backend services for proxy load balancers. Not supported by target pools. Not supported by backend services for pass-through load balancers. Supports all backends that can be health checked; for example, GCE_VM_IP_PORT network endpoint groups and instance group backends. For GCE_VM_IP_PORT network endpoint group backends, the health check uses the port number specified for each endpoint in the network endpoint group. For instance group backends, the health check uses the port number determined by looking up the backend service’s named port in the instance group’s list of named ports. Enum type. Allowed values:
”USE_FIXED_PORT” - The port number in the health check’s port is used for health checking. Applies to network endpoint group and instance group backends. “USE_NAMED_PORT” - Not supported. “USE_SERVING_PORT” - For network endpoint group backends, the health check uses the port number specified on each endpoint in the network endpoint group. For instance group backends, the health check uses the port number specified for the backend service’s named port defined in the instance group’s named ports.
- port_name (str, Optional):
Not supported.
- proxy_header (str, Optional):
Specifies the type of proxy header to append before sending data to the backend, either NONE or PROXY_V1. The default is NONE. Enum type. Allowed values:
”NONE” “PROXY_V1”
healthy_threshold (int, Optional) – A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2. Defaults to None.
health_check (str) – Name of the HealthCheck resource to return.
- Returns:
Dict[str, Any]
Examples
resource_is_present: gcp.compute.health_check.present: - name: value - project: value - type_: TCP - tcp_health_check: port: 80
- async idem_gcp.states.gcp.compute.health_check.describe(hub, ctx) Dict[str, Dict[str, Any]][source]#
Describe the resource in a way that can be recreated/managed with the corresponding “present” function.
Retrieves the list of HealthCheck resources available to the specified project.
- Returns:
Dict[str, Any]
Examples
$ idem describe gcp.compute.health_check