1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. compute
  5. getHealthCheck
Google Cloud Classic v7.28.0 published on Friday, Jun 21, 2024 by Pulumi

gcp.compute.getHealthCheck

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.28.0 published on Friday, Jun 21, 2024 by Pulumi

    Get information about a HealthCheck.

    Example Usage

    data "google_compute_health_check" "health_check" {
      name = "my-hc"
    }
    

    Using getHealthCheck

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getHealthCheck(args: GetHealthCheckArgs, opts?: InvokeOptions): Promise<GetHealthCheckResult>
    function getHealthCheckOutput(args: GetHealthCheckOutputArgs, opts?: InvokeOptions): Output<GetHealthCheckResult>
    def get_health_check(name: Optional[str] = None,
                         project: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetHealthCheckResult
    def get_health_check_output(name: Optional[pulumi.Input[str]] = None,
                         project: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetHealthCheckResult]
    func LookupHealthCheck(ctx *Context, args *LookupHealthCheckArgs, opts ...InvokeOption) (*LookupHealthCheckResult, error)
    func LookupHealthCheckOutput(ctx *Context, args *LookupHealthCheckOutputArgs, opts ...InvokeOption) LookupHealthCheckResultOutput

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

    public static class GetHealthCheck 
    {
        public static Task<GetHealthCheckResult> InvokeAsync(GetHealthCheckArgs args, InvokeOptions? opts = null)
        public static Output<GetHealthCheckResult> Invoke(GetHealthCheckInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetHealthCheckResult> getHealthCheck(GetHealthCheckArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: gcp:compute/getHealthCheck:getHealthCheck
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    Name of the resource.


    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    Name string
    Name of the resource.


    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    name String
    Name of the resource.


    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    name string
    Name of the resource.


    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    name str
    Name of the resource.


    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    name String
    Name of the resource.


    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    getHealthCheck Result

    The following output properties are available:

    Supporting Types

    GetHealthCheckGrpcHealthCheck

    GrpcServiceName 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 int
    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.
    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, gRPC health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    GrpcServiceName 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 int
    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.
    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, gRPC health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    grpcServiceName 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.
    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, gRPC health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    grpcServiceName 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 number
    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.
    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, gRPC health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    grpc_service_name str
    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 int
    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 str
    Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
    port_specification 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, gRPC health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    grpcServiceName 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 Number
    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.
    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, gRPC health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    GetHealthCheckHttp2HealthCheck

    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. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    ProxyHeader string
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    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. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    ProxyHeader string
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    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 Integer
    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. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxyHeader String
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    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. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxyHeader string
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    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 int
    The TCP port number for the HTTP2 health check request. The default value is 443.
    port_name str
    Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
    port_specification 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. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxy_header str
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    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.
    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. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxyHeader String
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    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.

    GetHealthCheckHttpHealthCheck

    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 int
    The TCP port number for the HTTP health check request. The default value is 80.
    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, HTTP health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    ProxyHeader string
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    RequestPath string
    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.
    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 int
    The TCP port number for the HTTP health check request. The default value is 80.
    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, HTTP health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    ProxyHeader string
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    RequestPath string
    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.
    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.
    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, HTTP health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxyHeader String
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    requestPath String
    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.
    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 number
    The TCP port number for the HTTP health check request. The default value is 80.
    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, HTTP health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxyHeader string
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    requestPath string
    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.
    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.
    port int
    The TCP port number for the HTTP health check request. The default value is 80.
    port_name str
    Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
    port_specification 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, HTTP health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxy_header str
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    request_path str
    The request path of the HTTP 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.
    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 Number
    The TCP port number for the HTTP health check request. The default value is 80.
    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, HTTP health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxyHeader String
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    requestPath String
    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.

    GetHealthCheckHttpsHealthCheck

    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 int
    The TCP port number for the HTTPS 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, HTTPS health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    ProxyHeader string
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    RequestPath string
    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.
    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 int
    The TCP port number for the HTTPS 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, HTTPS health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    ProxyHeader string
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    RequestPath string
    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.
    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.
    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, HTTPS health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxyHeader String
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    requestPath String
    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.
    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 number
    The TCP port number for the HTTPS 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, HTTPS health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxyHeader string
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    requestPath string
    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.
    host str
    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 int
    The TCP port number for the HTTPS health check request. The default value is 443.
    port_name str
    Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
    port_specification 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, HTTPS health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxy_header str
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    request_path str
    The request path of the HTTPS 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.
    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 Number
    The TCP port number for the HTTPS 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, HTTPS health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxyHeader String
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    requestPath String
    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.

    GetHealthCheckLogConfig

    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 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.
    enable Boolean
    Indicates whether or not to export logs. This is false by default, which means no health check logging will be done.

    GetHealthCheckSslHealthCheck

    Port int
    The TCP port number for the SSL 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, SSL health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    ProxyHeader string
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["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.
    Port int
    The TCP port number for the SSL 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, SSL health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    ProxyHeader string
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["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.
    port Integer
    The TCP port number for the SSL 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, SSL health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxyHeader String
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["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.
    port number
    The TCP port number for the SSL 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, SSL health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxyHeader string
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["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.
    port int
    The TCP port number for the SSL health check request. The default value is 443.
    port_name str
    Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
    port_specification 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, SSL health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxy_header str
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    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.
    port Number
    The TCP port number for the SSL 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, SSL health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxyHeader String
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["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.

    GetHealthCheckTcpHealthCheck

    Port int
    The TCP port number for the TCP 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, TCP health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    ProxyHeader string
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["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.
    Port int
    The TCP port number for the TCP 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, TCP health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    ProxyHeader string
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["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.
    port Integer
    The TCP port number for the TCP 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, TCP health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxyHeader String
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["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.
    port number
    The TCP port number for the TCP 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, TCP health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxyHeader string
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["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.
    port int
    The TCP port number for the TCP health check request. The default value is 443.
    port_name str
    Port name as defined in InstanceGroup#NamedPort#name. If both port and port_name are defined, port takes precedence.
    port_specification 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, TCP health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxy_header str
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["NONE", "PROXY_V1"]
    request str
    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 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.
    port Number
    The TCP port number for the TCP 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, TCP health check follows behavior specified in 'port' and 'portName' fields. Possible values: ["USE_FIXED_PORT", "USE_NAMED_PORT", "USE_SERVING_PORT"]

    proxyHeader String
    Specifies the type of proxy header to append before sending data to the backend. Default value: "NONE" Possible values: ["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.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.28.0 published on Friday, Jun 21, 2024 by Pulumi