Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getLoadBalancerMonitor
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-cloudflare

cloudflare.getLoadBalancerMonitor

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
pulumi/pulumi-cloudflare

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";

const exampleLoadBalancerMonitor = cloudflare.getLoadBalancerMonitor({
    accountId: "023e105f4ecef8ad9ca31a8372d0c353",
    monitorId: "f1aba936b94213e5b8dca0c0dbf1f9cc",
});

    import pulumi
import pulumi_cloudflare as cloudflare

example_load_balancer_monitor = cloudflare.get_load_balancer_monitor(account_id="023e105f4ecef8ad9ca31a8372d0c353",
    monitor_id="f1aba936b94213e5b8dca0c0dbf1f9cc")

    package main

import (
	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudflare.LookupLoadBalancerMonitor(ctx, &cloudflare.LookupLoadBalancerMonitorArgs{
			AccountId: "023e105f4ecef8ad9ca31a8372d0c353",
			MonitorId: pulumi.StringRef("f1aba936b94213e5b8dca0c0dbf1f9cc"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;

return await Deployment.RunAsync(() => 
{
    var exampleLoadBalancerMonitor = Cloudflare.GetLoadBalancerMonitor.Invoke(new()
    {
        AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
        MonitorId = "f1aba936b94213e5b8dca0c0dbf1f9cc",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cloudflare.CloudflareFunctions;
import com.pulumi.cloudflare.inputs.GetLoadBalancerMonitorArgs;
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) {
        final var exampleLoadBalancerMonitor = CloudflareFunctions.getLoadBalancerMonitor(GetLoadBalancerMonitorArgs.builder()
            .accountId("023e105f4ecef8ad9ca31a8372d0c353")
            .monitorId("f1aba936b94213e5b8dca0c0dbf1f9cc")
            .build());

    }
}

    variables:
  exampleLoadBalancerMonitor:
    fn::invoke:
      function: cloudflare:getLoadBalancerMonitor
      arguments:
        accountId: 023e105f4ecef8ad9ca31a8372d0c353
        monitorId: f1aba936b94213e5b8dca0c0dbf1f9cc

    Using getLoadBalancerMonitor

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getLoadBalancerMonitor(args: GetLoadBalancerMonitorArgs, opts?: InvokeOptions): Promise<GetLoadBalancerMonitorResult>
function getLoadBalancerMonitorOutput(args: GetLoadBalancerMonitorOutputArgs, opts?: InvokeOptions): Output<GetLoadBalancerMonitorResult>
    def get_load_balancer_monitor(account_id: Optional[str] = None,
                              monitor_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetLoadBalancerMonitorResult
def get_load_balancer_monitor_output(account_id: Optional[pulumi.Input[str]] = None,
                              monitor_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetLoadBalancerMonitorResult]
    func LookupLoadBalancerMonitor(ctx *Context, args *LookupLoadBalancerMonitorArgs, opts ...InvokeOption) (*LookupLoadBalancerMonitorResult, error)
func LookupLoadBalancerMonitorOutput(ctx *Context, args *LookupLoadBalancerMonitorOutputArgs, opts ...InvokeOption) LookupLoadBalancerMonitorResultOutput

    > Note: This function is named LookupLoadBalancerMonitor in the Go SDK.

    public static class GetLoadBalancerMonitor 
{
    public static Task<GetLoadBalancerMonitorResult> InvokeAsync(GetLoadBalancerMonitorArgs args, InvokeOptions? opts = null)
    public static Output<GetLoadBalancerMonitorResult> Invoke(GetLoadBalancerMonitorInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetLoadBalancerMonitorResult> getLoadBalancerMonitor(GetLoadBalancerMonitorArgs args, InvokeOptions options)
public static Output<GetLoadBalancerMonitorResult> getLoadBalancerMonitor(GetLoadBalancerMonitorArgs args, InvokeOptions options)

    fn::invoke:
  function: cloudflare:index/getLoadBalancerMonitor:getLoadBalancerMonitor
  arguments:
    # arguments dictionary

    The following arguments are supported:

    AccountId string
    Identifier
    MonitorId string
    AccountId string
    Identifier
    MonitorId string
    accountId String
    Identifier
    monitorId String
    accountId string
    Identifier
    monitorId string
    account_id str
    Identifier
    monitor_id str
    accountId String
    Identifier
    monitorId String

    getLoadBalancerMonitor Result

    The following output properties are available:

    AccountId string
    Identifier
    AllowInsecure bool
    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
    ConsecutiveDown int
    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.
    ConsecutiveUp int
    To be marked healthy the monitored origin must pass this healthcheck N consecutive times.
    CreatedOn string
    Description string
    Object description.
    ExpectedBody string
    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. This parameter is only valid for HTTP and HTTPS monitors.
    ExpectedCodes string
    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
    FollowRedirects bool
    Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
    Header Dictionary<string, ImmutableArray<string>>
    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. This parameter is only valid for HTTP and HTTPS monitors.
    Id string
    The ID of this resource.
    Interval int
    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.
    Method string
    The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
    ModifiedOn string
    Path string
    The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.
    Port int
    The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
    ProbeZone string
    Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.
    Retries int
    The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
    Timeout int
    The timeout (in seconds) before marking the health check as failed.
    Type string
    The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'. Available values: "http", "https", "tcp", "udpicmp", "icmpping", "smtp".
    MonitorId string
    AccountId string
    Identifier
    AllowInsecure bool
    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
    ConsecutiveDown int
    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.
    ConsecutiveUp int
    To be marked healthy the monitored origin must pass this healthcheck N consecutive times.
    CreatedOn string
    Description string
    Object description.
    ExpectedBody string
    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. This parameter is only valid for HTTP and HTTPS monitors.
    ExpectedCodes string
    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
    FollowRedirects bool
    Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
    Header map[string][]string
    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. This parameter is only valid for HTTP and HTTPS monitors.
    Id string
    The ID of this resource.
    Interval int
    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.
    Method string
    The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
    ModifiedOn string
    Path string
    The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.
    Port int
    The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
    ProbeZone string
    Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.
    Retries int
    The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
    Timeout int
    The timeout (in seconds) before marking the health check as failed.
    Type string
    The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'. Available values: "http", "https", "tcp", "udpicmp", "icmpping", "smtp".
    MonitorId string
    accountId String
    Identifier
    allowInsecure Boolean
    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
    consecutiveDown Integer
    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.
    consecutiveUp Integer
    To be marked healthy the monitored origin must pass this healthcheck N consecutive times.
    createdOn String
    description String
    Object description.
    expectedBody String
    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. This parameter is only valid for HTTP and HTTPS monitors.
    expectedCodes String
    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
    followRedirects Boolean
    Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
    header Map<String,List<String>>
    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. This parameter is only valid for HTTP and HTTPS monitors.
    id String
    The ID of this resource.
    interval Integer
    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.
    method String
    The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
    modifiedOn String
    path String
    The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.
    port Integer
    The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
    probeZone String
    Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.
    retries Integer
    The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
    timeout Integer
    The timeout (in seconds) before marking the health check as failed.
    type String
    The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'. Available values: "http", "https", "tcp", "udpicmp", "icmpping", "smtp".
    monitorId String
    accountId string
    Identifier
    allowInsecure boolean
    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
    consecutiveDown number
    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.
    consecutiveUp number
    To be marked healthy the monitored origin must pass this healthcheck N consecutive times.
    createdOn string
    description string
    Object description.
    expectedBody string
    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. This parameter is only valid for HTTP and HTTPS monitors.
    expectedCodes string
    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
    followRedirects boolean
    Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
    header {[key: string]: string[]}
    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. This parameter is only valid for HTTP and HTTPS monitors.
    id string
    The ID of this resource.
    interval number
    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.
    method string
    The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
    modifiedOn string
    path string
    The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.
    port number
    The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
    probeZone string
    Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.
    retries number
    The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
    timeout number
    The timeout (in seconds) before marking the health check as failed.
    type string
    The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'. Available values: "http", "https", "tcp", "udpicmp", "icmpping", "smtp".
    monitorId string
    account_id str
    Identifier
    allow_insecure bool
    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
    consecutive_down int
    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.
    consecutive_up int
    To be marked healthy the monitored origin must pass this healthcheck N consecutive times.
    created_on str
    description str
    Object description.
    expected_body str
    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. This parameter is only valid for HTTP and HTTPS monitors.
    expected_codes str
    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
    follow_redirects bool
    Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
    header Mapping[str, Sequence[str]]
    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. This parameter is only valid for HTTP and HTTPS monitors.
    id str
    The ID of this resource.
    interval int
    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.
    method str
    The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
    modified_on str
    path str
    The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.
    port int
    The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
    probe_zone str
    Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.
    retries int
    The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
    timeout int
    The timeout (in seconds) before marking the health check as failed.
    type str
    The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'. Available values: "http", "https", "tcp", "udpicmp", "icmpping", "smtp".
    monitor_id str
    accountId String
    Identifier
    allowInsecure Boolean
    Do not validate the certificate when monitor use HTTPS. This parameter is currently only valid for HTTP and HTTPS monitors.
    consecutiveDown Number
    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times.
    consecutiveUp Number
    To be marked healthy the monitored origin must pass this healthcheck N consecutive times.
    createdOn String
    description String
    Object description.
    expectedBody String
    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. This parameter is only valid for HTTP and HTTPS monitors.
    expectedCodes String
    The expected HTTP response code or code range of the health check. This parameter is only valid for HTTP and HTTPS monitors.
    followRedirects Boolean
    Follow redirects if returned by the origin. This parameter is only valid for HTTP and HTTPS monitors.
    header Map<List<String>>
    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. This parameter is only valid for HTTP and HTTPS monitors.
    id String
    The ID of this resource.
    interval Number
    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.
    method String
    The method to use for the health check. This defaults to 'GET' for HTTP/HTTPS based checks and 'connection_established' for TCP based health checks.
    modifiedOn String
    path String
    The endpoint path you want to conduct a health check against. This parameter is only valid for HTTP and HTTPS monitors.
    port Number
    The port number to connect to for the health check. Required for TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when using a non-standard port (HTTP: default 80, HTTPS: default 443).
    probeZone String
    Assign this monitor to emulate the specified zone while probing. This parameter is only valid for HTTP and HTTPS monitors.
    retries Number
    The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
    timeout Number
    The timeout (in seconds) before marking the health check as failed.
    type String
    The protocol to use for the health check. Currently supported protocols are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'. Available values: "http", "https", "tcp", "udpicmp", "icmpping", "smtp".
    monitorId String

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi
    pulumi/pulumi-cloudflare