Resource Type: gcompute_health_check

Defined in:
lib/puppet/type/gcompute_health_check.rb
Providers:
google

Overview

An HealthCheck resource. This resource defines a template for how individual virtual machines should be checked for health, via one of the supported protocols.

Properties

  • check_interval_sec

    How often (in seconds) to send a health check. The default value is 5 seconds.

  • creation_timestamp

    Creation timestamp in RFC3339 text format. (output only)

  • description

    An optional description of this resource. Provide this property when you create the resource.

  • ensure (defaults to: present)

    The basic property that the resource should be in.

    Supported values:
    • present
    • absent
  • healthy_threshold

    A so-far unhealthy instance will be marked healthy after this many consecutive successes. The default value is 2.

  • http_health_check

    A nested object resource

  • https_health_check

    A nested object resource

  • id

    The unique identifier for the resource. This identifier is defined by the server. (output only)

  • name (namevar)

    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])? 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.

  • ssl_health_check

    A nested object resource

  • tcp_health_check

    A nested object resource

  • timeout_sec

    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

    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.

    Supported values:
    • TCP
    • SSL
    • HTTP
  • unhealthy_threshold

    A so-far healthy instance will be marked unhealthy after this many consecutive failures. The default value is 2.

Parameters

  • credential

    A gauth_credential name to be used to authenticate with Google Cloud Platform.

  • name

    The name of the HealthCheck.

  • project

    A Google Cloud Platform project to manage.

  • provider

    The specific backend to use for this ‘gcompute_health_check` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.