Parameter |
Choices/Defaults |
Comments |
auth_kind
string
/ required
|
Choices:
- application
- machineaccount
- serviceaccount
|
The type of credential used.
|
check_interval_sec
integer
|
Default:
"5"
|
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.
|
env_type
string
|
|
Specifies which Ansible environment you're running this module within.
This should not be set unless you know what you're doing.
This only alters the User Agent string for any API requests.
|
grpc_health_check
dictionary
|
|
A nested object resource.
|
|
grpc_service_name
string
|
|
The gRPC service name for the health check. The value of grpcServiceName has the following meanings by convention: * Empty serviceName means the overall status of all services at the backend.
* Non-empty serviceName means the health of that gRPC service, as defined by the owner of the service.
The grpcServiceName can only be ASCII.
|
|
port
integer
|
|
The port number for the health check request. Must be specified if portName and portSpecification are not set or if port_specification is USE_FIXED_PORT. Valid values are 1 through 65535.
|
|
port_name
string
|
|
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
|
|
port_specification
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, gRPC health check follows behavior specified in `port` and `portName` fields.
Some valid choices include: "USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"
|
healthy_threshold
integer
|
Default:
"2"
|
A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.
|
http2_health_check
dictionary
|
|
A nested object resource.
|
|
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
integer
|
|
The TCP port number for the HTTP2 health check request.
The default value is 443.
|
|
port_name
string
|
|
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
|
|
port_specification
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.
Some valid choices include: "USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"
|
|
proxy_header
string
|
Default:
"NONE"
|
Specifies the type of proxy header to append before sending data to the backend.
Some valid choices include: "NONE", "PROXY_V1"
|
|
request_path
string
|
Default:
"/"
|
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.
|
http_health_check
dictionary
|
|
A nested object resource.
|
|
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.
|
|
port
integer
|
|
The TCP port number for the HTTP health check request.
The default value is 80.
|
|
port_name
string
|
|
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
|
|
port_specification
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, HTTP health check follows behavior specified in `port` and `portName` fields.
Some valid choices include: "USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"
|
|
proxy_header
string
|
Default:
"NONE"
|
Specifies the type of proxy header to append before sending data to the backend.
Some valid choices include: "NONE", "PROXY_V1"
|
|
request_path
string
|
Default:
"/"
|
The request path of the HTTP 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.
|
https_health_check
dictionary
|
|
A nested object resource.
|
|
host
string
|
|
The value of the host header in the HTTPS health check request.
If left empty (default value), the public IP on behalf of which this health check is performed will be used.
|
|
port
integer
|
|
The TCP port number for the HTTPS health check request.
The default value is 443.
|
|
port_name
string
|
|
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
|
|
port_specification
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, HTTPS health check follows behavior specified in `port` and `portName` fields.
Some valid choices include: "USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"
|
|
proxy_header
string
|
Default:
"NONE"
|
Specifies the type of proxy header to append before sending data to the backend.
Some valid choices include: "NONE", "PROXY_V1"
|
|
request_path
string
|
Default:
"/"
|
The request path of the HTTPS 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.
|
name
string
/ required
|
|
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.
|
project
string
|
|
The Google Cloud Platform project to use.
|
region
string
|
|
The region where the regional health check resides.
|
scopes
list
/ elements=string
|
|
Array of scopes to be used
|
service_account_contents
jsonarg
|
|
The contents of a Service Account JSON file, either in a dictionary or as a JSON string that represents it.
|
service_account_email
string
|
|
An optional service account email address if machineaccount is selected and the user does not wish to use the default email.
|
service_account_file
path
|
|
The path of a Service Account JSON file if serviceaccount is selected as type.
|
ssl_health_check
dictionary
|
|
A nested object resource.
|
|
port
integer
|
|
The TCP port number for the SSL health check request.
The default value is 443.
|
|
port_name
string
|
|
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
|
|
port_specification
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, SSL health check follows behavior specified in `port` and `portName` fields.
Some valid choices include: "USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"
|
|
proxy_header
string
|
Default:
"NONE"
|
Specifies the type of proxy header to append before sending data to the backend.
Some valid choices include: "NONE", "PROXY_V1"
|
|
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.
|
state
string
|
Choices:
present ←
- absent
|
Whether the given object should exist in GCP
|
tcp_health_check
dictionary
|
|
A nested object resource.
|
|
port
integer
|
|
The TCP port number for the TCP health check request.
The default value is 80.
|
|
port_name
string
|
|
Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
|
|
port_specification
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, TCP health check follows behavior specified in `port` and `portName` fields.
Some valid choices include: "USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"
|
|
proxy_header
string
|
Default:
"NONE"
|
Specifies the type of proxy header to append before sending data to the backend.
Some valid choices include: "NONE", "PROXY_V1"
|
|
request
string
|
|
The application data to send once the TCP 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.
|
timeout_sec
integer
|
Default:
"5"
|
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
|
|
Specifies the type of the healthCheck, either TCP, SSL, HTTP or HTTPS. If not specified, the default is TCP. Exactly one of the protocol-specific health check field must be specified, which must match type field.
Some valid choices include: "TCP", "SSL", "HTTP", "HTTPS", "HTTP2"
|
unhealthy_threshold
integer
|
Default:
"2"
|
A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.
|