pulumi-cloudflare-kotlin/com.pulumi.cloudflare.kotlin/Healthcheck

Healthcheck

class Healthcheck : KotlinCustomResource

Example Usage

resources:
  exampleHealthcheck:
    type: cloudflare:Healthcheck
    name: example_healthcheck
    properties:
      zoneId: 023e105f4ecef8ad9ca31a8372d0c353
      address: www.example.com
      name: server-1
      checkRegions:
        - WNAM
        - 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>'

Properties

address

val address: Output<String>

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

checkRegions

val checkRegions: Output<List<String>>?

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

consecutiveFails

val consecutiveFails: Output<Int>

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

consecutiveSuccesses

val consecutiveSuccesses: Output<Int>

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

createdOn

val createdOn: Output<String>

description

val description: Output<String>?

A human-readable description of the health check.

failureReason

val failureReason: Output<String>

The current failure reason if status is unhealthy.

httpConfig

val httpConfig: Output<HealthcheckHttpConfig>

Parameters specific to an HTTP or HTTPS health check.

val id: Output<String>

interval

val interval: Output<Int>

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.

modifiedOn

val modifiedOn: Output<String>

name

val name: Output<String>

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

pulumiChildResources

val pulumiChildResources: Set<KotlinResource>

pulumiResourceName

val pulumiResourceName: String

pulumiResourceType

val pulumiResourceType: String

retries