Cloudflare v5.24.0 published on Thursday, Mar 28, 2024 by Pulumi
cloudflare.LoadBalancerMonitor
Explore with Pulumi AI
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
import * as pulumi from "@pulumi/pulumi";
import * as cloudflare from "@pulumi/cloudflare";
// TCP Monitor
const example = new cloudflare.LoadBalancerMonitor("example", {
accountId: "f037e56e89293a057740de681ac9abbe",
description: "example tcp load balancer",
interval: 60,
method: "connection_established",
port: 8080,
retries: 5,
timeout: 7,
type: "tcp",
});
import pulumi
import pulumi_cloudflare as cloudflare
# TCP Monitor
example = cloudflare.LoadBalancerMonitor("example",
account_id="f037e56e89293a057740de681ac9abbe",
description="example tcp load balancer",
interval=60,
method="connection_established",
port=8080,
retries=5,
timeout=7,
type="tcp")
package main
import (
"github.com/pulumi/pulumi-cloudflare/sdk/v5/go/cloudflare"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
// TCP Monitor
_, err := cloudflare.NewLoadBalancerMonitor(ctx, "example", &cloudflare.LoadBalancerMonitorArgs{
AccountId: pulumi.String("f037e56e89293a057740de681ac9abbe"),
Description: pulumi.String("example tcp load balancer"),
Interval: pulumi.Int(60),
Method: pulumi.String("connection_established"),
Port: pulumi.Int(8080),
Retries: pulumi.Int(5),
Timeout: pulumi.Int(7),
Type: pulumi.String("tcp"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Cloudflare = Pulumi.Cloudflare;
return await Deployment.RunAsync(() =>
{
// TCP Monitor
var example = new Cloudflare.LoadBalancerMonitor("example", new()
{
AccountId = "f037e56e89293a057740de681ac9abbe",
Description = "example tcp load balancer",
Interval = 60,
Method = "connection_established",
Port = 8080,
Retries = 5,
Timeout = 7,
Type = "tcp",
});
});
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());
}
}
resources:
# TCP Monitor
example:
type: cloudflare:LoadBalancerMonitor
properties:
accountId: f037e56e89293a057740de681ac9abbe
description: example tcp load balancer
interval: 60
method: connection_established
port: 8080
retries: 5
timeout: 7
type: tcp
Create LoadBalancerMonitor Resource
new LoadBalancerMonitor(name: string, args: LoadBalancerMonitorArgs, opts?: CustomResourceOptions);
@overload
def LoadBalancerMonitor(resource_name: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
allow_insecure: Optional[bool] = None,
consecutive_down: Optional[int] = None,
consecutive_up: Optional[int] = None,
description: Optional[str] = None,
expected_body: Optional[str] = None,
expected_codes: Optional[str] = None,
follow_redirects: Optional[bool] = None,
headers: Optional[Sequence[LoadBalancerMonitorHeaderArgs]] = None,
interval: Optional[int] = None,
method: Optional[str] = None,
path: Optional[str] = None,
port: Optional[int] = None,
probe_zone: Optional[str] = None,
retries: Optional[int] = None,
timeout: Optional[int] = None,
type: Optional[str] = None)
@overload
def LoadBalancerMonitor(resource_name: str,
args: LoadBalancerMonitorArgs,
opts: Optional[ResourceOptions] = None)
func NewLoadBalancerMonitor(ctx *Context, name string, args LoadBalancerMonitorArgs, opts ...ResourceOption) (*LoadBalancerMonitor, error)
public LoadBalancerMonitor(string name, LoadBalancerMonitorArgs args, CustomResourceOptions? opts = null)
public LoadBalancerMonitor(String name, LoadBalancerMonitorArgs args)
public LoadBalancerMonitor(String name, LoadBalancerMonitorArgs args, CustomResourceOptions options)
type: cloudflare:LoadBalancerMonitor
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LoadBalancerMonitorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args LoadBalancerMonitorArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args LoadBalancerMonitorArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args LoadBalancerMonitorArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args LoadBalancerMonitorArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
LoadBalancerMonitor Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The LoadBalancerMonitor resource accepts the following input properties:
- Account
Id string - The account identifier to target for the resource.
- Allow
Insecure bool - Do not validate the certificate when monitor use HTTPS. Only valid if
type
is "http" or "https". - Consecutive
Down int - To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to
0
. - Consecutive
Up int - To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to
0
. - Description string
- Free text description.
- Expected
Body 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. Only valid if
type
is "http" or "https". - Expected
Codes string - The expected HTTP response code or code range of the health check. Eg
2xx
. Only valid and required iftype
is "http" or "https". - Follow
Redirects bool - Follow redirects if returned by the origin. Only valid if
type
is "http" or "https". - Headers
List<Load
Balancer Monitor Header> - The header name.
- 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. Defaults to
60
. - Method string
- The method to use for the health check.
- Path string
- The endpoint path to health check against.
- Port int
- The port number to use for the healthcheck, required when creating a TCP monitor.
- Probe
Zone string - Assign this monitor to emulate the specified zone while probing. Only valid if
type
is "http" or "https". - Retries int
- 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 int
- The timeout (in seconds) before marking the health check as failed. Defaults to
5
. - Type string
- The protocol to use for the healthcheck. Available values:
http
,https
,tcp
,udp_icmp
,icmp_ping
,smtp
. Defaults tohttp
.
- Account
Id string - The account identifier to target for the resource.
- Allow
Insecure bool - Do not validate the certificate when monitor use HTTPS. Only valid if
type
is "http" or "https". - Consecutive
Down int - To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to
0
. - Consecutive
Up int - To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to
0
. - Description string
- Free text description.
- Expected
Body 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. Only valid if
type
is "http" or "https". - Expected
Codes string - The expected HTTP response code or code range of the health check. Eg
2xx
. Only valid and required iftype
is "http" or "https". - Follow
Redirects bool - Follow redirects if returned by the origin. Only valid if
type
is "http" or "https". - Headers
[]Load
Balancer Monitor Header Args - The header name.
- 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. Defaults to
60
. - Method string
- The method to use for the health check.
- Path string
- The endpoint path to health check against.
- Port int
- The port number to use for the healthcheck, required when creating a TCP monitor.
- Probe
Zone string - Assign this monitor to emulate the specified zone while probing. Only valid if
type
is "http" or "https". - Retries int
- 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 int
- The timeout (in seconds) before marking the health check as failed. Defaults to
5
. - Type string
- The protocol to use for the healthcheck. Available values:
http
,https
,tcp
,udp_icmp
,icmp_ping
,smtp
. Defaults tohttp
.
- account
Id String - The account identifier to target for the resource.
- allow
Insecure Boolean - Do not validate the certificate when monitor use HTTPS. Only valid if
type
is "http" or "https". - consecutive
Down Integer - To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to
0
. - consecutive
Up Integer - To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to
0
. - description String
- Free text description.
- expected
Body 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. Only valid if
type
is "http" or "https". - expected
Codes String - The expected HTTP response code or code range of the health check. Eg
2xx
. Only valid and required iftype
is "http" or "https". - follow
Redirects Boolean - Follow redirects if returned by the origin. Only valid if
type
is "http" or "https". - headers
List<Load
Balancer Monitor Header> - The header name.
- 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. Defaults to
60
. - method String
- The method to use for the health check.
- path String
- The endpoint path to health check against.
- port Integer
- The port number to use for the healthcheck, required when creating a TCP monitor.
- probe
Zone String - Assign this monitor to emulate the specified zone while probing. Only valid if
type
is "http" or "https". - retries Integer
- 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 Integer
- The timeout (in seconds) before marking the health check as failed. Defaults to
5
. - type String
- The protocol to use for the healthcheck. Available values:
http
,https
,tcp
,udp_icmp
,icmp_ping
,smtp
. Defaults tohttp
.
- account
Id string - The account identifier to target for the resource.
- allow
Insecure boolean - Do not validate the certificate when monitor use HTTPS. Only valid if
type
is "http" or "https". - consecutive
Down number - To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to
0
. - consecutive
Up number - To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to
0
. - description string
- Free text description.
- expected
Body 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. Only valid if
type
is "http" or "https". - expected
Codes string - The expected HTTP response code or code range of the health check. Eg
2xx
. Only valid and required iftype
is "http" or "https". - follow
Redirects boolean - Follow redirects if returned by the origin. Only valid if
type
is "http" or "https". - headers
Load
Balancer Monitor Header[] - The header name.
- 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. Defaults to
60
. - method string
- The method to use for the health check.
- path string
- The endpoint path to health check against.
- port number
- The port number to use for the healthcheck, required when creating a TCP monitor.
- probe
Zone string - Assign this monitor to emulate the specified zone while probing. Only valid if
type
is "http" or "https". - retries number
- 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 number
- The timeout (in seconds) before marking the health check as failed. Defaults to
5
. - type string
- The protocol to use for the healthcheck. Available values:
http
,https
,tcp
,udp_icmp
,icmp_ping
,smtp
. Defaults tohttp
.
- account_
id str - The account identifier to target for the resource.
- allow_
insecure bool - Do not validate the certificate when monitor use HTTPS. Only valid if
type
is "http" or "https". - consecutive_
down int - To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to
0
. - consecutive_
up int - To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to
0
. - description str
- Free text 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. Only valid if
type
is "http" or "https". - expected_
codes str - The expected HTTP response code or code range of the health check. Eg
2xx
. Only valid and required iftype
is "http" or "https". - follow_
redirects bool - Follow redirects if returned by the origin. Only valid if
type
is "http" or "https". - headers
Sequence[Load
Balancer Monitor Header Args] - The header name.
- 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. Defaults to
60
. - method str
- The method to use for the health check.
- path str
- The endpoint path to health check against.
- port int
- The port number to use for the healthcheck, required when creating a TCP monitor.
- probe_
zone str - Assign this monitor to emulate the specified zone while probing. Only valid if
type
is "http" or "https". - retries int
- 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 int
- The timeout (in seconds) before marking the health check as failed. Defaults to
5
. - type str
- The protocol to use for the healthcheck. Available values:
http
,https
,tcp
,udp_icmp
,icmp_ping
,smtp
. Defaults tohttp
.
- account
Id String - The account identifier to target for the resource.
- allow
Insecure Boolean - Do not validate the certificate when monitor use HTTPS. Only valid if
type
is "http" or "https". - consecutive
Down Number - To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to
0
. - consecutive
Up Number - To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to
0
. - description String
- Free text description.
- expected
Body 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. Only valid if
type
is "http" or "https". - expected
Codes String - The expected HTTP response code or code range of the health check. Eg
2xx
. Only valid and required iftype
is "http" or "https". - follow
Redirects Boolean - Follow redirects if returned by the origin. Only valid if
type
is "http" or "https". - headers List<Property Map>
- The header name.
- 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. Defaults to
60
. - method String
- The method to use for the health check.
- path String
- The endpoint path to health check against.
- port Number
- The port number to use for the healthcheck, required when creating a TCP monitor.
- probe
Zone String - Assign this monitor to emulate the specified zone while probing. Only valid if
type
is "http" or "https". - retries Number
- 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 Number
- The timeout (in seconds) before marking the health check as failed. Defaults to
5
. - type String
- The protocol to use for the healthcheck. Available values:
http
,https
,tcp
,udp_icmp
,icmp_ping
,smtp
. Defaults tohttp
.
Outputs
All input properties are implicitly available as output properties. Additionally, the LoadBalancerMonitor resource produces the following output properties:
- Created
On string - The RFC3339 timestamp of when the load balancer monitor was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Modified
On string - The RFC3339 timestamp of when the load balancer monitor was last modified.
- Created
On string - The RFC3339 timestamp of when the load balancer monitor was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Modified
On string - The RFC3339 timestamp of when the load balancer monitor was last modified.
- created
On String - The RFC3339 timestamp of when the load balancer monitor was created.
- id String
- The provider-assigned unique ID for this managed resource.
- modified
On String - The RFC3339 timestamp of when the load balancer monitor was last modified.
- created
On string - The RFC3339 timestamp of when the load balancer monitor was created.
- id string
- The provider-assigned unique ID for this managed resource.
- modified
On string - The RFC3339 timestamp of when the load balancer monitor was last modified.
- created_
on str - The RFC3339 timestamp of when the load balancer monitor was created.
- id str
- The provider-assigned unique ID for this managed resource.
- modified_
on str - The RFC3339 timestamp of when the load balancer monitor was last modified.
- created
On String - The RFC3339 timestamp of when the load balancer monitor was created.
- id String
- The provider-assigned unique ID for this managed resource.
- modified
On String - The RFC3339 timestamp of when the load balancer monitor was last modified.
Look up Existing LoadBalancerMonitor Resource
Get an existing LoadBalancerMonitor resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: LoadBalancerMonitorState, opts?: CustomResourceOptions): LoadBalancerMonitor
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
account_id: Optional[str] = None,
allow_insecure: Optional[bool] = None,
consecutive_down: Optional[int] = None,
consecutive_up: Optional[int] = None,
created_on: Optional[str] = None,
description: Optional[str] = None,
expected_body: Optional[str] = None,
expected_codes: Optional[str] = None,
follow_redirects: Optional[bool] = None,
headers: Optional[Sequence[LoadBalancerMonitorHeaderArgs]] = None,
interval: Optional[int] = None,
method: Optional[str] = None,
modified_on: Optional[str] = None,
path: Optional[str] = None,
port: Optional[int] = None,
probe_zone: Optional[str] = None,
retries: Optional[int] = None,
timeout: Optional[int] = None,
type: Optional[str] = None) -> LoadBalancerMonitor
func GetLoadBalancerMonitor(ctx *Context, name string, id IDInput, state *LoadBalancerMonitorState, opts ...ResourceOption) (*LoadBalancerMonitor, error)
public static LoadBalancerMonitor Get(string name, Input<string> id, LoadBalancerMonitorState? state, CustomResourceOptions? opts = null)
public static LoadBalancerMonitor get(String name, Output<String> id, LoadBalancerMonitorState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Account
Id string - The account identifier to target for the resource.
- Allow
Insecure bool - Do not validate the certificate when monitor use HTTPS. Only valid if
type
is "http" or "https". - Consecutive
Down int - To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to
0
. - Consecutive
Up int - To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to
0
. - Created
On string - The RFC3339 timestamp of when the load balancer monitor was created.
- Description string
- Free text description.
- Expected
Body 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. Only valid if
type
is "http" or "https". - Expected
Codes string - The expected HTTP response code or code range of the health check. Eg
2xx
. Only valid and required iftype
is "http" or "https". - Follow
Redirects bool - Follow redirects if returned by the origin. Only valid if
type
is "http" or "https". - Headers
List<Load
Balancer Monitor Header> - The header name.
- 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. Defaults to
60
. - Method string
- The method to use for the health check.
- Modified
On string - The RFC3339 timestamp of when the load balancer monitor was last modified.
- Path string
- The endpoint path to health check against.
- Port int
- The port number to use for the healthcheck, required when creating a TCP monitor.
- Probe
Zone string - Assign this monitor to emulate the specified zone while probing. Only valid if
type
is "http" or "https". - Retries int
- 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 int
- The timeout (in seconds) before marking the health check as failed. Defaults to
5
. - Type string
- The protocol to use for the healthcheck. Available values:
http
,https
,tcp
,udp_icmp
,icmp_ping
,smtp
. Defaults tohttp
.
- Account
Id string - The account identifier to target for the resource.
- Allow
Insecure bool - Do not validate the certificate when monitor use HTTPS. Only valid if
type
is "http" or "https". - Consecutive
Down int - To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to
0
. - Consecutive
Up int - To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to
0
. - Created
On string - The RFC3339 timestamp of when the load balancer monitor was created.
- Description string
- Free text description.
- Expected
Body 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. Only valid if
type
is "http" or "https". - Expected
Codes string - The expected HTTP response code or code range of the health check. Eg
2xx
. Only valid and required iftype
is "http" or "https". - Follow
Redirects bool - Follow redirects if returned by the origin. Only valid if
type
is "http" or "https". - Headers
[]Load
Balancer Monitor Header Args - The header name.
- 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. Defaults to
60
. - Method string
- The method to use for the health check.
- Modified
On string - The RFC3339 timestamp of when the load balancer monitor was last modified.
- Path string
- The endpoint path to health check against.
- Port int
- The port number to use for the healthcheck, required when creating a TCP monitor.
- Probe
Zone string - Assign this monitor to emulate the specified zone while probing. Only valid if
type
is "http" or "https". - Retries int
- 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 int
- The timeout (in seconds) before marking the health check as failed. Defaults to
5
. - Type string
- The protocol to use for the healthcheck. Available values:
http
,https
,tcp
,udp_icmp
,icmp_ping
,smtp
. Defaults tohttp
.
- account
Id String - The account identifier to target for the resource.
- allow
Insecure Boolean - Do not validate the certificate when monitor use HTTPS. Only valid if
type
is "http" or "https". - consecutive
Down Integer - To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to
0
. - consecutive
Up Integer - To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to
0
. - created
On String - The RFC3339 timestamp of when the load balancer monitor was created.
- description String
- Free text description.
- expected
Body 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. Only valid if
type
is "http" or "https". - expected
Codes String - The expected HTTP response code or code range of the health check. Eg
2xx
. Only valid and required iftype
is "http" or "https". - follow
Redirects Boolean - Follow redirects if returned by the origin. Only valid if
type
is "http" or "https". - headers
List<Load
Balancer Monitor Header> - The header name.
- 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. Defaults to
60
. - method String
- The method to use for the health check.
- modified
On String - The RFC3339 timestamp of when the load balancer monitor was last modified.
- path String
- The endpoint path to health check against.
- port Integer
- The port number to use for the healthcheck, required when creating a TCP monitor.
- probe
Zone String - Assign this monitor to emulate the specified zone while probing. Only valid if
type
is "http" or "https". - retries Integer
- 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 Integer
- The timeout (in seconds) before marking the health check as failed. Defaults to
5
. - type String
- The protocol to use for the healthcheck. Available values:
http
,https
,tcp
,udp_icmp
,icmp_ping
,smtp
. Defaults tohttp
.
- account
Id string - The account identifier to target for the resource.
- allow
Insecure boolean - Do not validate the certificate when monitor use HTTPS. Only valid if
type
is "http" or "https". - consecutive
Down number - To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to
0
. - consecutive
Up number - To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to
0
. - created
On string - The RFC3339 timestamp of when the load balancer monitor was created.
- description string
- Free text description.
- expected
Body 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. Only valid if
type
is "http" or "https". - expected
Codes string - The expected HTTP response code or code range of the health check. Eg
2xx
. Only valid and required iftype
is "http" or "https". - follow
Redirects boolean - Follow redirects if returned by the origin. Only valid if
type
is "http" or "https". - headers
Load
Balancer Monitor Header[] - The header name.
- 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. Defaults to
60
. - method string
- The method to use for the health check.
- modified
On string - The RFC3339 timestamp of when the load balancer monitor was last modified.
- path string
- The endpoint path to health check against.
- port number
- The port number to use for the healthcheck, required when creating a TCP monitor.
- probe
Zone string - Assign this monitor to emulate the specified zone while probing. Only valid if
type
is "http" or "https". - retries number
- 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 number
- The timeout (in seconds) before marking the health check as failed. Defaults to
5
. - type string
- The protocol to use for the healthcheck. Available values:
http
,https
,tcp
,udp_icmp
,icmp_ping
,smtp
. Defaults tohttp
.
- account_
id str - The account identifier to target for the resource.
- allow_
insecure bool - Do not validate the certificate when monitor use HTTPS. Only valid if
type
is "http" or "https". - consecutive_
down int - To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to
0
. - consecutive_
up int - To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to
0
. - created_
on str - The RFC3339 timestamp of when the load balancer monitor was created.
- description str
- Free text 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. Only valid if
type
is "http" or "https". - expected_
codes str - The expected HTTP response code or code range of the health check. Eg
2xx
. Only valid and required iftype
is "http" or "https". - follow_
redirects bool - Follow redirects if returned by the origin. Only valid if
type
is "http" or "https". - headers
Sequence[Load
Balancer Monitor Header Args] - The header name.
- 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. Defaults to
60
. - method str
- The method to use for the health check.
- modified_
on str - The RFC3339 timestamp of when the load balancer monitor was last modified.
- path str
- The endpoint path to health check against.
- port int
- The port number to use for the healthcheck, required when creating a TCP monitor.
- probe_
zone str - Assign this monitor to emulate the specified zone while probing. Only valid if
type
is "http" or "https". - retries int
- 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 int
- The timeout (in seconds) before marking the health check as failed. Defaults to
5
. - type str
- The protocol to use for the healthcheck. Available values:
http
,https
,tcp
,udp_icmp
,icmp_ping
,smtp
. Defaults tohttp
.
- account
Id String - The account identifier to target for the resource.
- allow
Insecure Boolean - Do not validate the certificate when monitor use HTTPS. Only valid if
type
is "http" or "https". - consecutive
Down Number - To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to
0
. - consecutive
Up Number - To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to
0
. - created
On String - The RFC3339 timestamp of when the load balancer monitor was created.
- description String
- Free text description.
- expected
Body 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. Only valid if
type
is "http" or "https". - expected
Codes String - The expected HTTP response code or code range of the health check. Eg
2xx
. Only valid and required iftype
is "http" or "https". - follow
Redirects Boolean - Follow redirects if returned by the origin. Only valid if
type
is "http" or "https". - headers List<Property Map>
- The header name.
- 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. Defaults to
60
. - method String
- The method to use for the health check.
- modified
On String - The RFC3339 timestamp of when the load balancer monitor was last modified.
- path String
- The endpoint path to health check against.
- port Number
- The port number to use for the healthcheck, required when creating a TCP monitor.
- probe
Zone String - Assign this monitor to emulate the specified zone while probing. Only valid if
type
is "http" or "https". - retries Number
- 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 Number
- The timeout (in seconds) before marking the health check as failed. Defaults to
5
. - type String
- The protocol to use for the healthcheck. Available values:
http
,https
,tcp
,udp_icmp
,icmp_ping
,smtp
. Defaults tohttp
.
Supporting Types
LoadBalancerMonitorHeader, LoadBalancerMonitorHeaderArgs
Import
$ pulumi import cloudflare:index/loadBalancerMonitor:LoadBalancerMonitor example <account_id>/<load_balancer_monitor_id>
Package Details
- Repository
- Cloudflare pulumi/pulumi-cloudflare
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
cloudflare
Terraform Provider.