pulumi-cloudflare-kotlin/com.pulumi.cloudflare.kotlin/LoadBalancerMonitorArgs

LoadBalancerMonitorArgs

data class LoadBalancerMonitorArgs(val accountId: Output<String>? = null, val allowInsecure: Output<Boolean>? = null, val description: Output<String>? = null, val expectedBody: Output<String>? = null, val expectedCodes: Output<String>? = null, val followRedirects: Output<Boolean>? = null, val headers: Output<List<LoadBalancerMonitorHeaderArgs>>? = null, val interval: Output<Int>? = null, val method: Output<String>? = null, val path: Output<String>? = null, val port: Output<Int>? = null, val probeZone: Output<String>? = null, val retries: Output<Int>? = null, val timeout: Output<Int>? = null, val type: Output<String>? = null) : ConvertibleToJava<LoadBalancerMonitorArgs>

If Cloudflare's Load Balancing to load-balance across multiple origin servers or data centers, you configure one of these Monitors to actively check the availability of those servers over HTTP(S) or TCP.

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.LoadBalancerMonitor;
import com.pulumi.cloudflare.LoadBalancerMonitorArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var example = new LoadBalancerMonitor("example", LoadBalancerMonitorArgs.builder()
            .accountId("f037e56e89293a057740de681ac9abbe")
            .description("example tcp load balancer")
            .interval(60)
            .method("connection_established")
            .port(8080)
            .retries(5)
            .timeout(7)
            .type("tcp")
            .build());
    }
}

Constructors

LoadBalancerMonitorArgs

fun LoadBalancerMonitorArgs(accountId: Output<String>? = null, allowInsecure: Output<Boolean>? = null, description: Output<String>? = null, expectedBody: Output<String>? = null, expectedCodes: Output<String>? = null, followRedirects: Output<Boolean>? = null, headers: Output<List<LoadBalancerMonitorHeaderArgs>>? = null, interval: Output<Int>? = null, method: Output<String>? = null, path: Output<String>? = null, port: Output<Int>? = null, probeZone: Output<String>? = null, retries: Output<Int>? = null, timeout: Output<Int>? = null, type: Output<String>? = null)

Functions

toJava

open override fun toJava(): LoadBalancerMonitorArgs

Properties

accountId

val accountId: Output<String>? = null

The account identifier to target for the resource.

allowInsecure

val allowInsecure: Output<Boolean>? = null

Do not validate the certificate when monitor use HTTPS. Only valid if type is "http" or "https".

description

val description: Output<String>? = null

Free text description.

expectedBody

val expectedBody: Output<String>? = null

A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy. Only valid if type is "http" or "https".

expectedCodes

val expectedCodes: Output<String>? = null

The expected HTTP response code or code range of the health check. Eg 2xx. Only valid and required if type is "http" or "https".

followRedirects

val followRedirects: Output<Boolean>? = null

Follow redirects if returned by the origin. Only valid if type is "http" or "https".

headers

val headers: Output<List<LoadBalancerMonitorHeaderArgs>>? = null

The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden.

interval

val interval: Output<Int>? = null

The interval between each health check. Shorter intervals may improve failover time, but will increase load on the origins as we check from multiple locations. Defaults to 60.

method

val method: Output<String>? = null

The method to use for the health check.

path

val path: Output<String>? = null

The endpoint path to health check against.

port

val port: Output<Int>? = null

The port number to use for the healthcheck, required when creating a TCP monitor.

probeZone

val probeZone: Output<String>? = null

Assign this monitor to emulate the specified zone while probing. Only valid if type is "http" or "https".

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. Defaults to 2.

timeout

val timeout: Output<Int>? = null

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

type

val type: Output<String>? = null

The protocol to use for the healthcheck. Available values: http, https, tcp, udp_icmp, icmp_ping, smtp. Defaults to http.