pulumi-cloudflare-kotlin/com.pulumi.cloudflare.kotlin/HealthcheckArgs

HealthcheckArgs

data class HealthcheckArgs(val address: Output<String>? = null, val checkRegions: Output<List<String>>? = null, val consecutiveFails: Output<Int>? = null, val consecutiveSuccesses: Output<Int>? = null, val description: Output<String>? = null, val httpConfig: Output<HealthcheckHttpConfigArgs>? = null, val interval: Output<Int>? = null, val name: Output<String>? = null, val retries: Output<Int>? = null, val suspended: Output<Boolean>? = null, val tcpConfig: Output<HealthcheckTcpConfigArgs>? = null, val timeout: Output<Int>? = null, val type: Output<String>? = null, val zoneId: Output<String>? = null) : ConvertibleToJava<HealthcheckArgs>

Example Usage

resources:
  exampleHealthcheck:
    type: cloudflare:Healthcheck
    name: example_healthcheck
    properties:
      zoneId: 023e105f4ecef8ad9ca31a8372d0c353
      address: www.example.com
      name: server-1
      checkRegions:
        - WEU
        - ENAM
      consecutiveFails: 0
      consecutiveSuccesses: 0
      description: Health check for www.example.com
      httpConfig:
        allow_insecure: true
        expected_body: success
        expected_codes:
          - 2xx
          - '302'
        follow_redirects: true
        header:
          host:
            - example.com
          x-App-ID:
            - abc123
        method: GET
        path: /health
        port: 0
      interval: 0
      retries: 0
      suspended: true
      tcpConfig:
        method: connection_established
        port: 0
      timeout: 0
      type: HTTPS

Import

$ pulumi import cloudflare:index/healthcheck:Healthcheck example '<zone_id>/<healthcheck_id>'

Constructors

HealthcheckArgs

constructor(address: Output<String>? = null, checkRegions: Output<List<String>>? = null, consecutiveFails: Output<Int>? = null, consecutiveSuccesses: Output<Int>? = null, description: Output<String>? = null, httpConfig: Output<HealthcheckHttpConfigArgs>? = null, interval: Output<Int>? = null, name: Output<String>? = null, retries: Output<Int>? = null, suspended: Output<Boolean>? = null, tcpConfig: Output<HealthcheckTcpConfigArgs>? = null, timeout: Output<Int>? = null, type: Output<String>? = null, zoneId: Output<String>? = null)

Properties

address

val address: Output<String>? = null

The hostname or IP address of the origin server to run health checks on.

checkRegions

val checkRegions: Output<List<String>>? = null

A list of regions from which to run health checks. Null means Cloudflare will pick a default region.

consecutiveFails

val consecutiveFails: Output<Int>? = null

The number of consecutive fails required from a health check before changing the health to unhealthy.

consecutiveSuccesses

val consecutiveSuccesses: Output<Int>? = null

The number of consecutive successes required from a health check before changing the health to healthy.

description

val description: Output<String>? = null

A human-readable description of the health check.

httpConfig

val httpConfig: Output<HealthcheckHttpConfigArgs>? = null

Parameters specific to an HTTP or HTTPS health check.

interval

val interval: Output<Int>? = null

The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.

name

val name: Output<String>? = null

A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.

retries

val retries: Output<Int>? = null

The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.

suspended

val suspended: Output<Boolean>? = null

If suspended, no health checks are sent to the origin.

tcpConfig

val tcpConfig: Output<HealthcheckTcpConfigArgs>? = null

Parameters specific to TCP health check.