pulumi-cloudflare-kotlin/com.pulumi.cloudflare.kotlin.outputs/GetHealthchecksResult

GetHealthchecksResult

data class GetHealthchecksResult(val address: String, val checkRegions: List<String>, val consecutiveFails: Int, val consecutiveSuccesses: Int, val createdOn: String, val description: String, val failureReason: String, val httpConfig: GetHealthchecksResultHttpConfig, val id: String, val interval: Int, val modifiedOn: String, val name: String, val retries: Int, val status: String, val suspended: Boolean, val tcpConfig: GetHealthchecksResultTcpConfig, val timeout: Int, val type: String)

Constructors

constructor(address: String, checkRegions: List<String>, consecutiveFails: Int, consecutiveSuccesses: Int, createdOn: String, description: String, failureReason: String, httpConfig: GetHealthchecksResultHttpConfig, id: String, interval: Int, modifiedOn: String, name: String, retries: Int, status: String, suspended: Boolean, tcpConfig: GetHealthchecksResultTcpConfig, timeout: Int, type: String)

Types

Companion

object Companion

Properties

address

val address: String

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

checkRegions

val checkRegions: List<String>

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

consecutiveFails

val consecutiveFails: Int

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

consecutiveSuccesses

val consecutiveSuccesses: Int

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

createdOn

val createdOn: String

description

val description: String

A human-readable description of the health check.

failureReason

val failureReason: String

The current failure reason if status is unhealthy.

httpConfig

val httpConfig: GetHealthchecksResultHttpConfig

Parameters specific to an HTTP or HTTPS health check.

val id: String

Identifier

interval

val interval: 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: String

name

val name: String

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

retries

val retries: Int

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

status

val status: String

The current status of the origin server according to the health check. Available values: "unknown", "healthy", "unhealthy", "suspended".

suspended

val suspended: Boolean

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

tcpConfig

val tcpConfig: GetHealthchecksResultTcpConfig

Parameters specific to TCP health check.

timeout

val timeout: Int

The timeout (in seconds) before marking the health check as failed.

type

val type: String

The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.