Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Datadog Provider
  3. API Docs
  4. Monitor
Datadog v4.36.1 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-datadog

datadog.Monitor

Explore with Pulumi AI

datadog logo
Datadog v4.36.1 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-datadog

    Provides a Datadog monitor resource. This can be used to create and manage Datadog monitors.

    Example Usage

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

const foo = new datadog.Monitor("foo", {
    name: "Name for monitor foo",
    type: "metric alert",
    message: "Monitor triggered. Notify: @hipchat-channel",
    escalationMessage: "Escalation message @pagerduty",
    query: "avg(last_1h):avg:aws.ec2.cpu{environment:foo,host:foo} by {host} > 4",
    monitorThresholds: {
        warning: "2",
        critical: "4",
    },
    includeTags: true,
    tags: [
        "foo:bar",
        "team:fooBar",
    ],
});

    import pulumi
import pulumi_datadog as datadog

foo = datadog.Monitor("foo",
    name="Name for monitor foo",
    type="metric alert",
    message="Monitor triggered. Notify: @hipchat-channel",
    escalation_message="Escalation message @pagerduty",
    query="avg(last_1h):avg:aws.ec2.cpu{environment:foo,host:foo} by {host} > 4",
    monitor_thresholds={
        "warning": "2",
        "critical": "4",
    },
    include_tags=True,
    tags=[
        "foo:bar",
        "team:fooBar",
    ])

    package main

import (
	"github.com/pulumi/pulumi-datadog/sdk/v4/go/datadog"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := datadog.NewMonitor(ctx, "foo", &datadog.MonitorArgs{
			Name:              pulumi.String("Name for monitor foo"),
			Type:              pulumi.String("metric alert"),
			Message:           pulumi.String("Monitor triggered. Notify: @hipchat-channel"),
			EscalationMessage: pulumi.String("Escalation message @pagerduty"),
			Query:             pulumi.String("avg(last_1h):avg:aws.ec2.cpu{environment:foo,host:foo} by {host} > 4"),
			MonitorThresholds: &datadog.MonitorMonitorThresholdsArgs{
				Warning:  pulumi.String("2"),
				Critical: pulumi.String("4"),
			},
			IncludeTags: pulumi.Bool(true),
			Tags: pulumi.StringArray{
				pulumi.String("foo:bar"),
				pulumi.String("team:fooBar"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var foo = new Datadog.Monitor("foo", new()
    {
        Name = "Name for monitor foo",
        Type = "metric alert",
        Message = "Monitor triggered. Notify: @hipchat-channel",
        EscalationMessage = "Escalation message @pagerduty",
        Query = "avg(last_1h):avg:aws.ec2.cpu{environment:foo,host:foo} by {host} > 4",
        MonitorThresholds = new Datadog.Inputs.MonitorMonitorThresholdsArgs
        {
            Warning = "2",
            Critical = "4",
        },
        IncludeTags = true,
        Tags = new[]
        {
            "foo:bar",
            "team:fooBar",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datadog.Monitor;
import com.pulumi.datadog.MonitorArgs;
import com.pulumi.datadog.inputs.MonitorMonitorThresholdsArgs;
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 foo = new Monitor("foo", MonitorArgs.builder()
            .name("Name for monitor foo")
            .type("metric alert")
            .message("Monitor triggered. Notify: @hipchat-channel")
            .escalationMessage("Escalation message @pagerduty")
            .query("avg(last_1h):avg:aws.ec2.cpu{environment:foo,host:foo} by {host} > 4")
            .monitorThresholds(MonitorMonitorThresholdsArgs.builder()
                .warning(2)
                .critical(4)
                .build())
            .includeTags(true)
            .tags(            
                "foo:bar",
                "team:fooBar")
            .build());

    }
}

    resources:
  foo:
    type: datadog:Monitor
    properties:
      name: Name for monitor foo
      type: metric alert
      message: 'Monitor triggered. Notify: @hipchat-channel'
      escalationMessage: Escalation message @pagerduty
      query: avg(last_1h):avg:aws.ec2.cpu{environment:foo,host:foo} by {host} > 4
      monitorThresholds:
        warning: 2
        critical: 4
      includeTags: true
      tags:
        - foo:bar
        - team:fooBar

    Create Monitor Resource

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

    Constructor syntax

    new Monitor(name: string, args: MonitorArgs, opts?: CustomResourceOptions);
    @overload
def Monitor(resource_name: str,
            args: MonitorArgs,
            opts: Optional[ResourceOptions] = None)

@overload
def Monitor(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            message: Optional[str] = None,
            type: Optional[str] = None,
            query: Optional[str] = None,
            name: Optional[str] = None,
            notify_audit: Optional[bool] = None,
            on_missing_data: Optional[str] = None,
            include_tags: Optional[bool] = None,
            locked: Optional[bool] = None,
            group_retention_duration: Optional[str] = None,
            monitor_threshold_windows: Optional[MonitorMonitorThresholdWindowsArgs] = None,
            monitor_thresholds: Optional[MonitorMonitorThresholdsArgs] = None,
            force_delete: Optional[bool] = None,
            new_group_delay: Optional[int] = None,
            new_host_delay: Optional[int] = None,
            no_data_timeframe: Optional[int] = None,
            notification_preset_name: Optional[str] = None,
            enable_logs_sample: Optional[bool] = None,
            notify_bies: Optional[Sequence[str]] = None,
            notify_no_data: Optional[bool] = None,
            groupby_simple_monitor: Optional[bool] = None,
            priority: Optional[str] = None,
            evaluation_delay: Optional[int] = None,
            renotify_interval: Optional[int] = None,
            renotify_occurrences: Optional[int] = None,
            renotify_statuses: Optional[Sequence[str]] = None,
            require_full_window: Optional[bool] = None,
            restricted_roles: Optional[Sequence[str]] = None,
            scheduling_options: Optional[Sequence[MonitorSchedulingOptionArgs]] = None,
            tags: Optional[Sequence[str]] = None,
            timeout_h: Optional[int] = None,
            escalation_message: Optional[str] = None,
            validate: Optional[bool] = None,
            variables: Optional[MonitorVariablesArgs] = None)
    func NewMonitor(ctx *Context, name string, args MonitorArgs, opts ...ResourceOption) (*Monitor, error)
    public Monitor(string name, MonitorArgs args, CustomResourceOptions? opts = null)
    public Monitor(String name, MonitorArgs args)
public Monitor(String name, MonitorArgs args, CustomResourceOptions options)

    type: datadog:Monitor
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 MonitorArgs
    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 MonitorArgs
    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 MonitorArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MonitorArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MonitorArgs
    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 monitorResource = new Datadog.Monitor("monitorResource", new()
{
    Message = "string",
    Type = "string",
    Query = "string",
    Name = "string",
    NotifyAudit = false,
    OnMissingData = "string",
    IncludeTags = false,
    GroupRetentionDuration = "string",
    MonitorThresholdWindows = new Datadog.Inputs.MonitorMonitorThresholdWindowsArgs
    {
        RecoveryWindow = "string",
        TriggerWindow = "string",
    },
    MonitorThresholds = new Datadog.Inputs.MonitorMonitorThresholdsArgs
    {
        Critical = "string",
        CriticalRecovery = "string",
        Ok = "string",
        Unknown = "string",
        Warning = "string",
        WarningRecovery = "string",
    },
    ForceDelete = false,
    NewGroupDelay = 0,
    NoDataTimeframe = 0,
    NotificationPresetName = "string",
    EnableLogsSample = false,
    NotifyBies = new[]
    {
        "string",
    },
    NotifyNoData = false,
    GroupbySimpleMonitor = false,
    Priority = "string",
    EvaluationDelay = 0,
    RenotifyInterval = 0,
    RenotifyOccurrences = 0,
    RenotifyStatuses = new[]
    {
        "string",
    },
    RequireFullWindow = false,
    RestrictedRoles = new[]
    {
        "string",
    },
    SchedulingOptions = new[]
    {
        new Datadog.Inputs.MonitorSchedulingOptionArgs
        {
            CustomSchedules = new[]
            {
                new Datadog.Inputs.MonitorSchedulingOptionCustomScheduleArgs
                {
                    Recurrence = new Datadog.Inputs.MonitorSchedulingOptionCustomScheduleRecurrenceArgs
                    {
                        Rrule = "string",
                        Timezone = "string",
                        Start = "string",
                    },
                },
            },
            EvaluationWindows = new[]
            {
                new Datadog.Inputs.MonitorSchedulingOptionEvaluationWindowArgs
                {
                    DayStarts = "string",
                    HourStarts = 0,
                    MonthStarts = 0,
                },
            },
        },
    },
    Tags = new[]
    {
        "string",
    },
    TimeoutH = 0,
    EscalationMessage = "string",
    Validate = false,
    Variables = new Datadog.Inputs.MonitorVariablesArgs
    {
        EventQueries = new[]
        {
            new Datadog.Inputs.MonitorVariablesEventQueryArgs
            {
                Computes = new[]
                {
                    new Datadog.Inputs.MonitorVariablesEventQueryComputeArgs
                    {
                        Aggregation = "string",
                        Interval = 0,
                        Metric = "string",
                    },
                },
                DataSource = "string",
                Name = "string",
                Search = new Datadog.Inputs.MonitorVariablesEventQuerySearchArgs
                {
                    Query = "string",
                },
                GroupBies = new[]
                {
                    new Datadog.Inputs.MonitorVariablesEventQueryGroupByArgs
                    {
                        Facet = "string",
                        Limit = 0,
                        Sort = new Datadog.Inputs.MonitorVariablesEventQueryGroupBySortArgs
                        {
                            Aggregation = "string",
                            Metric = "string",
                            Order = "string",
                        },
                    },
                },
                Indexes = new[]
                {
                    "string",
                },
            },
        },
    },
});

    example, err := datadog.NewMonitor(ctx, "monitorResource", &datadog.MonitorArgs{
	Message:                pulumi.String("string"),
	Type:                   pulumi.String("string"),
	Query:                  pulumi.String("string"),
	Name:                   pulumi.String("string"),
	NotifyAudit:            pulumi.Bool(false),
	OnMissingData:          pulumi.String("string"),
	IncludeTags:            pulumi.Bool(false),
	GroupRetentionDuration: pulumi.String("string"),
	MonitorThresholdWindows: &datadog.MonitorMonitorThresholdWindowsArgs{
		RecoveryWindow: pulumi.String("string"),
		TriggerWindow:  pulumi.String("string"),
	},
	MonitorThresholds: &datadog.MonitorMonitorThresholdsArgs{
		Critical:         pulumi.String("string"),
		CriticalRecovery: pulumi.String("string"),
		Ok:               pulumi.String("string"),
		Unknown:          pulumi.String("string"),
		Warning:          pulumi.String("string"),
		WarningRecovery:  pulumi.String("string"),
	},
	ForceDelete:            pulumi.Bool(false),
	NewGroupDelay:          pulumi.Int(0),
	NoDataTimeframe:        pulumi.Int(0),
	NotificationPresetName: pulumi.String("string"),
	EnableLogsSample:       pulumi.Bool(false),
	NotifyBies: pulumi.StringArray{
		pulumi.String("string"),
	},
	NotifyNoData:         pulumi.Bool(false),
	GroupbySimpleMonitor: pulumi.Bool(false),
	Priority:             pulumi.String("string"),
	EvaluationDelay:      pulumi.Int(0),
	RenotifyInterval:     pulumi.Int(0),
	RenotifyOccurrences:  pulumi.Int(0),
	RenotifyStatuses: pulumi.StringArray{
		pulumi.String("string"),
	},
	RequireFullWindow: pulumi.Bool(false),
	RestrictedRoles: pulumi.StringArray{
		pulumi.String("string"),
	},
	SchedulingOptions: datadog.MonitorSchedulingOptionArray{
		&datadog.MonitorSchedulingOptionArgs{
			CustomSchedules: datadog.MonitorSchedulingOptionCustomScheduleArray{
				&datadog.MonitorSchedulingOptionCustomScheduleArgs{
					Recurrence: &datadog.MonitorSchedulingOptionCustomScheduleRecurrenceArgs{
						Rrule:    pulumi.String("string"),
						Timezone: pulumi.String("string"),
						Start:    pulumi.String("string"),
					},
				},
			},
			EvaluationWindows: datadog.MonitorSchedulingOptionEvaluationWindowArray{
				&datadog.MonitorSchedulingOptionEvaluationWindowArgs{
					DayStarts:   pulumi.String("string"),
					HourStarts:  pulumi.Int(0),
					MonthStarts: pulumi.Int(0),
				},
			},
		},
	},
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	TimeoutH:          pulumi.Int(0),
	EscalationMessage: pulumi.String("string"),
	Validate:          pulumi.Bool(false),
	Variables: &datadog.MonitorVariablesArgs{
		EventQueries: datadog.MonitorVariablesEventQueryArray{
			&datadog.MonitorVariablesEventQueryArgs{
				Computes: datadog.MonitorVariablesEventQueryComputeArray{
					&datadog.MonitorVariablesEventQueryComputeArgs{
						Aggregation: pulumi.String("string"),
						Interval:    pulumi.Int(0),
						Metric:      pulumi.String("string"),
					},
				},
				DataSource: pulumi.String("string"),
				Name:       pulumi.String("string"),
				Search: &datadog.MonitorVariablesEventQuerySearchArgs{
					Query: pulumi.String("string"),
				},
				GroupBies: datadog.MonitorVariablesEventQueryGroupByArray{
					&datadog.MonitorVariablesEventQueryGroupByArgs{
						Facet: pulumi.String("string"),
						Limit: pulumi.Int(0),
						Sort: &datadog.MonitorVariablesEventQueryGroupBySortArgs{
							Aggregation: pulumi.String("string"),
							Metric:      pulumi.String("string"),
							Order:       pulumi.String("string"),
						},
					},
				},
				Indexes: pulumi.StringArray{
					pulumi.String("string"),
				},
			},
		},
	},
})

    var monitorResource = new Monitor("monitorResource", MonitorArgs.builder()
    .message("string")
    .type("string")
    .query("string")
    .name("string")
    .notifyAudit(false)
    .onMissingData("string")
    .includeTags(false)
    .groupRetentionDuration("string")
    .monitorThresholdWindows(MonitorMonitorThresholdWindowsArgs.builder()
        .recoveryWindow("string")
        .triggerWindow("string")
        .build())
    .monitorThresholds(MonitorMonitorThresholdsArgs.builder()
        .critical("string")
        .criticalRecovery("string")
        .ok("string")
        .unknown("string")
        .warning("string")
        .warningRecovery("string")
        .build())
    .forceDelete(false)
    .newGroupDelay(0)
    .noDataTimeframe(0)
    .notificationPresetName("string")
    .enableLogsSample(false)
    .notifyBies("string")
    .notifyNoData(false)
    .groupbySimpleMonitor(false)
    .priority("string")
    .evaluationDelay(0)
    .renotifyInterval(0)
    .renotifyOccurrences(0)
    .renotifyStatuses("string")
    .requireFullWindow(false)
    .restrictedRoles("string")
    .schedulingOptions(MonitorSchedulingOptionArgs.builder()
        .customSchedules(MonitorSchedulingOptionCustomScheduleArgs.builder()
            .recurrence(MonitorSchedulingOptionCustomScheduleRecurrenceArgs.builder()
                .rrule("string")
                .timezone("string")
                .start("string")
                .build())
            .build())
        .evaluationWindows(MonitorSchedulingOptionEvaluationWindowArgs.builder()
            .dayStarts("string")
            .hourStarts(0)
            .monthStarts(0)
            .build())
        .build())
    .tags("string")
    .timeoutH(0)
    .escalationMessage("string")
    .validate(false)
    .variables(MonitorVariablesArgs.builder()
        .eventQueries(MonitorVariablesEventQueryArgs.builder()
            .computes(MonitorVariablesEventQueryComputeArgs.builder()
                .aggregation("string")
                .interval(0)
                .metric("string")
                .build())
            .dataSource("string")
            .name("string")
            .search(MonitorVariablesEventQuerySearchArgs.builder()
                .query("string")
                .build())
            .groupBies(MonitorVariablesEventQueryGroupByArgs.builder()
                .facet("string")
                .limit(0)
                .sort(MonitorVariablesEventQueryGroupBySortArgs.builder()
                    .aggregation("string")
                    .metric("string")
                    .order("string")
                    .build())
                .build())
            .indexes("string")
            .build())
        .build())
    .build());

    monitor_resource = datadog.Monitor("monitorResource",
    message="string",
    type="string",
    query="string",
    name="string",
    notify_audit=False,
    on_missing_data="string",
    include_tags=False,
    group_retention_duration="string",
    monitor_threshold_windows={
        "recovery_window": "string",
        "trigger_window": "string",
    },
    monitor_thresholds={
        "critical": "string",
        "critical_recovery": "string",
        "ok": "string",
        "unknown": "string",
        "warning": "string",
        "warning_recovery": "string",
    },
    force_delete=False,
    new_group_delay=0,
    no_data_timeframe=0,
    notification_preset_name="string",
    enable_logs_sample=False,
    notify_bies=["string"],
    notify_no_data=False,
    groupby_simple_monitor=False,
    priority="string",
    evaluation_delay=0,
    renotify_interval=0,
    renotify_occurrences=0,
    renotify_statuses=["string"],
    require_full_window=False,
    restricted_roles=["string"],
    scheduling_options=[{
        "custom_schedules": [{
            "recurrence": {
                "rrule": "string",
                "timezone": "string",
                "start": "string",
            },
        }],
        "evaluation_windows": [{
            "day_starts": "string",
            "hour_starts": 0,
            "month_starts": 0,
        }],
    }],
    tags=["string"],
    timeout_h=0,
    escalation_message="string",
    validate=False,
    variables={
        "event_queries": [{
            "computes": [{
                "aggregation": "string",
                "interval": 0,
                "metric": "string",
            }],
            "data_source": "string",
            "name": "string",
            "search": {
                "query": "string",
            },
            "group_bies": [{
                "facet": "string",
                "limit": 0,
                "sort": {
                    "aggregation": "string",
                    "metric": "string",
                    "order": "string",
                },
            }],
            "indexes": ["string"],
        }],
    })

    const monitorResource = new datadog.Monitor("monitorResource", {
    message: "string",
    type: "string",
    query: "string",
    name: "string",
    notifyAudit: false,
    onMissingData: "string",
    includeTags: false,
    groupRetentionDuration: "string",
    monitorThresholdWindows: {
        recoveryWindow: "string",
        triggerWindow: "string",
    },
    monitorThresholds: {
        critical: "string",
        criticalRecovery: "string",
        ok: "string",
        unknown: "string",
        warning: "string",
        warningRecovery: "string",
    },
    forceDelete: false,
    newGroupDelay: 0,
    noDataTimeframe: 0,
    notificationPresetName: "string",
    enableLogsSample: false,
    notifyBies: ["string"],
    notifyNoData: false,
    groupbySimpleMonitor: false,
    priority: "string",
    evaluationDelay: 0,
    renotifyInterval: 0,
    renotifyOccurrences: 0,
    renotifyStatuses: ["string"],
    requireFullWindow: false,
    restrictedRoles: ["string"],
    schedulingOptions: [{
        customSchedules: [{
            recurrence: {
                rrule: "string",
                timezone: "string",
                start: "string",
            },
        }],
        evaluationWindows: [{
            dayStarts: "string",
            hourStarts: 0,
            monthStarts: 0,
        }],
    }],
    tags: ["string"],
    timeoutH: 0,
    escalationMessage: "string",
    validate: false,
    variables: {
        eventQueries: [{
            computes: [{
                aggregation: "string",
                interval: 0,
                metric: "string",
            }],
            dataSource: "string",
            name: "string",
            search: {
                query: "string",
            },
            groupBies: [{
                facet: "string",
                limit: 0,
                sort: {
                    aggregation: "string",
                    metric: "string",
                    order: "string",
                },
            }],
            indexes: ["string"],
        }],
    },
});

    type: datadog:Monitor
properties:
    enableLogsSample: false
    escalationMessage: string
    evaluationDelay: 0
    forceDelete: false
    groupRetentionDuration: string
    groupbySimpleMonitor: false
    includeTags: false
    message: string
    monitorThresholdWindows:
        recoveryWindow: string
        triggerWindow: string
    monitorThresholds:
        critical: string
        criticalRecovery: string
        ok: string
        unknown: string
        warning: string
        warningRecovery: string
    name: string
    newGroupDelay: 0
    noDataTimeframe: 0
    notificationPresetName: string
    notifyAudit: false
    notifyBies:
        - string
    notifyNoData: false
    onMissingData: string
    priority: string
    query: string
    renotifyInterval: 0
    renotifyOccurrences: 0
    renotifyStatuses:
        - string
    requireFullWindow: false
    restrictedRoles:
        - string
    schedulingOptions:
        - customSchedules:
            - recurrence:
                rrule: string
                start: string
                timezone: string
          evaluationWindows:
            - dayStarts: string
              hourStarts: 0
              monthStarts: 0
    tags:
        - string
    timeoutH: 0
    type: string
    validate: false
    variables:
        eventQueries:
            - computes:
                - aggregation: string
                  interval: 0
                  metric: string
              dataSource: string
              groupBies:
                - facet: string
                  limit: 0
                  sort:
                    aggregation: string
                    metric: string
                    order: string
              indexes:
                - string
              name: string
              search:
                query: string

    Monitor 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 Monitor resource accepts the following input properties:

    Message string
    A message to include with notifications for this monitor.
    Name string
    Name of Datadog monitor.
    Query string
    Type string
    The type of the monitor. The mapping from these types to the types found in the Datadog Web UI can be found in the Datadog API documentation page. Note: The monitor type cannot be changed after a monitor is created.
    EnableLogsSample bool
    A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.
    EscalationMessage string
    A message to include with a re-notification. Supports the @username notification allowed elsewhere.
    EvaluationDelay int
    (Only applies to metric alert) Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min), the timeframe is set to last_5m and the time is 7:00, the monitor will evaluate data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor will always have data during evaluation.
    ForceDelete bool
    A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).
    GroupRetentionDuration string
    The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
    GroupbySimpleMonitor bool
    Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to false.
    IncludeTags bool
    A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title.
    Locked bool
    A boolean indicating whether changes to this monitor should be restricted to the creator or admins. Defaults to false.

    Deprecated: Use restricted_roles.

    MonitorThresholdWindows MonitorMonitorThresholdWindows
    A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.
    MonitorThresholds MonitorMonitorThresholds
    Alert thresholds of the monitor.
    NewGroupDelay int
    The time (in seconds) to skip evaluations for new groups. new_group_delay overrides new_host_delay if it is set to a nonzero value.
    NewHostDelay int
    Deprecated. See new_group_delay. Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non-negative integer. This value is ignored for simple monitors and monitors not grouped by host. The only case when this should be used is to override the default and set new_host_delay to zero for monitors grouped by host.

    Deprecated: Use new_group_delay except when setting new_host_delay to zero.

    NoDataTimeframe int
    The number of minutes before a monitor will notify when data stops reporting. We recommend at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks.
    NotificationPresetName string
    Toggles the display of additional content sent in the monitor notification.
    NotifyAudit bool
    A boolean indicating whether tagged users will be notified on changes to this monitor. Defaults to false.
    NotifyBies List<string>
    Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each new cluster violating the alert conditions by setting notify_by to ['cluster']. Tags mentioned in notify_by must be a subset of the grouping tags in the query. For example, a query grouped by cluster and namespace cannot notify on region. Setting notify_by to [*] configures the monitor to notify as a simple-alert.
    NotifyNoData bool
    A boolean indicating whether this monitor will notify when data stops reporting.
    OnMissingData string
    Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are: show_no_data, show_and_notify_no_data, resolve, and default.
    Priority string
    Integer from 1 (high) to 5 (low) indicating alert severity.
    RenotifyInterval int
    The number of minutes after the last notification before a monitor will re-notify on the current status. It will only re-notify if it's not resolved.
    RenotifyOccurrences int
    The number of re-notification messages that should be sent on the current status.
    RenotifyStatuses List<string>
    The types of statuses for which re-notification messages should be sent.
    RequireFullWindow bool
    A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends you set this to false for sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set, require_full_window must be false and will be ignored.
    RestrictedRoles List<string>
    A list of unique role identifiers to define which roles are allowed to edit the monitor. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. Roles unique identifiers can be pulled from the Roles API in the data.id field.
    SchedulingOptions List<MonitorSchedulingOption>
    Configuration options for scheduling.
    Tags List<string>
    A list of tags to associate with your monitor. This can help you categorize and filter monitors in the manage monitors page of the UI. Note: it's not currently possible to filter by these tags when querying via the API
    TimeoutH int
    The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.
    Validate bool
    If set to false, skip the validation call done during plan.
    Variables MonitorVariables
    Message string
    A message to include with notifications for this monitor.
    Name string
    Name of Datadog monitor.
    Query string
    Type string
    The type of the monitor. The mapping from these types to the types found in the Datadog Web UI can be found in the Datadog API documentation page. Note: The monitor type cannot be changed after a monitor is created.
    EnableLogsSample bool
    A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.
    EscalationMessage string
    A message to include with a re-notification. Supports the @username notification allowed elsewhere.
    EvaluationDelay int
    (Only applies to metric alert) Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min), the timeframe is set to last_5m and the time is 7:00, the monitor will evaluate data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor will always have data during evaluation.
    ForceDelete bool
    A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).
    GroupRetentionDuration string
    The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
    GroupbySimpleMonitor bool
    Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to false.
    IncludeTags bool
    A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title.
    Locked bool
    A boolean indicating whether changes to this monitor should be restricted to the creator or admins. Defaults to false.

    Deprecated: Use restricted_roles.

    MonitorThresholdWindows MonitorMonitorThresholdWindowsArgs
    A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.
    MonitorThresholds MonitorMonitorThresholdsArgs
    Alert thresholds of the monitor.
    NewGroupDelay int
    The time (in seconds) to skip evaluations for new groups. new_group_delay overrides new_host_delay if it is set to a nonzero value.
    NewHostDelay int
    Deprecated. See new_group_delay. Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non-negative integer. This value is ignored for simple monitors and monitors not grouped by host. The only case when this should be used is to override the default and set new_host_delay to zero for monitors grouped by host.

    Deprecated: Use new_group_delay except when setting new_host_delay to zero.

    NoDataTimeframe int
    The number of minutes before a monitor will notify when data stops reporting. We recommend at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks.
    NotificationPresetName string
    Toggles the display of additional content sent in the monitor notification.
    NotifyAudit bool
    A boolean indicating whether tagged users will be notified on changes to this monitor. Defaults to false.
    NotifyBies []string
    Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each new cluster violating the alert conditions by setting notify_by to ['cluster']. Tags mentioned in notify_by must be a subset of the grouping tags in the query. For example, a query grouped by cluster and namespace cannot notify on region. Setting notify_by to [*] configures the monitor to notify as a simple-alert.
    NotifyNoData bool
    A boolean indicating whether this monitor will notify when data stops reporting.
    OnMissingData string
    Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are: show_no_data, show_and_notify_no_data, resolve, and default.
    Priority string
    Integer from 1 (high) to 5 (low) indicating alert severity.
    RenotifyInterval int
    The number of minutes after the last notification before a monitor will re-notify on the current status. It will only re-notify if it's not resolved.
    RenotifyOccurrences int
    The number of re-notification messages that should be sent on the current status.
    RenotifyStatuses []string
    The types of statuses for which re-notification messages should be sent.
    RequireFullWindow bool
    A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends you set this to false for sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set, require_full_window must be false and will be ignored.
    RestrictedRoles []string
    A list of unique role identifiers to define which roles are allowed to edit the monitor. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. Roles unique identifiers can be pulled from the Roles API in the data.id field.
    SchedulingOptions []MonitorSchedulingOptionArgs
    Configuration options for scheduling.
    Tags []string
    A list of tags to associate with your monitor. This can help you categorize and filter monitors in the manage monitors page of the UI. Note: it's not currently possible to filter by these tags when querying via the API
    TimeoutH int
    The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.
    Validate bool
    If set to false, skip the validation call done during plan.
    Variables MonitorVariablesArgs
    message String
    A message to include with notifications for this monitor.
    name String
    Name of Datadog monitor.
    query String
    type String
    The type of the monitor. The mapping from these types to the types found in the Datadog Web UI can be found in the Datadog API documentation page. Note: The monitor type cannot be changed after a monitor is created.
    enableLogsSample Boolean
    A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.
    escalationMessage String
    A message to include with a re-notification. Supports the @username notification allowed elsewhere.
    evaluationDelay Integer
    (Only applies to metric alert) Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min), the timeframe is set to last_5m and the time is 7:00, the monitor will evaluate data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor will always have data during evaluation.
    forceDelete Boolean
    A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).
    groupRetentionDuration String
    The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
    groupbySimpleMonitor Boolean
    Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to false.
    includeTags Boolean
    A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title.
    locked Boolean
    A boolean indicating whether changes to this monitor should be restricted to the creator or admins. Defaults to false.

    Deprecated: Use restricted_roles.

    monitorThresholdWindows MonitorMonitorThresholdWindows
    A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.
    monitorThresholds MonitorMonitorThresholds
    Alert thresholds of the monitor.
    newGroupDelay Integer
    The time (in seconds) to skip evaluations for new groups. new_group_delay overrides new_host_delay if it is set to a nonzero value.
    newHostDelay Integer
    Deprecated. See new_group_delay. Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non-negative integer. This value is ignored for simple monitors and monitors not grouped by host. The only case when this should be used is to override the default and set new_host_delay to zero for monitors grouped by host.

    Deprecated: Use new_group_delay except when setting new_host_delay to zero.

    noDataTimeframe Integer
    The number of minutes before a monitor will notify when data stops reporting. We recommend at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks.
    notificationPresetName String
    Toggles the display of additional content sent in the monitor notification.
    notifyAudit Boolean
    A boolean indicating whether tagged users will be notified on changes to this monitor. Defaults to false.
    notifyBies List<String>
    Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each new cluster violating the alert conditions by setting notify_by to ['cluster']. Tags mentioned in notify_by must be a subset of the grouping tags in the query. For example, a query grouped by cluster and namespace cannot notify on region. Setting notify_by to [*] configures the monitor to notify as a simple-alert.
    notifyNoData Boolean
    A boolean indicating whether this monitor will notify when data stops reporting.
    onMissingData String
    Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are: show_no_data, show_and_notify_no_data, resolve, and default.
    priority String
    Integer from 1 (high) to 5 (low) indicating alert severity.
    renotifyInterval Integer
    The number of minutes after the last notification before a monitor will re-notify on the current status. It will only re-notify if it's not resolved.
    renotifyOccurrences Integer
    The number of re-notification messages that should be sent on the current status.
    renotifyStatuses List<String>
    The types of statuses for which re-notification messages should be sent.
    requireFullWindow Boolean
    A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends you set this to false for sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set, require_full_window must be false and will be ignored.
    restrictedRoles List<String>
    A list of unique role identifiers to define which roles are allowed to edit the monitor. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. Roles unique identifiers can be pulled from the Roles API in the data.id field.
    schedulingOptions List<MonitorSchedulingOption>
    Configuration options for scheduling.
    tags List<String>
    A list of tags to associate with your monitor. This can help you categorize and filter monitors in the manage monitors page of the UI. Note: it's not currently possible to filter by these tags when querying via the API
    timeoutH Integer
    The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.
    validate Boolean
    If set to false, skip the validation call done during plan.
    variables MonitorVariables
    message string
    A message to include with notifications for this monitor.
    name string
    Name of Datadog monitor.
    query string
    type string
    The type of the monitor. The mapping from these types to the types found in the Datadog Web UI can be found in the Datadog API documentation page. Note: The monitor type cannot be changed after a monitor is created.
    enableLogsSample boolean
    A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.
    escalationMessage string
    A message to include with a re-notification. Supports the @username notification allowed elsewhere.
    evaluationDelay number
    (Only applies to metric alert) Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min), the timeframe is set to last_5m and the time is 7:00, the monitor will evaluate data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor will always have data during evaluation.
    forceDelete boolean
    A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).
    groupRetentionDuration string
    The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
    groupbySimpleMonitor boolean
    Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to false.
    includeTags boolean
    A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title.
    locked boolean
    A boolean indicating whether changes to this monitor should be restricted to the creator or admins. Defaults to false.

    Deprecated: Use restricted_roles.

    monitorThresholdWindows MonitorMonitorThresholdWindows
    A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.
    monitorThresholds MonitorMonitorThresholds
    Alert thresholds of the monitor.
    newGroupDelay number
    The time (in seconds) to skip evaluations for new groups. new_group_delay overrides new_host_delay if it is set to a nonzero value.
    newHostDelay number
    Deprecated. See new_group_delay. Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non-negative integer. This value is ignored for simple monitors and monitors not grouped by host. The only case when this should be used is to override the default and set new_host_delay to zero for monitors grouped by host.

    Deprecated: Use new_group_delay except when setting new_host_delay to zero.

    noDataTimeframe number
    The number of minutes before a monitor will notify when data stops reporting. We recommend at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks.
    notificationPresetName string
    Toggles the display of additional content sent in the monitor notification.
    notifyAudit boolean
    A boolean indicating whether tagged users will be notified on changes to this monitor. Defaults to false.
    notifyBies string[]
    Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each new cluster violating the alert conditions by setting notify_by to ['cluster']. Tags mentioned in notify_by must be a subset of the grouping tags in the query. For example, a query grouped by cluster and namespace cannot notify on region. Setting notify_by to [*] configures the monitor to notify as a simple-alert.
    notifyNoData boolean
    A boolean indicating whether this monitor will notify when data stops reporting.
    onMissingData string
    Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are: show_no_data, show_and_notify_no_data, resolve, and default.
    priority string
    Integer from 1 (high) to 5 (low) indicating alert severity.
    renotifyInterval number
    The number of minutes after the last notification before a monitor will re-notify on the current status. It will only re-notify if it's not resolved.
    renotifyOccurrences number
    The number of re-notification messages that should be sent on the current status.
    renotifyStatuses string[]
    The types of statuses for which re-notification messages should be sent.
    requireFullWindow boolean
    A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends you set this to false for sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set, require_full_window must be false and will be ignored.
    restrictedRoles string[]
    A list of unique role identifiers to define which roles are allowed to edit the monitor. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. Roles unique identifiers can be pulled from the Roles API in the data.id field.
    schedulingOptions MonitorSchedulingOption[]
    Configuration options for scheduling.
    tags string[]
    A list of tags to associate with your monitor. This can help you categorize and filter monitors in the manage monitors page of the UI. Note: it's not currently possible to filter by these tags when querying via the API
    timeoutH number
    The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.
    validate boolean
    If set to false, skip the validation call done during plan.
    variables MonitorVariables
    message str
    A message to include with notifications for this monitor.
    name str
    Name of Datadog monitor.
    query str
    type str
    The type of the monitor. The mapping from these types to the types found in the Datadog Web UI can be found in the Datadog API documentation page. Note: The monitor type cannot be changed after a monitor is created.
    enable_logs_sample bool
    A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.
    escalation_message str
    A message to include with a re-notification. Supports the @username notification allowed elsewhere.
    evaluation_delay int
    (Only applies to metric alert) Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min), the timeframe is set to last_5m and the time is 7:00, the monitor will evaluate data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor will always have data during evaluation.
    force_delete bool
    A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).
    group_retention_duration str
    The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
    groupby_simple_monitor bool
    Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to false.
    include_tags bool
    A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title.
    locked bool
    A boolean indicating whether changes to this monitor should be restricted to the creator or admins. Defaults to false.

    Deprecated: Use restricted_roles.

    monitor_threshold_windows MonitorMonitorThresholdWindowsArgs
    A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.
    monitor_thresholds MonitorMonitorThresholdsArgs
    Alert thresholds of the monitor.
    new_group_delay int
    The time (in seconds) to skip evaluations for new groups. new_group_delay overrides new_host_delay if it is set to a nonzero value.
    new_host_delay int
    Deprecated. See new_group_delay. Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non-negative integer. This value is ignored for simple monitors and monitors not grouped by host. The only case when this should be used is to override the default and set new_host_delay to zero for monitors grouped by host.

    Deprecated: Use new_group_delay except when setting new_host_delay to zero.

    no_data_timeframe int
    The number of minutes before a monitor will notify when data stops reporting. We recommend at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks.
    notification_preset_name str
    Toggles the display of additional content sent in the monitor notification.
    notify_audit bool
    A boolean indicating whether tagged users will be notified on changes to this monitor. Defaults to false.
    notify_bies Sequence[str]
    Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each new cluster violating the alert conditions by setting notify_by to ['cluster']. Tags mentioned in notify_by must be a subset of the grouping tags in the query. For example, a query grouped by cluster and namespace cannot notify on region. Setting notify_by to [*] configures the monitor to notify as a simple-alert.
    notify_no_data bool
    A boolean indicating whether this monitor will notify when data stops reporting.
    on_missing_data str
    Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are: show_no_data, show_and_notify_no_data, resolve, and default.
    priority str
    Integer from 1 (high) to 5 (low) indicating alert severity.
    renotify_interval int
    The number of minutes after the last notification before a monitor will re-notify on the current status. It will only re-notify if it's not resolved.
    renotify_occurrences int
    The number of re-notification messages that should be sent on the current status.
    renotify_statuses Sequence[str]
    The types of statuses for which re-notification messages should be sent.
    require_full_window bool
    A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends you set this to false for sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set, require_full_window must be false and will be ignored.
    restricted_roles Sequence[str]
    A list of unique role identifiers to define which roles are allowed to edit the monitor. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. Roles unique identifiers can be pulled from the Roles API in the data.id field.
    scheduling_options Sequence[MonitorSchedulingOptionArgs]
    Configuration options for scheduling.
    tags Sequence[str]
    A list of tags to associate with your monitor. This can help you categorize and filter monitors in the manage monitors page of the UI. Note: it's not currently possible to filter by these tags when querying via the API
    timeout_h int
    The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.
    validate bool
    If set to false, skip the validation call done during plan.
    variables MonitorVariablesArgs
    message String
    A message to include with notifications for this monitor.
    name String
    Name of Datadog monitor.
    query String
    type String
    The type of the monitor. The mapping from these types to the types found in the Datadog Web UI can be found in the Datadog API documentation page. Note: The monitor type cannot be changed after a monitor is created.
    enableLogsSample Boolean
    A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.
    escalationMessage String
    A message to include with a re-notification. Supports the @username notification allowed elsewhere.
    evaluationDelay Number
    (Only applies to metric alert) Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min), the timeframe is set to last_5m and the time is 7:00, the monitor will evaluate data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor will always have data during evaluation.
    forceDelete Boolean
    A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).
    groupRetentionDuration String
    The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
    groupbySimpleMonitor Boolean
    Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to false.
    includeTags Boolean
    A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title.
    locked Boolean
    A boolean indicating whether changes to this monitor should be restricted to the creator or admins. Defaults to false.

    Deprecated: Use restricted_roles.

    monitorThresholdWindows Property Map
    A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.
    monitorThresholds Property Map
    Alert thresholds of the monitor.
    newGroupDelay Number
    The time (in seconds) to skip evaluations for new groups. new_group_delay overrides new_host_delay if it is set to a nonzero value.
    newHostDelay Number
    Deprecated. See new_group_delay. Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non-negative integer. This value is ignored for simple monitors and monitors not grouped by host. The only case when this should be used is to override the default and set new_host_delay to zero for monitors grouped by host.

    Deprecated: Use new_group_delay except when setting new_host_delay to zero.

    noDataTimeframe Number
    The number of minutes before a monitor will notify when data stops reporting. We recommend at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks.
    notificationPresetName String
    Toggles the display of additional content sent in the monitor notification.
    notifyAudit Boolean
    A boolean indicating whether tagged users will be notified on changes to this monitor. Defaults to false.
    notifyBies List<String>
    Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each new cluster violating the alert conditions by setting notify_by to ['cluster']. Tags mentioned in notify_by must be a subset of the grouping tags in the query. For example, a query grouped by cluster and namespace cannot notify on region. Setting notify_by to [*] configures the monitor to notify as a simple-alert.
    notifyNoData Boolean
    A boolean indicating whether this monitor will notify when data stops reporting.
    onMissingData String
    Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are: show_no_data, show_and_notify_no_data, resolve, and default.
    priority String
    Integer from 1 (high) to 5 (low) indicating alert severity.
    renotifyInterval Number
    The number of minutes after the last notification before a monitor will re-notify on the current status. It will only re-notify if it's not resolved.
    renotifyOccurrences Number
    The number of re-notification messages that should be sent on the current status.
    renotifyStatuses List<String>
    The types of statuses for which re-notification messages should be sent.
    requireFullWindow Boolean
    A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends you set this to false for sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set, require_full_window must be false and will be ignored.
    restrictedRoles List<String>
    A list of unique role identifiers to define which roles are allowed to edit the monitor. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. Roles unique identifiers can be pulled from the Roles API in the data.id field.
    schedulingOptions List<Property Map>
    Configuration options for scheduling.
    tags List<String>
    A list of tags to associate with your monitor. This can help you categorize and filter monitors in the manage monitors page of the UI. Note: it's not currently possible to filter by these tags when querying via the API
    timeoutH Number
    The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.
    validate Boolean
    If set to false, skip the validation call done during plan.
    variables Property Map

    Outputs

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

    EnableSamples bool
    Whether or not a list of samples which triggered the alert is included. This is only used by CI Test and Pipeline monitors.
    Id string
    The provider-assigned unique ID for this managed resource.
    EnableSamples bool
    Whether or not a list of samples which triggered the alert is included. This is only used by CI Test and Pipeline monitors.
    Id string
    The provider-assigned unique ID for this managed resource.
    enableSamples Boolean
    Whether or not a list of samples which triggered the alert is included. This is only used by CI Test and Pipeline monitors.
    id String
    The provider-assigned unique ID for this managed resource.
    enableSamples boolean
    Whether or not a list of samples which triggered the alert is included. This is only used by CI Test and Pipeline monitors.
    id string
    The provider-assigned unique ID for this managed resource.
    enable_samples bool
    Whether or not a list of samples which triggered the alert is included. This is only used by CI Test and Pipeline monitors.
    id str
    The provider-assigned unique ID for this managed resource.
    enableSamples Boolean
    Whether or not a list of samples which triggered the alert is included. This is only used by CI Test and Pipeline monitors.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Monitor Resource

    Get an existing Monitor 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?: MonitorState, opts?: CustomResourceOptions): Monitor
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        enable_logs_sample: Optional[bool] = None,
        enable_samples: Optional[bool] = None,
        escalation_message: Optional[str] = None,
        evaluation_delay: Optional[int] = None,
        force_delete: Optional[bool] = None,
        group_retention_duration: Optional[str] = None,
        groupby_simple_monitor: Optional[bool] = None,
        include_tags: Optional[bool] = None,
        locked: Optional[bool] = None,
        message: Optional[str] = None,
        monitor_threshold_windows: Optional[MonitorMonitorThresholdWindowsArgs] = None,
        monitor_thresholds: Optional[MonitorMonitorThresholdsArgs] = None,
        name: Optional[str] = None,
        new_group_delay: Optional[int] = None,
        new_host_delay: Optional[int] = None,
        no_data_timeframe: Optional[int] = None,
        notification_preset_name: Optional[str] = None,
        notify_audit: Optional[bool] = None,
        notify_bies: Optional[Sequence[str]] = None,
        notify_no_data: Optional[bool] = None,
        on_missing_data: Optional[str] = None,
        priority: Optional[str] = None,
        query: Optional[str] = None,
        renotify_interval: Optional[int] = None,
        renotify_occurrences: Optional[int] = None,
        renotify_statuses: Optional[Sequence[str]] = None,
        require_full_window: Optional[bool] = None,
        restricted_roles: Optional[Sequence[str]] = None,
        scheduling_options: Optional[Sequence[MonitorSchedulingOptionArgs]] = None,
        tags: Optional[Sequence[str]] = None,
        timeout_h: Optional[int] = None,
        type: Optional[str] = None,
        validate: Optional[bool] = None,
        variables: Optional[MonitorVariablesArgs] = None) -> Monitor
    func GetMonitor(ctx *Context, name string, id IDInput, state *MonitorState, opts ...ResourceOption) (*Monitor, error)
    public static Monitor Get(string name, Input<string> id, MonitorState? state, CustomResourceOptions? opts = null)
    public static Monitor get(String name, Output<String> id, MonitorState 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:
    EnableLogsSample bool
    A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.
    EnableSamples bool
    Whether or not a list of samples which triggered the alert is included. This is only used by CI Test and Pipeline monitors.
    EscalationMessage string
    A message to include with a re-notification. Supports the @username notification allowed elsewhere.
    EvaluationDelay int
    (Only applies to metric alert) Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min), the timeframe is set to last_5m and the time is 7:00, the monitor will evaluate data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor will always have data during evaluation.
    ForceDelete bool
    A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).
    GroupRetentionDuration string
    The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
    GroupbySimpleMonitor bool
    Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to false.
    IncludeTags bool
    A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title.
    Locked bool
    A boolean indicating whether changes to this monitor should be restricted to the creator or admins. Defaults to false.

    Deprecated: Use restricted_roles.

    Message string
    A message to include with notifications for this monitor.
    MonitorThresholdWindows MonitorMonitorThresholdWindows
    A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.
    MonitorThresholds MonitorMonitorThresholds
    Alert thresholds of the monitor.
    Name string
    Name of Datadog monitor.
    NewGroupDelay int
    The time (in seconds) to skip evaluations for new groups. new_group_delay overrides new_host_delay if it is set to a nonzero value.
    NewHostDelay int
    Deprecated. See new_group_delay. Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non-negative integer. This value is ignored for simple monitors and monitors not grouped by host. The only case when this should be used is to override the default and set new_host_delay to zero for monitors grouped by host.

    Deprecated: Use new_group_delay except when setting new_host_delay to zero.

    NoDataTimeframe int
    The number of minutes before a monitor will notify when data stops reporting. We recommend at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks.
    NotificationPresetName string
    Toggles the display of additional content sent in the monitor notification.
    NotifyAudit bool
    A boolean indicating whether tagged users will be notified on changes to this monitor. Defaults to false.
    NotifyBies List<string>
    Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each new cluster violating the alert conditions by setting notify_by to ['cluster']. Tags mentioned in notify_by must be a subset of the grouping tags in the query. For example, a query grouped by cluster and namespace cannot notify on region. Setting notify_by to [*] configures the monitor to notify as a simple-alert.
    NotifyNoData bool
    A boolean indicating whether this monitor will notify when data stops reporting.
    OnMissingData string
    Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are: show_no_data, show_and_notify_no_data, resolve, and default.
    Priority string
    Integer from 1 (high) to 5 (low) indicating alert severity.
    Query string
    RenotifyInterval int
    The number of minutes after the last notification before a monitor will re-notify on the current status. It will only re-notify if it's not resolved.
    RenotifyOccurrences int
    The number of re-notification messages that should be sent on the current status.
    RenotifyStatuses List<string>
    The types of statuses for which re-notification messages should be sent.
    RequireFullWindow bool
    A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends you set this to false for sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set, require_full_window must be false and will be ignored.
    RestrictedRoles List<string>
    A list of unique role identifiers to define which roles are allowed to edit the monitor. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. Roles unique identifiers can be pulled from the Roles API in the data.id field.
    SchedulingOptions List<MonitorSchedulingOption>
    Configuration options for scheduling.
    Tags List<string>
    A list of tags to associate with your monitor. This can help you categorize and filter monitors in the manage monitors page of the UI. Note: it's not currently possible to filter by these tags when querying via the API
    TimeoutH int
    The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.
    Type string
    The type of the monitor. The mapping from these types to the types found in the Datadog Web UI can be found in the Datadog API documentation page. Note: The monitor type cannot be changed after a monitor is created.
    Validate bool
    If set to false, skip the validation call done during plan.
    Variables MonitorVariables
    EnableLogsSample bool
    A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.
    EnableSamples bool
    Whether or not a list of samples which triggered the alert is included. This is only used by CI Test and Pipeline monitors.
    EscalationMessage string
    A message to include with a re-notification. Supports the @username notification allowed elsewhere.
    EvaluationDelay int
    (Only applies to metric alert) Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min), the timeframe is set to last_5m and the time is 7:00, the monitor will evaluate data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor will always have data during evaluation.
    ForceDelete bool
    A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).
    GroupRetentionDuration string
    The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
    GroupbySimpleMonitor bool
    Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to false.
    IncludeTags bool
    A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title.
    Locked bool
    A boolean indicating whether changes to this monitor should be restricted to the creator or admins. Defaults to false.

    Deprecated: Use restricted_roles.

    Message string
    A message to include with notifications for this monitor.
    MonitorThresholdWindows MonitorMonitorThresholdWindowsArgs
    A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.
    MonitorThresholds MonitorMonitorThresholdsArgs
    Alert thresholds of the monitor.
    Name string
    Name of Datadog monitor.
    NewGroupDelay int
    The time (in seconds) to skip evaluations for new groups. new_group_delay overrides new_host_delay if it is set to a nonzero value.
    NewHostDelay int
    Deprecated. See new_group_delay. Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non-negative integer. This value is ignored for simple monitors and monitors not grouped by host. The only case when this should be used is to override the default and set new_host_delay to zero for monitors grouped by host.

    Deprecated: Use new_group_delay except when setting new_host_delay to zero.

    NoDataTimeframe int
    The number of minutes before a monitor will notify when data stops reporting. We recommend at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks.
    NotificationPresetName string
    Toggles the display of additional content sent in the monitor notification.
    NotifyAudit bool
    A boolean indicating whether tagged users will be notified on changes to this monitor. Defaults to false.
    NotifyBies []string
    Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each new cluster violating the alert conditions by setting notify_by to ['cluster']. Tags mentioned in notify_by must be a subset of the grouping tags in the query. For example, a query grouped by cluster and namespace cannot notify on region. Setting notify_by to [*] configures the monitor to notify as a simple-alert.
    NotifyNoData bool
    A boolean indicating whether this monitor will notify when data stops reporting.
    OnMissingData string
    Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are: show_no_data, show_and_notify_no_data, resolve, and default.
    Priority string
    Integer from 1 (high) to 5 (low) indicating alert severity.
    Query string
    RenotifyInterval int
    The number of minutes after the last notification before a monitor will re-notify on the current status. It will only re-notify if it's not resolved.
    RenotifyOccurrences int
    The number of re-notification messages that should be sent on the current status.
    RenotifyStatuses []string
    The types of statuses for which re-notification messages should be sent.
    RequireFullWindow bool
    A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends you set this to false for sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set, require_full_window must be false and will be ignored.
    RestrictedRoles []string
    A list of unique role identifiers to define which roles are allowed to edit the monitor. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. Roles unique identifiers can be pulled from the Roles API in the data.id field.
    SchedulingOptions []MonitorSchedulingOptionArgs
    Configuration options for scheduling.
    Tags []string
    A list of tags to associate with your monitor. This can help you categorize and filter monitors in the manage monitors page of the UI. Note: it's not currently possible to filter by these tags when querying via the API
    TimeoutH int
    The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.
    Type string
    The type of the monitor. The mapping from these types to the types found in the Datadog Web UI can be found in the Datadog API documentation page. Note: The monitor type cannot be changed after a monitor is created.
    Validate bool
    If set to false, skip the validation call done during plan.
    Variables MonitorVariablesArgs
    enableLogsSample Boolean
    A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.
    enableSamples Boolean
    Whether or not a list of samples which triggered the alert is included. This is only used by CI Test and Pipeline monitors.
    escalationMessage String
    A message to include with a re-notification. Supports the @username notification allowed elsewhere.
    evaluationDelay Integer
    (Only applies to metric alert) Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min), the timeframe is set to last_5m and the time is 7:00, the monitor will evaluate data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor will always have data during evaluation.
    forceDelete Boolean
    A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).
    groupRetentionDuration String
    The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
    groupbySimpleMonitor Boolean
    Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to false.
    includeTags Boolean
    A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title.
    locked Boolean
    A boolean indicating whether changes to this monitor should be restricted to the creator or admins. Defaults to false.

    Deprecated: Use restricted_roles.

    message String
    A message to include with notifications for this monitor.
    monitorThresholdWindows MonitorMonitorThresholdWindows
    A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.
    monitorThresholds MonitorMonitorThresholds
    Alert thresholds of the monitor.
    name String
    Name of Datadog monitor.
    newGroupDelay Integer
    The time (in seconds) to skip evaluations for new groups. new_group_delay overrides new_host_delay if it is set to a nonzero value.
    newHostDelay Integer
    Deprecated. See new_group_delay. Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non-negative integer. This value is ignored for simple monitors and monitors not grouped by host. The only case when this should be used is to override the default and set new_host_delay to zero for monitors grouped by host.

    Deprecated: Use new_group_delay except when setting new_host_delay to zero.

    noDataTimeframe Integer
    The number of minutes before a monitor will notify when data stops reporting. We recommend at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks.
    notificationPresetName String
    Toggles the display of additional content sent in the monitor notification.
    notifyAudit Boolean
    A boolean indicating whether tagged users will be notified on changes to this monitor. Defaults to false.
    notifyBies List<String>
    Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each new cluster violating the alert conditions by setting notify_by to ['cluster']. Tags mentioned in notify_by must be a subset of the grouping tags in the query. For example, a query grouped by cluster and namespace cannot notify on region. Setting notify_by to [*] configures the monitor to notify as a simple-alert.
    notifyNoData Boolean
    A boolean indicating whether this monitor will notify when data stops reporting.
    onMissingData String
    Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are: show_no_data, show_and_notify_no_data, resolve, and default.
    priority String
    Integer from 1 (high) to 5 (low) indicating alert severity.
    query String
    renotifyInterval Integer
    The number of minutes after the last notification before a monitor will re-notify on the current status. It will only re-notify if it's not resolved.
    renotifyOccurrences Integer
    The number of re-notification messages that should be sent on the current status.
    renotifyStatuses List<String>
    The types of statuses for which re-notification messages should be sent.
    requireFullWindow Boolean
    A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends you set this to false for sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set, require_full_window must be false and will be ignored.
    restrictedRoles List<String>
    A list of unique role identifiers to define which roles are allowed to edit the monitor. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. Roles unique identifiers can be pulled from the Roles API in the data.id field.
    schedulingOptions List<MonitorSchedulingOption>
    Configuration options for scheduling.
    tags List<String>
    A list of tags to associate with your monitor. This can help you categorize and filter monitors in the manage monitors page of the UI. Note: it's not currently possible to filter by these tags when querying via the API
    timeoutH Integer
    The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.
    type String
    The type of the monitor. The mapping from these types to the types found in the Datadog Web UI can be found in the Datadog API documentation page. Note: The monitor type cannot be changed after a monitor is created.
    validate Boolean
    If set to false, skip the validation call done during plan.
    variables MonitorVariables
    enableLogsSample boolean
    A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.
    enableSamples boolean
    Whether or not a list of samples which triggered the alert is included. This is only used by CI Test and Pipeline monitors.
    escalationMessage string
    A message to include with a re-notification. Supports the @username notification allowed elsewhere.
    evaluationDelay number
    (Only applies to metric alert) Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min), the timeframe is set to last_5m and the time is 7:00, the monitor will evaluate data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor will always have data during evaluation.
    forceDelete boolean
    A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).
    groupRetentionDuration string
    The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
    groupbySimpleMonitor boolean
    Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to false.
    includeTags boolean
    A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title.
    locked boolean
    A boolean indicating whether changes to this monitor should be restricted to the creator or admins. Defaults to false.

    Deprecated: Use restricted_roles.

    message string
    A message to include with notifications for this monitor.
    monitorThresholdWindows MonitorMonitorThresholdWindows
    A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.
    monitorThresholds MonitorMonitorThresholds
    Alert thresholds of the monitor.
    name string
    Name of Datadog monitor.
    newGroupDelay number
    The time (in seconds) to skip evaluations for new groups. new_group_delay overrides new_host_delay if it is set to a nonzero value.
    newHostDelay number
    Deprecated. See new_group_delay. Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non-negative integer. This value is ignored for simple monitors and monitors not grouped by host. The only case when this should be used is to override the default and set new_host_delay to zero for monitors grouped by host.

    Deprecated: Use new_group_delay except when setting new_host_delay to zero.

    noDataTimeframe number
    The number of minutes before a monitor will notify when data stops reporting. We recommend at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks.
    notificationPresetName string
    Toggles the display of additional content sent in the monitor notification.
    notifyAudit boolean
    A boolean indicating whether tagged users will be notified on changes to this monitor. Defaults to false.
    notifyBies string[]
    Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each new cluster violating the alert conditions by setting notify_by to ['cluster']. Tags mentioned in notify_by must be a subset of the grouping tags in the query. For example, a query grouped by cluster and namespace cannot notify on region. Setting notify_by to [*] configures the monitor to notify as a simple-alert.
    notifyNoData boolean
    A boolean indicating whether this monitor will notify when data stops reporting.
    onMissingData string
    Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are: show_no_data, show_and_notify_no_data, resolve, and default.
    priority string
    Integer from 1 (high) to 5 (low) indicating alert severity.
    query string
    renotifyInterval number
    The number of minutes after the last notification before a monitor will re-notify on the current status. It will only re-notify if it's not resolved.
    renotifyOccurrences number
    The number of re-notification messages that should be sent on the current status.
    renotifyStatuses string[]
    The types of statuses for which re-notification messages should be sent.
    requireFullWindow boolean
    A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends you set this to false for sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set, require_full_window must be false and will be ignored.
    restrictedRoles string[]
    A list of unique role identifiers to define which roles are allowed to edit the monitor. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. Roles unique identifiers can be pulled from the Roles API in the data.id field.
    schedulingOptions MonitorSchedulingOption[]
    Configuration options for scheduling.
    tags string[]
    A list of tags to associate with your monitor. This can help you categorize and filter monitors in the manage monitors page of the UI. Note: it's not currently possible to filter by these tags when querying via the API
    timeoutH number
    The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.
    type string
    The type of the monitor. The mapping from these types to the types found in the Datadog Web UI can be found in the Datadog API documentation page. Note: The monitor type cannot be changed after a monitor is created.
    validate boolean
    If set to false, skip the validation call done during plan.
    variables MonitorVariables
    enable_logs_sample bool
    A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.
    enable_samples bool
    Whether or not a list of samples which triggered the alert is included. This is only used by CI Test and Pipeline monitors.
    escalation_message str
    A message to include with a re-notification. Supports the @username notification allowed elsewhere.
    evaluation_delay int
    (Only applies to metric alert) Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min), the timeframe is set to last_5m and the time is 7:00, the monitor will evaluate data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor will always have data during evaluation.
    force_delete bool
    A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).
    group_retention_duration str
    The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
    groupby_simple_monitor bool
    Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to false.
    include_tags bool
    A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title.
    locked bool
    A boolean indicating whether changes to this monitor should be restricted to the creator or admins. Defaults to false.

    Deprecated: Use restricted_roles.

    message str
    A message to include with notifications for this monitor.
    monitor_threshold_windows MonitorMonitorThresholdWindowsArgs
    A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.
    monitor_thresholds MonitorMonitorThresholdsArgs
    Alert thresholds of the monitor.
    name str
    Name of Datadog monitor.
    new_group_delay int
    The time (in seconds) to skip evaluations for new groups. new_group_delay overrides new_host_delay if it is set to a nonzero value.
    new_host_delay int
    Deprecated. See new_group_delay. Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non-negative integer. This value is ignored for simple monitors and monitors not grouped by host. The only case when this should be used is to override the default and set new_host_delay to zero for monitors grouped by host.

    Deprecated: Use new_group_delay except when setting new_host_delay to zero.

    no_data_timeframe int
    The number of minutes before a monitor will notify when data stops reporting. We recommend at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks.
    notification_preset_name str
    Toggles the display of additional content sent in the monitor notification.
    notify_audit bool
    A boolean indicating whether tagged users will be notified on changes to this monitor. Defaults to false.
    notify_bies Sequence[str]
    Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each new cluster violating the alert conditions by setting notify_by to ['cluster']. Tags mentioned in notify_by must be a subset of the grouping tags in the query. For example, a query grouped by cluster and namespace cannot notify on region. Setting notify_by to [*] configures the monitor to notify as a simple-alert.
    notify_no_data bool
    A boolean indicating whether this monitor will notify when data stops reporting.
    on_missing_data str
    Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are: show_no_data, show_and_notify_no_data, resolve, and default.
    priority str
    Integer from 1 (high) to 5 (low) indicating alert severity.
    query str
    renotify_interval int
    The number of minutes after the last notification before a monitor will re-notify on the current status. It will only re-notify if it's not resolved.
    renotify_occurrences int
    The number of re-notification messages that should be sent on the current status.
    renotify_statuses Sequence[str]
    The types of statuses for which re-notification messages should be sent.
    require_full_window bool
    A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends you set this to false for sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set, require_full_window must be false and will be ignored.
    restricted_roles Sequence[str]
    A list of unique role identifiers to define which roles are allowed to edit the monitor. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. Roles unique identifiers can be pulled from the Roles API in the data.id field.
    scheduling_options Sequence[MonitorSchedulingOptionArgs]
    Configuration options for scheduling.
    tags Sequence[str]
    A list of tags to associate with your monitor. This can help you categorize and filter monitors in the manage monitors page of the UI. Note: it's not currently possible to filter by these tags when querying via the API
    timeout_h int
    The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.
    type str
    The type of the monitor. The mapping from these types to the types found in the Datadog Web UI can be found in the Datadog API documentation page. Note: The monitor type cannot be changed after a monitor is created.
    validate bool
    If set to false, skip the validation call done during plan.
    variables MonitorVariablesArgs
    enableLogsSample Boolean
    A boolean indicating whether or not to include a list of log values which triggered the alert. This is only used by log monitors. Defaults to false.
    enableSamples Boolean
    Whether or not a list of samples which triggered the alert is included. This is only used by CI Test and Pipeline monitors.
    escalationMessage String
    A message to include with a re-notification. Supports the @username notification allowed elsewhere.
    evaluationDelay Number
    (Only applies to metric alert) Time (in seconds) to delay evaluation, as a non-negative integer. For example, if the value is set to 300 (5min), the timeframe is set to last_5m and the time is 7:00, the monitor will evaluate data from 6:50 to 6:55. This is useful for AWS CloudWatch and other backfilled metrics to ensure the monitor will always have data during evaluation.
    forceDelete Boolean
    A boolean indicating whether this monitor can be deleted even if it’s referenced by other resources (e.g. SLO, composite monitor).
    groupRetentionDuration String
    The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
    groupbySimpleMonitor Boolean
    Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to false.
    includeTags Boolean
    A boolean indicating whether notifications from this monitor automatically insert its triggering tags into the title.
    locked Boolean
    A boolean indicating whether changes to this monitor should be restricted to the creator or admins. Defaults to false.

    Deprecated: Use restricted_roles.

    message String
    A message to include with notifications for this monitor.
    monitorThresholdWindows Property Map
    A mapping containing recovery_window and trigger_window values, e.g. last_15m . Can only be used for, and are required for, anomaly monitors.
    monitorThresholds Property Map
    Alert thresholds of the monitor.
    name String
    Name of Datadog monitor.
    newGroupDelay Number
    The time (in seconds) to skip evaluations for new groups. new_group_delay overrides new_host_delay if it is set to a nonzero value.
    newHostDelay Number
    Deprecated. See new_group_delay. Time (in seconds) to allow a host to boot and applications to fully start before starting the evaluation of monitor results. Should be a non-negative integer. This value is ignored for simple monitors and monitors not grouped by host. The only case when this should be used is to override the default and set new_host_delay to zero for monitors grouped by host.

    Deprecated: Use new_group_delay except when setting new_host_delay to zero.

    noDataTimeframe Number
    The number of minutes before a monitor will notify when data stops reporting. We recommend at least 2x the monitor timeframe for metric alerts or 2 minutes for service checks.
    notificationPresetName String
    Toggles the display of additional content sent in the monitor notification.
    notifyAudit Boolean
    A boolean indicating whether tagged users will be notified on changes to this monitor. Defaults to false.
    notifyBies List<String>
    Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each new cluster violating the alert conditions by setting notify_by to ['cluster']. Tags mentioned in notify_by must be a subset of the grouping tags in the query. For example, a query grouped by cluster and namespace cannot notify on region. Setting notify_by to [*] configures the monitor to notify as a simple-alert.
    notifyNoData Boolean
    A boolean indicating whether this monitor will notify when data stops reporting.
    onMissingData String
    Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are: show_no_data, show_and_notify_no_data, resolve, and default.
    priority String
    Integer from 1 (high) to 5 (low) indicating alert severity.
    query String
    renotifyInterval Number
    The number of minutes after the last notification before a monitor will re-notify on the current status. It will only re-notify if it's not resolved.
    renotifyOccurrences Number
    The number of re-notification messages that should be sent on the current status.
    renotifyStatuses List<String>
    The types of statuses for which re-notification messages should be sent.
    requireFullWindow Boolean
    A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends you set this to false for sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set, require_full_window must be false and will be ignored.
    restrictedRoles List<String>
    A list of unique role identifiers to define which roles are allowed to edit the monitor. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. Roles unique identifiers can be pulled from the Roles API in the data.id field.
    schedulingOptions List<Property Map>
    Configuration options for scheduling.
    tags List<String>
    A list of tags to associate with your monitor. This can help you categorize and filter monitors in the manage monitors page of the UI. Note: it's not currently possible to filter by these tags when querying via the API
    timeoutH Number
    The number of hours of the monitor not reporting data before it automatically resolves from a triggered state. The minimum allowed value is 0 hours. The maximum allowed value is 24 hours.
    type String
    The type of the monitor. The mapping from these types to the types found in the Datadog Web UI can be found in the Datadog API documentation page. Note: The monitor type cannot be changed after a monitor is created.
    validate Boolean
    If set to false, skip the validation call done during plan.
    variables Property Map

    Supporting Types

    MonitorMonitorThresholdWindows, MonitorMonitorThresholdWindowsArgs

    RecoveryWindow string
    Describes how long an anomalous metric must be normal before the alert recovers.
    TriggerWindow string
    Describes how long a metric must be anomalous before an alert triggers.
    RecoveryWindow string
    Describes how long an anomalous metric must be normal before the alert recovers.
    TriggerWindow string
    Describes how long a metric must be anomalous before an alert triggers.
    recoveryWindow String
    Describes how long an anomalous metric must be normal before the alert recovers.
    triggerWindow String
    Describes how long a metric must be anomalous before an alert triggers.
    recoveryWindow string
    Describes how long an anomalous metric must be normal before the alert recovers.
    triggerWindow string
    Describes how long a metric must be anomalous before an alert triggers.
    recovery_window str
    Describes how long an anomalous metric must be normal before the alert recovers.
    trigger_window str
    Describes how long a metric must be anomalous before an alert triggers.
    recoveryWindow String
    Describes how long an anomalous metric must be normal before the alert recovers.
    triggerWindow String
    Describes how long a metric must be anomalous before an alert triggers.

    MonitorMonitorThresholds, MonitorMonitorThresholdsArgs

    Critical string
    The monitor CRITICAL threshold. Must be a number.
    CriticalRecovery string
    The monitor CRITICAL recovery threshold. Must be a number.
    Ok string
    The monitor OK threshold. Only supported in monitor type service check. Must be a number.
    Unknown string
    The monitor UNKNOWN threshold. Only supported in monitor type service check. Must be a number.
    Warning string
    The monitor WARNING threshold. Must be a number.
    WarningRecovery string
    The monitor WARNING recovery threshold. Must be a number.
    Critical string
    The monitor CRITICAL threshold. Must be a number.
    CriticalRecovery string
    The monitor CRITICAL recovery threshold. Must be a number.
    Ok string
    The monitor OK threshold. Only supported in monitor type service check. Must be a number.
    Unknown string
    The monitor UNKNOWN threshold. Only supported in monitor type service check. Must be a number.
    Warning string
    The monitor WARNING threshold. Must be a number.
    WarningRecovery string
    The monitor WARNING recovery threshold. Must be a number.
    critical String
    The monitor CRITICAL threshold. Must be a number.
    criticalRecovery String
    The monitor CRITICAL recovery threshold. Must be a number.
    ok String
    The monitor OK threshold. Only supported in monitor type service check. Must be a number.
    unknown String
    The monitor UNKNOWN threshold. Only supported in monitor type service check. Must be a number.
    warning String
    The monitor WARNING threshold. Must be a number.
    warningRecovery String
    The monitor WARNING recovery threshold. Must be a number.
    critical string
    The monitor CRITICAL threshold. Must be a number.
    criticalRecovery string
    The monitor CRITICAL recovery threshold. Must be a number.
    ok string
    The monitor OK threshold. Only supported in monitor type service check. Must be a number.
    unknown string
    The monitor UNKNOWN threshold. Only supported in monitor type service check. Must be a number.
    warning string
    The monitor WARNING threshold. Must be a number.
    warningRecovery string
    The monitor WARNING recovery threshold. Must be a number.
    critical str
    The monitor CRITICAL threshold. Must be a number.
    critical_recovery str
    The monitor CRITICAL recovery threshold. Must be a number.
    ok str
    The monitor OK threshold. Only supported in monitor type service check. Must be a number.
    unknown str
    The monitor UNKNOWN threshold. Only supported in monitor type service check. Must be a number.
    warning str
    The monitor WARNING threshold. Must be a number.
    warning_recovery str
    The monitor WARNING recovery threshold. Must be a number.
    critical String
    The monitor CRITICAL threshold. Must be a number.
    criticalRecovery String
    The monitor CRITICAL recovery threshold. Must be a number.
    ok String
    The monitor OK threshold. Only supported in monitor type service check. Must be a number.
    unknown String
    The monitor UNKNOWN threshold. Only supported in monitor type service check. Must be a number.
    warning String
    The monitor WARNING threshold. Must be a number.
    warningRecovery String
    The monitor WARNING recovery threshold. Must be a number.

    MonitorSchedulingOption, MonitorSchedulingOptionArgs

    CustomSchedules List<MonitorSchedulingOptionCustomSchedule>
    Configuration options for the custom schedules. If start is omitted, the monitor creation time will be used.
    EvaluationWindows List<MonitorSchedulingOptionEvaluationWindow>
    Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.
    CustomSchedules []MonitorSchedulingOptionCustomSchedule
    Configuration options for the custom schedules. If start is omitted, the monitor creation time will be used.
    EvaluationWindows []MonitorSchedulingOptionEvaluationWindow
    Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.
    customSchedules List<MonitorSchedulingOptionCustomSchedule>
    Configuration options for the custom schedules. If start is omitted, the monitor creation time will be used.
    evaluationWindows List<MonitorSchedulingOptionEvaluationWindow>
    Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.
    customSchedules MonitorSchedulingOptionCustomSchedule[]
    Configuration options for the custom schedules. If start is omitted, the monitor creation time will be used.
    evaluationWindows MonitorSchedulingOptionEvaluationWindow[]
    Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.
    custom_schedules Sequence[MonitorSchedulingOptionCustomSchedule]
    Configuration options for the custom schedules. If start is omitted, the monitor creation time will be used.
    evaluation_windows Sequence[MonitorSchedulingOptionEvaluationWindow]
    Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.
    customSchedules List<Property Map>
    Configuration options for the custom schedules. If start is omitted, the monitor creation time will be used.
    evaluationWindows List<Property Map>
    Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

    MonitorSchedulingOptionCustomSchedule, MonitorSchedulingOptionCustomScheduleArgs

    Recurrence MonitorSchedulingOptionCustomScheduleRecurrence
    A list of recurrence definitions. Length must be 1.
    Recurrence MonitorSchedulingOptionCustomScheduleRecurrence
    A list of recurrence definitions. Length must be 1.
    recurrence MonitorSchedulingOptionCustomScheduleRecurrence
    A list of recurrence definitions. Length must be 1.
    recurrence MonitorSchedulingOptionCustomScheduleRecurrence
    A list of recurrence definitions. Length must be 1.
    recurrence MonitorSchedulingOptionCustomScheduleRecurrence
    A list of recurrence definitions. Length must be 1.
    recurrence Property Map
    A list of recurrence definitions. Length must be 1.

    MonitorSchedulingOptionCustomScheduleRecurrence, MonitorSchedulingOptionCustomScheduleRecurrenceArgs

    Rrule string
    Must be a valid rrule. See API docs for supported fields
    Timezone string
    'tz database' format. Example: America/New_York or UTC
    Start string
    Time to start recurrence cycle. Similar to DTSTART. Expected format 'YYYY-MM-DDThh:mm:ss'
    Rrule string
    Must be a valid rrule. See API docs for supported fields
    Timezone string
    'tz database' format. Example: America/New_York or UTC
    Start string
    Time to start recurrence cycle. Similar to DTSTART. Expected format 'YYYY-MM-DDThh:mm:ss'
    rrule String
    Must be a valid rrule. See API docs for supported fields
    timezone String
    'tz database' format. Example: America/New_York or UTC
    start String
    Time to start recurrence cycle. Similar to DTSTART. Expected format 'YYYY-MM-DDThh:mm:ss'
    rrule string
    Must be a valid rrule. See API docs for supported fields
    timezone string
    'tz database' format. Example: America/New_York or UTC
    start string
    Time to start recurrence cycle. Similar to DTSTART. Expected format 'YYYY-MM-DDThh:mm:ss'
    rrule str
    Must be a valid rrule. See API docs for supported fields
    timezone str
    'tz database' format. Example: America/New_York or UTC
    start str
    Time to start recurrence cycle. Similar to DTSTART. Expected format 'YYYY-MM-DDThh:mm:ss'
    rrule String
    Must be a valid rrule. See API docs for supported fields
    timezone String
    'tz database' format. Example: America/New_York or UTC
    start String
    Time to start recurrence cycle. Similar to DTSTART. Expected format 'YYYY-MM-DDThh:mm:ss'

    MonitorSchedulingOptionEvaluationWindow, MonitorSchedulingOptionEvaluationWindowArgs

    DayStarts string
    The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.
    HourStarts int
    The minute of the hour at which a one hour cumulative evaluation window starts. Must be between 0 and 59.
    MonthStarts int
    The day of the month at which a one month cumulative evaluation window starts. Must be a value of 1.
    DayStarts string
    The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.
    HourStarts int
    The minute of the hour at which a one hour cumulative evaluation window starts. Must be between 0 and 59.
    MonthStarts int
    The day of the month at which a one month cumulative evaluation window starts. Must be a value of 1.
    dayStarts String
    The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.
    hourStarts Integer
    The minute of the hour at which a one hour cumulative evaluation window starts. Must be between 0 and 59.
    monthStarts Integer
    The day of the month at which a one month cumulative evaluation window starts. Must be a value of 1.
    dayStarts string
    The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.
    hourStarts number
    The minute of the hour at which a one hour cumulative evaluation window starts. Must be between 0 and 59.
    monthStarts number
    The day of the month at which a one month cumulative evaluation window starts. Must be a value of 1.
    day_starts str
    The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.
    hour_starts int
    The minute of the hour at which a one hour cumulative evaluation window starts. Must be between 0 and 59.
    month_starts int
    The day of the month at which a one month cumulative evaluation window starts. Must be a value of 1.
    dayStarts String
    The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.
    hourStarts Number
    The minute of the hour at which a one hour cumulative evaluation window starts. Must be between 0 and 59.
    monthStarts Number
    The day of the month at which a one month cumulative evaluation window starts. Must be a value of 1.

    MonitorVariables, MonitorVariablesArgs

    EventQueries List<MonitorVariablesEventQuery>
    A timeseries formula and functions events query.
    EventQueries []MonitorVariablesEventQuery
    A timeseries formula and functions events query.
    eventQueries List<MonitorVariablesEventQuery>
    A timeseries formula and functions events query.
    eventQueries MonitorVariablesEventQuery[]
    A timeseries formula and functions events query.
    event_queries Sequence[MonitorVariablesEventQuery]
    A timeseries formula and functions events query.
    eventQueries List<Property Map>
    A timeseries formula and functions events query.

    MonitorVariablesEventQuery, MonitorVariablesEventQueryArgs

    Computes List<MonitorVariablesEventQueryCompute>
    The compute options.
    DataSource string
    The data source for event platform-based queries. Valid values are rum, ci_pipelines, ci_tests, audit, events, logs, spans, database_queries, network.
    Name string
    The name of query for use in formulas.
    Search MonitorVariablesEventQuerySearch
    The search options.
    GroupBies List<MonitorVariablesEventQueryGroupBy>
    Group by options.
    Indexes List<string>
    An array of index names to query in the stream.
    Computes []MonitorVariablesEventQueryCompute
    The compute options.
    DataSource string
    The data source for event platform-based queries. Valid values are rum, ci_pipelines, ci_tests, audit, events, logs, spans, database_queries, network.
    Name string
    The name of query for use in formulas.
    Search MonitorVariablesEventQuerySearch
    The search options.
    GroupBies []MonitorVariablesEventQueryGroupBy
    Group by options.
    Indexes []string
    An array of index names to query in the stream.
    computes List<MonitorVariablesEventQueryCompute>
    The compute options.
    dataSource String
    The data source for event platform-based queries. Valid values are rum, ci_pipelines, ci_tests, audit, events, logs, spans, database_queries, network.
    name String
    The name of query for use in formulas.
    search MonitorVariablesEventQuerySearch
    The search options.
    groupBies List<MonitorVariablesEventQueryGroupBy>
    Group by options.
    indexes List<String>
    An array of index names to query in the stream.
    computes MonitorVariablesEventQueryCompute[]
    The compute options.
    dataSource string
    The data source for event platform-based queries. Valid values are rum, ci_pipelines, ci_tests, audit, events, logs, spans, database_queries, network.
    name string
    The name of query for use in formulas.
    search MonitorVariablesEventQuerySearch
    The search options.
    groupBies MonitorVariablesEventQueryGroupBy[]
    Group by options.
    indexes string[]
    An array of index names to query in the stream.
    computes Sequence[MonitorVariablesEventQueryCompute]
    The compute options.
    data_source str
    The data source for event platform-based queries. Valid values are rum, ci_pipelines, ci_tests, audit, events, logs, spans, database_queries, network.
    name str
    The name of query for use in formulas.
    search MonitorVariablesEventQuerySearch
    The search options.
    group_bies Sequence[MonitorVariablesEventQueryGroupBy]
    Group by options.
    indexes Sequence[str]
    An array of index names to query in the stream.
    computes List<Property Map>
    The compute options.
    dataSource String
    The data source for event platform-based queries. Valid values are rum, ci_pipelines, ci_tests, audit, events, logs, spans, database_queries, network.
    name String
    The name of query for use in formulas.
    search Property Map
    The search options.
    groupBies List<Property Map>
    Group by options.
    indexes List<String>
    An array of index names to query in the stream.

    MonitorVariablesEventQueryCompute, MonitorVariablesEventQueryComputeArgs

    Aggregation string
    The aggregation methods for event platform queries. Valid values are count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, min, max, avg.
    Interval int
    A time interval in milliseconds.
    Metric string
    The measurable attribute to compute.
    Aggregation string
    The aggregation methods for event platform queries. Valid values are count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, min, max, avg.
    Interval int
    A time interval in milliseconds.
    Metric string
    The measurable attribute to compute.
    aggregation String
    The aggregation methods for event platform queries. Valid values are count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, min, max, avg.
    interval Integer
    A time interval in milliseconds.
    metric String
    The measurable attribute to compute.
    aggregation string
    The aggregation methods for event platform queries. Valid values are count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, min, max, avg.
    interval number
    A time interval in milliseconds.
    metric string
    The measurable attribute to compute.
    aggregation str
    The aggregation methods for event platform queries. Valid values are count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, min, max, avg.
    interval int
    A time interval in milliseconds.
    metric str
    The measurable attribute to compute.
    aggregation String
    The aggregation methods for event platform queries. Valid values are count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, min, max, avg.
    interval Number
    A time interval in milliseconds.
    metric String
    The measurable attribute to compute.

    MonitorVariablesEventQueryGroupBy, MonitorVariablesEventQueryGroupByArgs

    Facet string
    The event facet.
    Limit int
    The number of groups to return.
    Sort MonitorVariablesEventQueryGroupBySort
    The options for sorting group by results.
    Facet string
    The event facet.
    Limit int
    The number of groups to return.
    Sort MonitorVariablesEventQueryGroupBySort
    The options for sorting group by results.
    facet String
    The event facet.
    limit Integer
    The number of groups to return.
    sort MonitorVariablesEventQueryGroupBySort
    The options for sorting group by results.
    facet string
    The event facet.
    limit number
    The number of groups to return.
    sort MonitorVariablesEventQueryGroupBySort
    The options for sorting group by results.
    facet str
    The event facet.
    limit int
    The number of groups to return.
    sort MonitorVariablesEventQueryGroupBySort
    The options for sorting group by results.
    facet String
    The event facet.
    limit Number
    The number of groups to return.
    sort Property Map
    The options for sorting group by results.

    MonitorVariablesEventQueryGroupBySort, MonitorVariablesEventQueryGroupBySortArgs

    Aggregation string
    The aggregation methods for the event platform queries. Valid values are count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, min, max, avg.
    Metric string
    The metric used for sorting group by results.
    Order string
    Direction of sort. Valid values are asc, desc.
    Aggregation string
    The aggregation methods for the event platform queries. Valid values are count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, min, max, avg.
    Metric string
    The metric used for sorting group by results.
    Order string
    Direction of sort. Valid values are asc, desc.
    aggregation String
    The aggregation methods for the event platform queries. Valid values are count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, min, max, avg.
    metric String
    The metric used for sorting group by results.
    order String
    Direction of sort. Valid values are asc, desc.
    aggregation string
    The aggregation methods for the event platform queries. Valid values are count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, min, max, avg.
    metric string
    The metric used for sorting group by results.
    order string
    Direction of sort. Valid values are asc, desc.
    aggregation str
    The aggregation methods for the event platform queries. Valid values are count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, min, max, avg.
    metric str
    The metric used for sorting group by results.
    order str
    Direction of sort. Valid values are asc, desc.
    aggregation String
    The aggregation methods for the event platform queries. Valid values are count, cardinality, median, pc75, pc90, pc95, pc98, pc99, sum, min, max, avg.
    metric String
    The metric used for sorting group by results.
    order String
    Direction of sort. Valid values are asc, desc.

    MonitorVariablesEventQuerySearch, MonitorVariablesEventQuerySearchArgs

    Query string
    The events search string.
    Query string
    The events search string.
    query String
    The events search string.
    query string
    The events search string.
    query str
    The events search string.
    query String
    The events search string.

    Import

    $ pulumi import datadog:index/monitor:Monitor bytes_received_localhost 2081

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

    Package Details

    Repository
    Datadog pulumi/pulumi-datadog
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the datadog Terraform Provider.
    datadog logo
    Datadog v4.36.1 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-datadog