1. Packages
  2. Cloudflare
  3. API Docs
  4. LoadBalancerMonitor
Cloudflare v5.34.0 published on Friday, Jul 12, 2024 by Pulumi

cloudflare.LoadBalancerMonitor

Explore with Pulumi AI

cloudflare logo
Cloudflare v5.34.0 published on Friday, Jul 12, 2024 by Pulumi

    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.

    Create LoadBalancerMonitor Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new LoadBalancerMonitor(name: string, args: LoadBalancerMonitorArgs, opts?: CustomResourceOptions);
    @overload
    def LoadBalancerMonitor(resource_name: str,
                            args: LoadBalancerMonitorArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @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)
    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.
    
    

    Parameters

    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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var loadBalancerMonitorResource = new Cloudflare.LoadBalancerMonitor("loadBalancerMonitorResource", new()
    {
        AccountId = "string",
        AllowInsecure = false,
        ConsecutiveDown = 0,
        ConsecutiveUp = 0,
        Description = "string",
        ExpectedBody = "string",
        ExpectedCodes = "string",
        FollowRedirects = false,
        Headers = new[]
        {
            new Cloudflare.Inputs.LoadBalancerMonitorHeaderArgs
            {
                Header = "string",
                Values = new[]
                {
                    "string",
                },
            },
        },
        Interval = 0,
        Method = "string",
        Path = "string",
        Port = 0,
        ProbeZone = "string",
        Retries = 0,
        Timeout = 0,
        Type = "string",
    });
    
    example, err := cloudflare.NewLoadBalancerMonitor(ctx, "loadBalancerMonitorResource", &cloudflare.LoadBalancerMonitorArgs{
    	AccountId:       pulumi.String("string"),
    	AllowInsecure:   pulumi.Bool(false),
    	ConsecutiveDown: pulumi.Int(0),
    	ConsecutiveUp:   pulumi.Int(0),
    	Description:     pulumi.String("string"),
    	ExpectedBody:    pulumi.String("string"),
    	ExpectedCodes:   pulumi.String("string"),
    	FollowRedirects: pulumi.Bool(false),
    	Headers: cloudflare.LoadBalancerMonitorHeaderArray{
    		&cloudflare.LoadBalancerMonitorHeaderArgs{
    			Header: pulumi.String("string"),
    			Values: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    		},
    	},
    	Interval:  pulumi.Int(0),
    	Method:    pulumi.String("string"),
    	Path:      pulumi.String("string"),
    	Port:      pulumi.Int(0),
    	ProbeZone: pulumi.String("string"),
    	Retries:   pulumi.Int(0),
    	Timeout:   pulumi.Int(0),
    	Type:      pulumi.String("string"),
    })
    
    var loadBalancerMonitorResource = new LoadBalancerMonitor("loadBalancerMonitorResource", LoadBalancerMonitorArgs.builder()
        .accountId("string")
        .allowInsecure(false)
        .consecutiveDown(0)
        .consecutiveUp(0)
        .description("string")
        .expectedBody("string")
        .expectedCodes("string")
        .followRedirects(false)
        .headers(LoadBalancerMonitorHeaderArgs.builder()
            .header("string")
            .values("string")
            .build())
        .interval(0)
        .method("string")
        .path("string")
        .port(0)
        .probeZone("string")
        .retries(0)
        .timeout(0)
        .type("string")
        .build());
    
    load_balancer_monitor_resource = cloudflare.LoadBalancerMonitor("loadBalancerMonitorResource",
        account_id="string",
        allow_insecure=False,
        consecutive_down=0,
        consecutive_up=0,
        description="string",
        expected_body="string",
        expected_codes="string",
        follow_redirects=False,
        headers=[cloudflare.LoadBalancerMonitorHeaderArgs(
            header="string",
            values=["string"],
        )],
        interval=0,
        method="string",
        path="string",
        port=0,
        probe_zone="string",
        retries=0,
        timeout=0,
        type="string")
    
    const loadBalancerMonitorResource = new cloudflare.LoadBalancerMonitor("loadBalancerMonitorResource", {
        accountId: "string",
        allowInsecure: false,
        consecutiveDown: 0,
        consecutiveUp: 0,
        description: "string",
        expectedBody: "string",
        expectedCodes: "string",
        followRedirects: false,
        headers: [{
            header: "string",
            values: ["string"],
        }],
        interval: 0,
        method: "string",
        path: "string",
        port: 0,
        probeZone: "string",
        retries: 0,
        timeout: 0,
        type: "string",
    });
    
    type: cloudflare:LoadBalancerMonitor
    properties:
        accountId: string
        allowInsecure: false
        consecutiveDown: 0
        consecutiveUp: 0
        description: string
        expectedBody: string
        expectedCodes: string
        followRedirects: false
        headers:
            - header: string
              values:
                - string
        interval: 0
        method: string
        path: string
        port: 0
        probeZone: string
        retries: 0
        timeout: 0
        type: string
    

    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:

    AccountId string
    The account identifier to target for the resource.
    AllowInsecure bool
    Do not validate the certificate when monitor use HTTPS. Only valid if type is "http" or "https".
    ConsecutiveDown int
    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to 0.
    ConsecutiveUp int
    To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to 0.
    Description string
    Free text 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. Only valid if type is "http" or "https".
    ExpectedCodes string
    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 bool
    Follow redirects if returned by the origin. Only valid if type is "http" or "https".
    Headers List<LoadBalancerMonitorHeader>
    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 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.
    ProbeZone 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 to http.
    AccountId string
    The account identifier to target for the resource.
    AllowInsecure bool
    Do not validate the certificate when monitor use HTTPS. Only valid if type is "http" or "https".
    ConsecutiveDown int
    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to 0.
    ConsecutiveUp int
    To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to 0.
    Description string
    Free text 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. Only valid if type is "http" or "https".
    ExpectedCodes string
    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 bool
    Follow redirects if returned by the origin. Only valid if type is "http" or "https".
    Headers []LoadBalancerMonitorHeaderArgs
    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 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.
    ProbeZone 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 to http.
    accountId String
    The account identifier to target for the resource.
    allowInsecure Boolean
    Do not validate the certificate when monitor use HTTPS. Only valid if type is "http" or "https".
    consecutiveDown Integer
    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to 0.
    consecutiveUp Integer
    To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to 0.
    description String
    Free text 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. Only valid if type is "http" or "https".
    expectedCodes String
    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 Boolean
    Follow redirects if returned by the origin. Only valid if type is "http" or "https".
    headers List<LoadBalancerMonitorHeader>
    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 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.
    probeZone 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 to http.
    accountId string
    The account identifier to target for the resource.
    allowInsecure boolean
    Do not validate the certificate when monitor use HTTPS. Only valid if type is "http" or "https".
    consecutiveDown number
    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to 0.
    consecutiveUp number
    To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to 0.
    description string
    Free text 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. Only valid if type is "http" or "https".
    expectedCodes string
    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 boolean
    Follow redirects if returned by the origin. Only valid if type is "http" or "https".
    headers LoadBalancerMonitorHeader[]
    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 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.
    probeZone 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 to http.
    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 if type is "http" or "https".
    follow_redirects bool
    Follow redirects if returned by the origin. Only valid if type is "http" or "https".
    headers Sequence[LoadBalancerMonitorHeaderArgs]
    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 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 to http.
    accountId String
    The account identifier to target for the resource.
    allowInsecure Boolean
    Do not validate the certificate when monitor use HTTPS. Only valid if type is "http" or "https".
    consecutiveDown Number
    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to 0.
    consecutiveUp Number
    To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to 0.
    description String
    Free text 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. Only valid if type is "http" or "https".
    expectedCodes String
    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 Boolean
    Follow redirects if returned by the origin. Only valid if type is "http" or "https".
    headers List<Property Map>
    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 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.
    probeZone 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 to http.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the LoadBalancerMonitor resource produces the following output properties:

    CreatedOn string
    The RFC3339 timestamp of when the load balancer monitor was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedOn string
    The RFC3339 timestamp of when the load balancer monitor was last modified.
    CreatedOn string
    The RFC3339 timestamp of when the load balancer monitor was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedOn string
    The RFC3339 timestamp of when the load balancer monitor was last modified.
    createdOn String
    The RFC3339 timestamp of when the load balancer monitor was created.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedOn String
    The RFC3339 timestamp of when the load balancer monitor was last modified.
    createdOn string
    The RFC3339 timestamp of when the load balancer monitor was created.
    id string
    The provider-assigned unique ID for this managed resource.
    modifiedOn 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.
    createdOn String
    The RFC3339 timestamp of when the load balancer monitor was created.
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedOn 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.
    The following state arguments are supported:
    AccountId string
    The account identifier to target for the resource.
    AllowInsecure bool
    Do not validate the certificate when monitor use HTTPS. Only valid if type is "http" or "https".
    ConsecutiveDown int
    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to 0.
    ConsecutiveUp int
    To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to 0.
    CreatedOn string
    The RFC3339 timestamp of when the load balancer monitor was created.
    Description string
    Free text 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. Only valid if type is "http" or "https".
    ExpectedCodes string
    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 bool
    Follow redirects if returned by the origin. Only valid if type is "http" or "https".
    Headers List<LoadBalancerMonitorHeader>
    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 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.
    ModifiedOn 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.
    ProbeZone 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 to http.
    AccountId string
    The account identifier to target for the resource.
    AllowInsecure bool
    Do not validate the certificate when monitor use HTTPS. Only valid if type is "http" or "https".
    ConsecutiveDown int
    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to 0.
    ConsecutiveUp int
    To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to 0.
    CreatedOn string
    The RFC3339 timestamp of when the load balancer monitor was created.
    Description string
    Free text 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. Only valid if type is "http" or "https".
    ExpectedCodes string
    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 bool
    Follow redirects if returned by the origin. Only valid if type is "http" or "https".
    Headers []LoadBalancerMonitorHeaderArgs
    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 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.
    ModifiedOn 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.
    ProbeZone 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 to http.
    accountId String
    The account identifier to target for the resource.
    allowInsecure Boolean
    Do not validate the certificate when monitor use HTTPS. Only valid if type is "http" or "https".
    consecutiveDown Integer
    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to 0.
    consecutiveUp Integer
    To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to 0.
    createdOn String
    The RFC3339 timestamp of when the load balancer monitor was created.
    description String
    Free text 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. Only valid if type is "http" or "https".
    expectedCodes String
    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 Boolean
    Follow redirects if returned by the origin. Only valid if type is "http" or "https".
    headers List<LoadBalancerMonitorHeader>
    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 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.
    modifiedOn 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.
    probeZone 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 to http.
    accountId string
    The account identifier to target for the resource.
    allowInsecure boolean
    Do not validate the certificate when monitor use HTTPS. Only valid if type is "http" or "https".
    consecutiveDown number
    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to 0.
    consecutiveUp number
    To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to 0.
    createdOn string
    The RFC3339 timestamp of when the load balancer monitor was created.
    description string
    Free text 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. Only valid if type is "http" or "https".
    expectedCodes string
    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 boolean
    Follow redirects if returned by the origin. Only valid if type is "http" or "https".
    headers LoadBalancerMonitorHeader[]
    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 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.
    modifiedOn 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.
    probeZone 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 to http.
    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 if type is "http" or "https".
    follow_redirects bool
    Follow redirects if returned by the origin. Only valid if type is "http" or "https".
    headers Sequence[LoadBalancerMonitorHeaderArgs]
    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 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 to http.
    accountId String
    The account identifier to target for the resource.
    allowInsecure Boolean
    Do not validate the certificate when monitor use HTTPS. Only valid if type is "http" or "https".
    consecutiveDown Number
    To be marked unhealthy the monitored origin must fail this healthcheck N consecutive times. Defaults to 0.
    consecutiveUp Number
    To be marked healthy the monitored origin must pass this healthcheck N consecutive times. Defaults to 0.
    createdOn String
    The RFC3339 timestamp of when the load balancer monitor was created.
    description String
    Free text 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. Only valid if type is "http" or "https".
    expectedCodes String
    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 Boolean
    Follow redirects if returned by the origin. Only valid if type is "http" or "https".
    headers List<Property Map>
    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 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.
    modifiedOn 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.
    probeZone 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 to http.

    Supporting Types

    LoadBalancerMonitorHeader, LoadBalancerMonitorHeaderArgs

    Header string
    The header name.
    Values List<string>
    A list of values for the header.
    Header string
    The header name.
    Values []string
    A list of values for the header.
    header String
    The header name.
    values List<String>
    A list of values for the header.
    header string
    The header name.
    values string[]
    A list of values for the header.
    header str
    The header name.
    values Sequence[str]
    A list of values for the header.
    header String
    The header name.
    values List<String>
    A list of values for the header.

    Import

    $ pulumi import cloudflare:index/loadBalancerMonitor:LoadBalancerMonitor example <account_id>/<load_balancer_monitor_id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    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 v5.34.0 published on Friday, Jul 12, 2024 by Pulumi