1. Packages
  2. Packages
  3. Cloudflare Provider
  4. API Docs
  5. LoadBalancerMonitorGroup
Viewing docs for Cloudflare v6.18.0
published on Thursday, Jul 16, 2026 by Pulumi
cloudflare logo
Viewing docs for Cloudflare v6.18.0
published on Thursday, Jul 16, 2026 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const exampleLoadBalancerMonitorGroup = new cloudflare.LoadBalancerMonitorGroup("example_load_balancer_monitor_group", {
        accountId: "023e105f4ecef8ad9ca31a8372d0c353",
        description: "Primary datacenter monitors",
        members: [{
            enabled: true,
            monitorId: "monitor_id",
            monitoringOnly: false,
            mustBeHealthy: true,
        }],
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_load_balancer_monitor_group = cloudflare.LoadBalancerMonitorGroup("example_load_balancer_monitor_group",
        account_id="023e105f4ecef8ad9ca31a8372d0c353",
        description="Primary datacenter monitors",
        members=[{
            "enabled": True,
            "monitor_id": "monitor_id",
            "monitoring_only": False,
            "must_be_healthy": True,
        }])
    
    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.NewLoadBalancerMonitorGroup(ctx, "example_load_balancer_monitor_group", &cloudflare.LoadBalancerMonitorGroupArgs{
    			AccountId:   pulumi.String("023e105f4ecef8ad9ca31a8372d0c353"),
    			Description: pulumi.String("Primary datacenter monitors"),
    			Members: cloudflare.LoadBalancerMonitorGroupMemberArray{
    				&cloudflare.LoadBalancerMonitorGroupMemberArgs{
    					Enabled:        pulumi.Bool(true),
    					MonitorId:      pulumi.String("monitor_id"),
    					MonitoringOnly: pulumi.Bool(false),
    					MustBeHealthy:  pulumi.Bool(true),
    				},
    			},
    		})
    		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 exampleLoadBalancerMonitorGroup = new Cloudflare.LoadBalancerMonitorGroup("example_load_balancer_monitor_group", new()
        {
            AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
            Description = "Primary datacenter monitors",
            Members = new[]
            {
                new Cloudflare.Inputs.LoadBalancerMonitorGroupMemberArgs
                {
                    Enabled = true,
                    MonitorId = "monitor_id",
                    MonitoringOnly = false,
                    MustBeHealthy = true,
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.LoadBalancerMonitorGroup;
    import com.pulumi.cloudflare.LoadBalancerMonitorGroupArgs;
    import com.pulumi.cloudflare.inputs.LoadBalancerMonitorGroupMemberArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    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 exampleLoadBalancerMonitorGroup = new LoadBalancerMonitorGroup("exampleLoadBalancerMonitorGroup", LoadBalancerMonitorGroupArgs.builder()
                .accountId("023e105f4ecef8ad9ca31a8372d0c353")
                .description("Primary datacenter monitors")
                .members(LoadBalancerMonitorGroupMemberArgs.builder()
                    .enabled(true)
                    .monitorId("monitor_id")
                    .monitoringOnly(false)
                    .mustBeHealthy(true)
                    .build())
                .build());
    
        }
    }
    
    resources:
      exampleLoadBalancerMonitorGroup:
        type: cloudflare:LoadBalancerMonitorGroup
        name: example_load_balancer_monitor_group
        properties:
          accountId: 023e105f4ecef8ad9ca31a8372d0c353
          description: Primary datacenter monitors
          members:
            - enabled: true
              monitorId: monitor_id
              monitoringOnly: false
              mustBeHealthy: true
    
    pulumi {
      required_providers {
        cloudflare = {
          source = "pulumi/cloudflare"
        }
      }
    }
    
    resource "cloudflare_loadbalancermonitorgroup" "example_load_balancer_monitor_group" {
      account_id  = "023e105f4ecef8ad9ca31a8372d0c353"
      description = "Primary datacenter monitors"
      members {
        enabled         = true
        monitor_id      = "monitor_id"
        monitoring_only = false
        must_be_healthy = true
      }
    }
    

    Create LoadBalancerMonitorGroup Resource

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

    Constructor syntax

    new LoadBalancerMonitorGroup(name: string, args: LoadBalancerMonitorGroupArgs, opts?: CustomResourceOptions);
    @overload
    def LoadBalancerMonitorGroup(resource_name: str,
                                 args: LoadBalancerMonitorGroupArgs,
                                 opts: Optional[ResourceOptions] = None)
    
    @overload
    def LoadBalancerMonitorGroup(resource_name: str,
                                 opts: Optional[ResourceOptions] = None,
                                 account_id: Optional[str] = None,
                                 description: Optional[str] = None,
                                 members: Optional[Sequence[LoadBalancerMonitorGroupMemberArgs]] = None)
    func NewLoadBalancerMonitorGroup(ctx *Context, name string, args LoadBalancerMonitorGroupArgs, opts ...ResourceOption) (*LoadBalancerMonitorGroup, error)
    public LoadBalancerMonitorGroup(string name, LoadBalancerMonitorGroupArgs args, CustomResourceOptions? opts = null)
    public LoadBalancerMonitorGroup(String name, LoadBalancerMonitorGroupArgs args)
    public LoadBalancerMonitorGroup(String name, LoadBalancerMonitorGroupArgs args, CustomResourceOptions options)
    
    type: cloudflare:LoadBalancerMonitorGroup
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "cloudflare_load_balancer_monitor_group" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args LoadBalancerMonitorGroupArgs
    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 LoadBalancerMonitorGroupArgs
    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 LoadBalancerMonitorGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LoadBalancerMonitorGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LoadBalancerMonitorGroupArgs
    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 loadBalancerMonitorGroupResource = new Cloudflare.LoadBalancerMonitorGroup("loadBalancerMonitorGroupResource", new()
    {
        AccountId = "string",
        Description = "string",
        Members = new[]
        {
            new Cloudflare.Inputs.LoadBalancerMonitorGroupMemberArgs
            {
                Enabled = false,
                MonitorId = "string",
                MonitoringOnly = false,
                MustBeHealthy = false,
                CreatedAt = "string",
                UpdatedAt = "string",
            },
        },
    });
    
    example, err := cloudflare.NewLoadBalancerMonitorGroup(ctx, "loadBalancerMonitorGroupResource", &cloudflare.LoadBalancerMonitorGroupArgs{
    	AccountId:   pulumi.String("string"),
    	Description: pulumi.String("string"),
    	Members: cloudflare.LoadBalancerMonitorGroupMemberArray{
    		&cloudflare.LoadBalancerMonitorGroupMemberArgs{
    			Enabled:        pulumi.Bool(false),
    			MonitorId:      pulumi.String("string"),
    			MonitoringOnly: pulumi.Bool(false),
    			MustBeHealthy:  pulumi.Bool(false),
    			CreatedAt:      pulumi.String("string"),
    			UpdatedAt:      pulumi.String("string"),
    		},
    	},
    })
    
    resource "cloudflare_load_balancer_monitor_group" "loadBalancerMonitorGroupResource" {
      lifecycle {
        create_before_destroy = true
      }
      account_id  = "string"
      description = "string"
      members {
        enabled         = false
        monitor_id      = "string"
        monitoring_only = false
        must_be_healthy = false
        created_at      = "string"
        updated_at      = "string"
      }
    }
    
    var loadBalancerMonitorGroupResource = new LoadBalancerMonitorGroup("loadBalancerMonitorGroupResource", LoadBalancerMonitorGroupArgs.builder()
        .accountId("string")
        .description("string")
        .members(LoadBalancerMonitorGroupMemberArgs.builder()
            .enabled(false)
            .monitorId("string")
            .monitoringOnly(false)
            .mustBeHealthy(false)
            .createdAt("string")
            .updatedAt("string")
            .build())
        .build());
    
    load_balancer_monitor_group_resource = cloudflare.LoadBalancerMonitorGroup("loadBalancerMonitorGroupResource",
        account_id="string",
        description="string",
        members=[{
            "enabled": False,
            "monitor_id": "string",
            "monitoring_only": False,
            "must_be_healthy": False,
            "created_at": "string",
            "updated_at": "string",
        }])
    
    const loadBalancerMonitorGroupResource = new cloudflare.LoadBalancerMonitorGroup("loadBalancerMonitorGroupResource", {
        accountId: "string",
        description: "string",
        members: [{
            enabled: false,
            monitorId: "string",
            monitoringOnly: false,
            mustBeHealthy: false,
            createdAt: "string",
            updatedAt: "string",
        }],
    });
    
    type: cloudflare:LoadBalancerMonitorGroup
    properties:
        accountId: string
        description: string
        members:
            - createdAt: string
              enabled: false
              monitorId: string
              monitoringOnly: false
              mustBeHealthy: false
              updatedAt: string
    

    LoadBalancerMonitorGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The LoadBalancerMonitorGroup resource accepts the following input properties:

    AccountId string
    Identifier.
    Description string
    A short description of the monitor group
    Members List<LoadBalancerMonitorGroupMember>
    List of monitors in this group
    AccountId string
    Identifier.
    Description string
    A short description of the monitor group
    Members []LoadBalancerMonitorGroupMemberArgs
    List of monitors in this group
    account_id string
    Identifier.
    description string
    A short description of the monitor group
    members list(object)
    List of monitors in this group
    accountId String
    Identifier.
    description String
    A short description of the monitor group
    members List<LoadBalancerMonitorGroupMember>
    List of monitors in this group
    accountId string
    Identifier.
    description string
    A short description of the monitor group
    members LoadBalancerMonitorGroupMember[]
    List of monitors in this group
    account_id str
    Identifier.
    description str
    A short description of the monitor group
    members Sequence[LoadBalancerMonitorGroupMemberArgs]
    List of monitors in this group
    accountId String
    Identifier.
    description String
    A short description of the monitor group
    members List<Property Map>
    List of monitors in this group

    Outputs

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

    CreatedOn string
    The timestamp of when the monitor group was created
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedOn string
    The timestamp of when the monitor group was last updated
    CreatedOn string
    The timestamp of when the monitor group was created
    Id string
    The provider-assigned unique ID for this managed resource.
    ModifiedOn string
    The timestamp of when the monitor group was last updated
    created_on string
    The timestamp of when the monitor group was created
    id string
    The provider-assigned unique ID for this managed resource.
    modified_on string
    The timestamp of when the monitor group was last updated
    createdOn String
    The timestamp of when the monitor group was created
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedOn String
    The timestamp of when the monitor group was last updated
    createdOn string
    The timestamp of when the monitor group was created
    id string
    The provider-assigned unique ID for this managed resource.
    modifiedOn string
    The timestamp of when the monitor group was last updated
    created_on str
    The timestamp of when the monitor group was created
    id str
    The provider-assigned unique ID for this managed resource.
    modified_on str
    The timestamp of when the monitor group was last updated
    createdOn String
    The timestamp of when the monitor group was created
    id String
    The provider-assigned unique ID for this managed resource.
    modifiedOn String
    The timestamp of when the monitor group was last updated

    Look up Existing LoadBalancerMonitorGroup Resource

    Get an existing LoadBalancerMonitorGroup 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?: LoadBalancerMonitorGroupState, opts?: CustomResourceOptions): LoadBalancerMonitorGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            created_on: Optional[str] = None,
            description: Optional[str] = None,
            members: Optional[Sequence[LoadBalancerMonitorGroupMemberArgs]] = None,
            modified_on: Optional[str] = None) -> LoadBalancerMonitorGroup
    func GetLoadBalancerMonitorGroup(ctx *Context, name string, id IDInput, state *LoadBalancerMonitorGroupState, opts ...ResourceOption) (*LoadBalancerMonitorGroup, error)
    public static LoadBalancerMonitorGroup Get(string name, Input<string> id, LoadBalancerMonitorGroupState? state, CustomResourceOptions? opts = null)
    public static LoadBalancerMonitorGroup get(String name, Output<String> id, LoadBalancerMonitorGroupState state, CustomResourceOptions options)
    resources:  _:    type: cloudflare:LoadBalancerMonitorGroup    get:      id: ${id}
    import {
      to = cloudflare_load_balancer_monitor_group.example
      id = "${id}"
    }
    
    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
    Identifier.
    CreatedOn string
    The timestamp of when the monitor group was created
    Description string
    A short description of the monitor group
    Members List<LoadBalancerMonitorGroupMember>
    List of monitors in this group
    ModifiedOn string
    The timestamp of when the monitor group was last updated
    AccountId string
    Identifier.
    CreatedOn string
    The timestamp of when the monitor group was created
    Description string
    A short description of the monitor group
    Members []LoadBalancerMonitorGroupMemberArgs
    List of monitors in this group
    ModifiedOn string
    The timestamp of when the monitor group was last updated
    account_id string
    Identifier.
    created_on string
    The timestamp of when the monitor group was created
    description string
    A short description of the monitor group
    members list(object)
    List of monitors in this group
    modified_on string
    The timestamp of when the monitor group was last updated
    accountId String
    Identifier.
    createdOn String
    The timestamp of when the monitor group was created
    description String
    A short description of the monitor group
    members List<LoadBalancerMonitorGroupMember>
    List of monitors in this group
    modifiedOn String
    The timestamp of when the monitor group was last updated
    accountId string
    Identifier.
    createdOn string
    The timestamp of when the monitor group was created
    description string
    A short description of the monitor group
    members LoadBalancerMonitorGroupMember[]
    List of monitors in this group
    modifiedOn string
    The timestamp of when the monitor group was last updated
    account_id str
    Identifier.
    created_on str
    The timestamp of when the monitor group was created
    description str
    A short description of the monitor group
    members Sequence[LoadBalancerMonitorGroupMemberArgs]
    List of monitors in this group
    modified_on str
    The timestamp of when the monitor group was last updated
    accountId String
    Identifier.
    createdOn String
    The timestamp of when the monitor group was created
    description String
    A short description of the monitor group
    members List<Property Map>
    List of monitors in this group
    modifiedOn String
    The timestamp of when the monitor group was last updated

    Supporting Types

    LoadBalancerMonitorGroupMember, LoadBalancerMonitorGroupMemberArgs

    Enabled bool
    Whether this monitor is enabled in the group
    MonitorId string
    The ID of the Monitor to use for checking the health of origins within this pool.
    MonitoringOnly bool
    Whether this monitor is used for monitoring only (does not affect pool health)
    MustBeHealthy bool
    Whether this monitor must be healthy for the pool to be considered healthy
    CreatedAt string
    The timestamp of when the monitor was added to the group
    UpdatedAt string
    The timestamp of when the monitor group member was last updated
    Enabled bool
    Whether this monitor is enabled in the group
    MonitorId string
    The ID of the Monitor to use for checking the health of origins within this pool.
    MonitoringOnly bool
    Whether this monitor is used for monitoring only (does not affect pool health)
    MustBeHealthy bool
    Whether this monitor must be healthy for the pool to be considered healthy
    CreatedAt string
    The timestamp of when the monitor was added to the group
    UpdatedAt string
    The timestamp of when the monitor group member was last updated
    enabled bool
    Whether this monitor is enabled in the group
    monitor_id string
    The ID of the Monitor to use for checking the health of origins within this pool.
    monitoring_only bool
    Whether this monitor is used for monitoring only (does not affect pool health)
    must_be_healthy bool
    Whether this monitor must be healthy for the pool to be considered healthy
    created_at string
    The timestamp of when the monitor was added to the group
    updated_at string
    The timestamp of when the monitor group member was last updated
    enabled Boolean
    Whether this monitor is enabled in the group
    monitorId String
    The ID of the Monitor to use for checking the health of origins within this pool.
    monitoringOnly Boolean
    Whether this monitor is used for monitoring only (does not affect pool health)
    mustBeHealthy Boolean
    Whether this monitor must be healthy for the pool to be considered healthy
    createdAt String
    The timestamp of when the monitor was added to the group
    updatedAt String
    The timestamp of when the monitor group member was last updated
    enabled boolean
    Whether this monitor is enabled in the group
    monitorId string
    The ID of the Monitor to use for checking the health of origins within this pool.
    monitoringOnly boolean
    Whether this monitor is used for monitoring only (does not affect pool health)
    mustBeHealthy boolean
    Whether this monitor must be healthy for the pool to be considered healthy
    createdAt string
    The timestamp of when the monitor was added to the group
    updatedAt string
    The timestamp of when the monitor group member was last updated
    enabled bool
    Whether this monitor is enabled in the group
    monitor_id str
    The ID of the Monitor to use for checking the health of origins within this pool.
    monitoring_only bool
    Whether this monitor is used for monitoring only (does not affect pool health)
    must_be_healthy bool
    Whether this monitor must be healthy for the pool to be considered healthy
    created_at str
    The timestamp of when the monitor was added to the group
    updated_at str
    The timestamp of when the monitor group member was last updated
    enabled Boolean
    Whether this monitor is enabled in the group
    monitorId String
    The ID of the Monitor to use for checking the health of origins within this pool.
    monitoringOnly Boolean
    Whether this monitor is used for monitoring only (does not affect pool health)
    mustBeHealthy Boolean
    Whether this monitor must be healthy for the pool to be considered healthy
    createdAt String
    The timestamp of when the monitor was added to the group
    updatedAt String
    The timestamp of when the monitor group member was last updated

    Import

    $ pulumi import cloudflare:index/loadBalancerMonitorGroup:LoadBalancerMonitorGroup example '<account_id>/<monitor_group_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
    Viewing docs for Cloudflare v6.18.0
    published on Thursday, Jul 16, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial