datadog.Monitor
Explore with Pulumi AI
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,
            notification_preset_name: Optional[str] = None,
            notify_no_data: Optional[bool] = None,
            groupby_simple_monitor: Optional[bool] = None,
            include_tags: Optional[bool] = None,
            locked: Optional[bool] = None,
            force_delete: Optional[bool] = None,
            monitor_threshold_windows: Optional[MonitorMonitorThresholdWindowsArgs] = None,
            monitor_thresholds: Optional[MonitorMonitorThresholdsArgs] = None,
            evaluation_delay: Optional[int] = None,
            new_group_delay: Optional[int] = None,
            new_host_delay: Optional[int] = None,
            no_data_timeframe: Optional[int] = None,
            enable_logs_sample: Optional[bool] = None,
            notify_audit: Optional[bool] = None,
            notify_bies: Optional[Sequence[str]] = None,
            group_retention_duration: Optional[str] = None,
            on_missing_data: Optional[str] = None,
            priority: Optional[str] = None,
            escalation_message: 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,
            enable_samples: Optional[bool] = 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",
    NotificationPresetName = "string",
    NotifyNoData = false,
    GroupbySimpleMonitor = false,
    IncludeTags = false,
    ForceDelete = false,
    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",
    },
    EvaluationDelay = 0,
    NewGroupDelay = 0,
    NoDataTimeframe = 0,
    EnableLogsSample = false,
    NotifyAudit = false,
    NotifyBies = new[]
    {
        "string",
    },
    GroupRetentionDuration = "string",
    OnMissingData = "string",
    Priority = "string",
    EscalationMessage = "string",
    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,
    EnableSamples = false,
    Validate = false,
    Variables = new Datadog.Inputs.MonitorVariablesArgs
    {
        CloudCostQueries = new[]
        {
            new Datadog.Inputs.MonitorVariablesCloudCostQueryArgs
            {
                DataSource = "string",
                Name = "string",
                Query = "string",
                Aggregator = "string",
            },
        },
        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"),
	NotificationPresetName: pulumi.String("string"),
	NotifyNoData:           pulumi.Bool(false),
	GroupbySimpleMonitor:   pulumi.Bool(false),
	IncludeTags:            pulumi.Bool(false),
	ForceDelete:            pulumi.Bool(false),
	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"),
	},
	EvaluationDelay:  pulumi.Int(0),
	NewGroupDelay:    pulumi.Int(0),
	NoDataTimeframe:  pulumi.Int(0),
	EnableLogsSample: pulumi.Bool(false),
	NotifyAudit:      pulumi.Bool(false),
	NotifyBies: pulumi.StringArray{
		pulumi.String("string"),
	},
	GroupRetentionDuration: pulumi.String("string"),
	OnMissingData:          pulumi.String("string"),
	Priority:               pulumi.String("string"),
	EscalationMessage:      pulumi.String("string"),
	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),
	EnableSamples: pulumi.Bool(false),
	Validate:      pulumi.Bool(false),
	Variables: &datadog.MonitorVariablesArgs{
		CloudCostQueries: datadog.MonitorVariablesCloudCostQueryArray{
			&datadog.MonitorVariablesCloudCostQueryArgs{
				DataSource: pulumi.String("string"),
				Name:       pulumi.String("string"),
				Query:      pulumi.String("string"),
				Aggregator: pulumi.String("string"),
			},
		},
		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")
    .notificationPresetName("string")
    .notifyNoData(false)
    .groupbySimpleMonitor(false)
    .includeTags(false)
    .forceDelete(false)
    .monitorThresholdWindows(MonitorMonitorThresholdWindowsArgs.builder()
        .recoveryWindow("string")
        .triggerWindow("string")
        .build())
    .monitorThresholds(MonitorMonitorThresholdsArgs.builder()
        .critical("string")
        .criticalRecovery("string")
        .ok("string")
        .unknown("string")
        .warning("string")
        .warningRecovery("string")
        .build())
    .evaluationDelay(0)
    .newGroupDelay(0)
    .noDataTimeframe(0)
    .enableLogsSample(false)
    .notifyAudit(false)
    .notifyBies("string")
    .groupRetentionDuration("string")
    .onMissingData("string")
    .priority("string")
    .escalationMessage("string")
    .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)
    .enableSamples(false)
    .validate(false)
    .variables(MonitorVariablesArgs.builder()
        .cloudCostQueries(MonitorVariablesCloudCostQueryArgs.builder()
            .dataSource("string")
            .name("string")
            .query("string")
            .aggregator("string")
            .build())
        .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",
    notification_preset_name="string",
    notify_no_data=False,
    groupby_simple_monitor=False,
    include_tags=False,
    force_delete=False,
    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",
    },
    evaluation_delay=0,
    new_group_delay=0,
    no_data_timeframe=0,
    enable_logs_sample=False,
    notify_audit=False,
    notify_bies=["string"],
    group_retention_duration="string",
    on_missing_data="string",
    priority="string",
    escalation_message="string",
    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,
    enable_samples=False,
    validate=False,
    variables={
        "cloud_cost_queries": [{
            "data_source": "string",
            "name": "string",
            "query": "string",
            "aggregator": "string",
        }],
        "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",
    notificationPresetName: "string",
    notifyNoData: false,
    groupbySimpleMonitor: false,
    includeTags: false,
    forceDelete: false,
    monitorThresholdWindows: {
        recoveryWindow: "string",
        triggerWindow: "string",
    },
    monitorThresholds: {
        critical: "string",
        criticalRecovery: "string",
        ok: "string",
        unknown: "string",
        warning: "string",
        warningRecovery: "string",
    },
    evaluationDelay: 0,
    newGroupDelay: 0,
    noDataTimeframe: 0,
    enableLogsSample: false,
    notifyAudit: false,
    notifyBies: ["string"],
    groupRetentionDuration: "string",
    onMissingData: "string",
    priority: "string",
    escalationMessage: "string",
    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,
    enableSamples: false,
    validate: false,
    variables: {
        cloudCostQueries: [{
            dataSource: "string",
            name: "string",
            query: "string",
            aggregator: "string",
        }],
        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
    enableSamples: 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:
        cloudCostQueries:
            - aggregator: string
              dataSource: string
              name: string
              query: string
        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.
- EnableLogs boolSample 
- 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 @usernamenotification 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), thetimeframeis set tolast_5mand 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).
- GroupRetention stringDuration 
- 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.
- GroupbySimple boolMonitor 
- Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to
false.
- 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.
- MonitorThreshold MonitorWindows Monitor Threshold Windows 
- A mapping containing recovery_windowandtrigger_windowvalues, e.g.last_15m. Can only be used for, and are required for, anomaly monitors.
- MonitorThresholds MonitorMonitor Thresholds 
- Alert thresholds of the monitor.
- NewGroup intDelay 
- The time (in seconds) to skip evaluations for new groups. new_group_delayoverridesnew_host_delayif it is set to a nonzero value.
- NewHost intDelay 
- 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 setnew_host_delayto zero for monitors grouped by host.
- NoData intTimeframe 
- 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.
- NotificationPreset stringName 
- 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, andpodcan be configured to only notify on each newclusterviolating the alert conditions by settingnotify_byto['cluster']. Tags mentioned innotify_bymust be a subset of the grouping tags in the query. For example, a query grouped byclusterandnamespacecannot notify onregion. Settingnotify_byto[*]configures the monitor to notify as a simple-alert.
- NotifyNo boolData 
- A boolean indicating whether this monitor will notify when data stops reporting.
- OnMissing stringData 
- 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 Countqueries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other thanCount, for exampleGauge,Measure, orRate, 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, anddefault.
- 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.
- RequireFull boolWindow 
- A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends
you set this to falsefor sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set,require_full_windowmust 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.idfield.
- SchedulingOptions List<MonitorScheduling Option> 
- Configuration options for scheduling.
- 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.
- EnableLogs boolSample 
- 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 @usernamenotification 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), thetimeframeis set tolast_5mand 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).
- GroupRetention stringDuration 
- 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.
- GroupbySimple boolMonitor 
- Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to
false.
- 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.
- MonitorThreshold MonitorWindows Monitor Threshold Windows Args 
- A mapping containing recovery_windowandtrigger_windowvalues, e.g.last_15m. Can only be used for, and are required for, anomaly monitors.
- MonitorThresholds MonitorMonitor Thresholds Args 
- Alert thresholds of the monitor.
- NewGroup intDelay 
- The time (in seconds) to skip evaluations for new groups. new_group_delayoverridesnew_host_delayif it is set to a nonzero value.
- NewHost intDelay 
- 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 setnew_host_delayto zero for monitors grouped by host.
- NoData intTimeframe 
- 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.
- NotificationPreset stringName 
- 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, andpodcan be configured to only notify on each newclusterviolating the alert conditions by settingnotify_byto['cluster']. Tags mentioned innotify_bymust be a subset of the grouping tags in the query. For example, a query grouped byclusterandnamespacecannot notify onregion. Settingnotify_byto[*]configures the monitor to notify as a simple-alert.
- NotifyNo boolData 
- A boolean indicating whether this monitor will notify when data stops reporting.
- OnMissing stringData 
- 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 Countqueries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other thanCount, for exampleGauge,Measure, orRate, 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, anddefault.
- 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.
- RequireFull boolWindow 
- A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends
you set this to falsefor sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set,require_full_windowmust 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.idfield.
- SchedulingOptions []MonitorScheduling Option Args 
- Configuration options for scheduling.
- []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 Args 
- 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.
- enableLogs BooleanSample 
- 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 @usernamenotification 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), thetimeframeis set tolast_5mand 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).
- groupRetention StringDuration 
- 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.
- groupbySimple BooleanMonitor 
- Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to
false.
- 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.
- monitorThreshold MonitorWindows Monitor Threshold Windows 
- A mapping containing recovery_windowandtrigger_windowvalues, e.g.last_15m. Can only be used for, and are required for, anomaly monitors.
- monitorThresholds MonitorMonitor Thresholds 
- Alert thresholds of the monitor.
- newGroup IntegerDelay 
- The time (in seconds) to skip evaluations for new groups. new_group_delayoverridesnew_host_delayif it is set to a nonzero value.
- newHost IntegerDelay 
- 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 setnew_host_delayto zero for monitors grouped by host.
- noData IntegerTimeframe 
- 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.
- notificationPreset StringName 
- 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, andpodcan be configured to only notify on each newclusterviolating the alert conditions by settingnotify_byto['cluster']. Tags mentioned innotify_bymust be a subset of the grouping tags in the query. For example, a query grouped byclusterandnamespacecannot notify onregion. Settingnotify_byto[*]configures the monitor to notify as a simple-alert.
- notifyNo BooleanData 
- A boolean indicating whether this monitor will notify when data stops reporting.
- onMissing StringData 
- 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 Countqueries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other thanCount, for exampleGauge,Measure, orRate, 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, anddefault.
- 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.
- requireFull BooleanWindow 
- A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends
you set this to falsefor sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set,require_full_windowmust 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.idfield.
- schedulingOptions List<MonitorScheduling Option> 
- Configuration options for scheduling.
- 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.
- enableLogs booleanSample 
- 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 @usernamenotification 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), thetimeframeis set tolast_5mand 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).
- groupRetention stringDuration 
- 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.
- groupbySimple booleanMonitor 
- Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to
false.
- 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.
- monitorThreshold MonitorWindows Monitor Threshold Windows 
- A mapping containing recovery_windowandtrigger_windowvalues, e.g.last_15m. Can only be used for, and are required for, anomaly monitors.
- monitorThresholds MonitorMonitor Thresholds 
- Alert thresholds of the monitor.
- newGroup numberDelay 
- The time (in seconds) to skip evaluations for new groups. new_group_delayoverridesnew_host_delayif it is set to a nonzero value.
- newHost numberDelay 
- 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 setnew_host_delayto zero for monitors grouped by host.
- noData numberTimeframe 
- 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.
- notificationPreset stringName 
- 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, andpodcan be configured to only notify on each newclusterviolating the alert conditions by settingnotify_byto['cluster']. Tags mentioned innotify_bymust be a subset of the grouping tags in the query. For example, a query grouped byclusterandnamespacecannot notify onregion. Settingnotify_byto[*]configures the monitor to notify as a simple-alert.
- notifyNo booleanData 
- A boolean indicating whether this monitor will notify when data stops reporting.
- onMissing stringData 
- 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 Countqueries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other thanCount, for exampleGauge,Measure, orRate, 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, anddefault.
- 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.
- requireFull booleanWindow 
- A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends
you set this to falsefor sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set,require_full_windowmust 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.idfield.
- schedulingOptions MonitorScheduling Option[] 
- Configuration options for scheduling.
- 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_ boolsample 
- 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 @usernamenotification 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), thetimeframeis set tolast_5mand 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_ strduration 
- 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_ boolmonitor 
- Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to
false.
- 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.
- monitor_threshold_ Monitorwindows Monitor Threshold Windows Args 
- A mapping containing recovery_windowandtrigger_windowvalues, e.g.last_15m. Can only be used for, and are required for, anomaly monitors.
- monitor_thresholds MonitorMonitor Thresholds Args 
- Alert thresholds of the monitor.
- new_group_ intdelay 
- The time (in seconds) to skip evaluations for new groups. new_group_delayoverridesnew_host_delayif it is set to a nonzero value.
- new_host_ intdelay 
- 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 setnew_host_delayto zero for monitors grouped by host.
- no_data_ inttimeframe 
- 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_ strname 
- 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, andpodcan be configured to only notify on each newclusterviolating the alert conditions by settingnotify_byto['cluster']. Tags mentioned innotify_bymust be a subset of the grouping tags in the query. For example, a query grouped byclusterandnamespacecannot notify onregion. Settingnotify_byto[*]configures the monitor to notify as a simple-alert.
- notify_no_ booldata 
- A boolean indicating whether this monitor will notify when data stops reporting.
- on_missing_ strdata 
- 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 Countqueries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other thanCount, for exampleGauge,Measure, orRate, 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, anddefault.
- 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_ boolwindow 
- A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends
you set this to falsefor sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set,require_full_windowmust 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.idfield.
- scheduling_options Sequence[MonitorScheduling Option Args] 
- Configuration options for scheduling.
- 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
MonitorVariables Args 
- 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.
- enableLogs BooleanSample 
- 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 @usernamenotification 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), thetimeframeis set tolast_5mand 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).
- groupRetention StringDuration 
- 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.
- groupbySimple BooleanMonitor 
- Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to
false.
- 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.
- monitorThreshold Property MapWindows 
- A mapping containing recovery_windowandtrigger_windowvalues, e.g.last_15m. Can only be used for, and are required for, anomaly monitors.
- monitorThresholds Property Map
- Alert thresholds of the monitor.
- newGroup NumberDelay 
- The time (in seconds) to skip evaluations for new groups. new_group_delayoverridesnew_host_delayif it is set to a nonzero value.
- newHost NumberDelay 
- 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 setnew_host_delayto zero for monitors grouped by host.
- noData NumberTimeframe 
- 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.
- notificationPreset StringName 
- 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, andpodcan be configured to only notify on each newclusterviolating the alert conditions by settingnotify_byto['cluster']. Tags mentioned innotify_bymust be a subset of the grouping tags in the query. For example, a query grouped byclusterandnamespacecannot notify onregion. Settingnotify_byto[*]configures the monitor to notify as a simple-alert.
- notifyNo BooleanData 
- A boolean indicating whether this monitor will notify when data stops reporting.
- onMissing StringData 
- 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 Countqueries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other thanCount, for exampleGauge,Measure, orRate, 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, anddefault.
- 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.
- requireFull BooleanWindow 
- A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends
you set this to falsefor sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set,require_full_windowmust 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.idfield.
- schedulingOptions List<Property Map>
- Configuration options for scheduling.
- 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:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- 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) -> Monitorfunc 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)resources:  _:    type: datadog:Monitor    get:      id: ${id}- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- EnableLogs boolSample 
- 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 @usernamenotification 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), thetimeframeis set tolast_5mand 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).
- GroupRetention stringDuration 
- 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.
- GroupbySimple boolMonitor 
- Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to
false.
- 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.
- Message string
- A message to include with notifications for this monitor.
- MonitorThreshold MonitorWindows Monitor Threshold Windows 
- A mapping containing recovery_windowandtrigger_windowvalues, e.g.last_15m. Can only be used for, and are required for, anomaly monitors.
- MonitorThresholds MonitorMonitor Thresholds 
- Alert thresholds of the monitor.
- Name string
- Name of Datadog monitor.
- NewGroup intDelay 
- The time (in seconds) to skip evaluations for new groups. new_group_delayoverridesnew_host_delayif it is set to a nonzero value.
- NewHost intDelay 
- 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 setnew_host_delayto zero for monitors grouped by host.
- NoData intTimeframe 
- 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.
- NotificationPreset stringName 
- 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, andpodcan be configured to only notify on each newclusterviolating the alert conditions by settingnotify_byto['cluster']. Tags mentioned innotify_bymust be a subset of the grouping tags in the query. For example, a query grouped byclusterandnamespacecannot notify onregion. Settingnotify_byto[*]configures the monitor to notify as a simple-alert.
- NotifyNo boolData 
- A boolean indicating whether this monitor will notify when data stops reporting.
- OnMissing stringData 
- 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 Countqueries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other thanCount, for exampleGauge,Measure, orRate, 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, anddefault.
- 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.
- RequireFull boolWindow 
- A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends
you set this to falsefor sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set,require_full_windowmust 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.idfield.
- SchedulingOptions List<MonitorScheduling Option> 
- Configuration options for scheduling.
- 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 
- EnableLogs boolSample 
- 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 @usernamenotification 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), thetimeframeis set tolast_5mand 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).
- GroupRetention stringDuration 
- 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.
- GroupbySimple boolMonitor 
- Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to
false.
- 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.
- Message string
- A message to include with notifications for this monitor.
- MonitorThreshold MonitorWindows Monitor Threshold Windows Args 
- A mapping containing recovery_windowandtrigger_windowvalues, e.g.last_15m. Can only be used for, and are required for, anomaly monitors.
- MonitorThresholds MonitorMonitor Thresholds Args 
- Alert thresholds of the monitor.
- Name string
- Name of Datadog monitor.
- NewGroup intDelay 
- The time (in seconds) to skip evaluations for new groups. new_group_delayoverridesnew_host_delayif it is set to a nonzero value.
- NewHost intDelay 
- 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 setnew_host_delayto zero for monitors grouped by host.
- NoData intTimeframe 
- 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.
- NotificationPreset stringName 
- 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, andpodcan be configured to only notify on each newclusterviolating the alert conditions by settingnotify_byto['cluster']. Tags mentioned innotify_bymust be a subset of the grouping tags in the query. For example, a query grouped byclusterandnamespacecannot notify onregion. Settingnotify_byto[*]configures the monitor to notify as a simple-alert.
- NotifyNo boolData 
- A boolean indicating whether this monitor will notify when data stops reporting.
- OnMissing stringData 
- 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 Countqueries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other thanCount, for exampleGauge,Measure, orRate, 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, anddefault.
- 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.
- RequireFull boolWindow 
- A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends
you set this to falsefor sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set,require_full_windowmust 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.idfield.
- SchedulingOptions []MonitorScheduling Option Args 
- Configuration options for scheduling.
- []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 Args 
- enableLogs BooleanSample 
- 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 @usernamenotification 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), thetimeframeis set tolast_5mand 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).
- groupRetention StringDuration 
- 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.
- groupbySimple BooleanMonitor 
- Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to
false.
- 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.
- message String
- A message to include with notifications for this monitor.
- monitorThreshold MonitorWindows Monitor Threshold Windows 
- A mapping containing recovery_windowandtrigger_windowvalues, e.g.last_15m. Can only be used for, and are required for, anomaly monitors.
- monitorThresholds MonitorMonitor Thresholds 
- Alert thresholds of the monitor.
- name String
- Name of Datadog monitor.
- newGroup IntegerDelay 
- The time (in seconds) to skip evaluations for new groups. new_group_delayoverridesnew_host_delayif it is set to a nonzero value.
- newHost IntegerDelay 
- 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 setnew_host_delayto zero for monitors grouped by host.
- noData IntegerTimeframe 
- 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.
- notificationPreset StringName 
- 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, andpodcan be configured to only notify on each newclusterviolating the alert conditions by settingnotify_byto['cluster']. Tags mentioned innotify_bymust be a subset of the grouping tags in the query. For example, a query grouped byclusterandnamespacecannot notify onregion. Settingnotify_byto[*]configures the monitor to notify as a simple-alert.
- notifyNo BooleanData 
- A boolean indicating whether this monitor will notify when data stops reporting.
- onMissing StringData 
- 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 Countqueries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other thanCount, for exampleGauge,Measure, orRate, 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, anddefault.
- 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.
- requireFull BooleanWindow 
- A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends
you set this to falsefor sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set,require_full_windowmust 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.idfield.
- schedulingOptions List<MonitorScheduling Option> 
- Configuration options for scheduling.
- 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 
- enableLogs booleanSample 
- 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 @usernamenotification 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), thetimeframeis set tolast_5mand 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).
- groupRetention stringDuration 
- 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.
- groupbySimple booleanMonitor 
- Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to
false.
- 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.
- message string
- A message to include with notifications for this monitor.
- monitorThreshold MonitorWindows Monitor Threshold Windows 
- A mapping containing recovery_windowandtrigger_windowvalues, e.g.last_15m. Can only be used for, and are required for, anomaly monitors.
- monitorThresholds MonitorMonitor Thresholds 
- Alert thresholds of the monitor.
- name string
- Name of Datadog monitor.
- newGroup numberDelay 
- The time (in seconds) to skip evaluations for new groups. new_group_delayoverridesnew_host_delayif it is set to a nonzero value.
- newHost numberDelay 
- 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 setnew_host_delayto zero for monitors grouped by host.
- noData numberTimeframe 
- 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.
- notificationPreset stringName 
- 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, andpodcan be configured to only notify on each newclusterviolating the alert conditions by settingnotify_byto['cluster']. Tags mentioned innotify_bymust be a subset of the grouping tags in the query. For example, a query grouped byclusterandnamespacecannot notify onregion. Settingnotify_byto[*]configures the monitor to notify as a simple-alert.
- notifyNo booleanData 
- A boolean indicating whether this monitor will notify when data stops reporting.
- onMissing stringData 
- 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 Countqueries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other thanCount, for exampleGauge,Measure, orRate, 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, anddefault.
- 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.
- requireFull booleanWindow 
- A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends
you set this to falsefor sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set,require_full_windowmust 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.idfield.
- schedulingOptions MonitorScheduling Option[] 
- Configuration options for scheduling.
- 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_ boolsample 
- 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 @usernamenotification 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), thetimeframeis set tolast_5mand 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_ strduration 
- 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_ boolmonitor 
- Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to
false.
- 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.
- message str
- A message to include with notifications for this monitor.
- monitor_threshold_ Monitorwindows Monitor Threshold Windows Args 
- A mapping containing recovery_windowandtrigger_windowvalues, e.g.last_15m. Can only be used for, and are required for, anomaly monitors.
- monitor_thresholds MonitorMonitor Thresholds Args 
- Alert thresholds of the monitor.
- name str
- Name of Datadog monitor.
- new_group_ intdelay 
- The time (in seconds) to skip evaluations for new groups. new_group_delayoverridesnew_host_delayif it is set to a nonzero value.
- new_host_ intdelay 
- 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 setnew_host_delayto zero for monitors grouped by host.
- no_data_ inttimeframe 
- 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_ strname 
- 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, andpodcan be configured to only notify on each newclusterviolating the alert conditions by settingnotify_byto['cluster']. Tags mentioned innotify_bymust be a subset of the grouping tags in the query. For example, a query grouped byclusterandnamespacecannot notify onregion. Settingnotify_byto[*]configures the monitor to notify as a simple-alert.
- notify_no_ booldata 
- A boolean indicating whether this monitor will notify when data stops reporting.
- on_missing_ strdata 
- 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 Countqueries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other thanCount, for exampleGauge,Measure, orRate, 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, anddefault.
- 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_ boolwindow 
- A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends
you set this to falsefor sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set,require_full_windowmust 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.idfield.
- scheduling_options Sequence[MonitorScheduling Option Args] 
- Configuration options for scheduling.
- 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
MonitorVariables Args 
- enableLogs BooleanSample 
- 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 @usernamenotification 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), thetimeframeis set tolast_5mand 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).
- groupRetention StringDuration 
- 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.
- groupbySimple BooleanMonitor 
- Whether or not to trigger one alert if any source breaches a threshold. This is only used by log monitors. Defaults to
false.
- 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.
- message String
- A message to include with notifications for this monitor.
- monitorThreshold Property MapWindows 
- A mapping containing recovery_windowandtrigger_windowvalues, 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.
- newGroup NumberDelay 
- The time (in seconds) to skip evaluations for new groups. new_group_delayoverridesnew_host_delayif it is set to a nonzero value.
- newHost NumberDelay 
- 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 setnew_host_delayto zero for monitors grouped by host.
- noData NumberTimeframe 
- 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.
- notificationPreset StringName 
- 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, andpodcan be configured to only notify on each newclusterviolating the alert conditions by settingnotify_byto['cluster']. Tags mentioned innotify_bymust be a subset of the grouping tags in the query. For example, a query grouped byclusterandnamespacecannot notify onregion. Settingnotify_byto[*]configures the monitor to notify as a simple-alert.
- notifyNo BooleanData 
- A boolean indicating whether this monitor will notify when data stops reporting.
- onMissing StringData 
- 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 Countqueries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other thanCount, for exampleGauge,Measure, orRate, 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, anddefault.
- 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.
- requireFull BooleanWindow 
- A boolean indicating whether this monitor needs a full window of data before it's evaluated. Datadog strongly recommends
you set this to falsefor sparse metrics, otherwise some evaluations may be skipped. If there's a custom_schedule set,require_full_windowmust 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.idfield.
- schedulingOptions List<Property Map>
- Configuration options for scheduling.
- 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 CRITICALthreshold. Must be a number.
- CriticalRecovery string
- The monitor CRITICALrecovery threshold. Must be a number.
- Ok string
- The monitor OKthreshold. Only supported in monitor typeservice check. Must be a number.
- Unknown string
- The monitor UNKNOWNthreshold. Only supported in monitor typeservice check. Must be a number.
- Warning string
- The monitor WARNINGthreshold. Must be a number.
- WarningRecovery string
- The monitor WARNINGrecovery threshold. Must be a number.
- Critical string
- The monitor CRITICALthreshold. Must be a number.
- CriticalRecovery string
- The monitor CRITICALrecovery threshold. Must be a number.
- Ok string
- The monitor OKthreshold. Only supported in monitor typeservice check. Must be a number.
- Unknown string
- The monitor UNKNOWNthreshold. Only supported in monitor typeservice check. Must be a number.
- Warning string
- The monitor WARNINGthreshold. Must be a number.
- WarningRecovery string
- The monitor WARNINGrecovery threshold. Must be a number.
- critical String
- The monitor CRITICALthreshold. Must be a number.
- criticalRecovery String
- The monitor CRITICALrecovery threshold. Must be a number.
- ok String
- The monitor OKthreshold. Only supported in monitor typeservice check. Must be a number.
- unknown String
- The monitor UNKNOWNthreshold. Only supported in monitor typeservice check. Must be a number.
- warning String
- The monitor WARNINGthreshold. Must be a number.
- warningRecovery String
- The monitor WARNINGrecovery threshold. Must be a number.
- critical string
- The monitor CRITICALthreshold. Must be a number.
- criticalRecovery string
- The monitor CRITICALrecovery threshold. Must be a number.
- ok string
- The monitor OKthreshold. Only supported in monitor typeservice check. Must be a number.
- unknown string
- The monitor UNKNOWNthreshold. Only supported in monitor typeservice check. Must be a number.
- warning string
- The monitor WARNINGthreshold. Must be a number.
- warningRecovery string
- The monitor WARNINGrecovery threshold. Must be a number.
- critical str
- The monitor CRITICALthreshold. Must be a number.
- critical_recovery str
- The monitor CRITICALrecovery threshold. Must be a number.
- ok str
- The monitor OKthreshold. Only supported in monitor typeservice check. Must be a number.
- unknown str
- The monitor UNKNOWNthreshold. Only supported in monitor typeservice check. Must be a number.
- warning str
- The monitor WARNINGthreshold. Must be a number.
- warning_recovery str
- The monitor WARNINGrecovery threshold. Must be a number.
- critical String
- The monitor CRITICALthreshold. Must be a number.
- criticalRecovery String
- The monitor CRITICALrecovery threshold. Must be a number.
- ok String
- The monitor OKthreshold. Only supported in monitor typeservice check. Must be a number.
- unknown String
- The monitor UNKNOWNthreshold. Only supported in monitor typeservice check. Must be a number.
- warning String
- The monitor WARNINGthreshold. Must be a number.
- warningRecovery String
- The monitor WARNINGrecovery threshold. Must be a number.
MonitorSchedulingOption, MonitorSchedulingOptionArgs      
- CustomSchedules List<MonitorScheduling Option Custom Schedule> 
- Configuration options for the custom schedules. If startis omitted, the monitor creation time will be used.
- EvaluationWindows List<MonitorScheduling Option Evaluation Window> 
- Configuration options for the evaluation window. If hour_startsis set, no other fields may be set. Otherwise,day_startsandmonth_startsmust be set together.
- CustomSchedules []MonitorScheduling Option Custom Schedule 
- Configuration options for the custom schedules. If startis omitted, the monitor creation time will be used.
- EvaluationWindows []MonitorScheduling Option Evaluation Window 
- Configuration options for the evaluation window. If hour_startsis set, no other fields may be set. Otherwise,day_startsandmonth_startsmust be set together.
- customSchedules List<MonitorScheduling Option Custom Schedule> 
- Configuration options for the custom schedules. If startis omitted, the monitor creation time will be used.
- evaluationWindows List<MonitorScheduling Option Evaluation Window> 
- Configuration options for the evaluation window. If hour_startsis set, no other fields may be set. Otherwise,day_startsandmonth_startsmust be set together.
- customSchedules MonitorScheduling Option Custom Schedule[] 
- Configuration options for the custom schedules. If startis omitted, the monitor creation time will be used.
- evaluationWindows MonitorScheduling Option Evaluation Window[] 
- Configuration options for the evaluation window. If hour_startsis set, no other fields may be set. Otherwise,day_startsandmonth_startsmust be set together.
- custom_schedules Sequence[MonitorScheduling Option Custom Schedule] 
- Configuration options for the custom schedules. If startis omitted, the monitor creation time will be used.
- evaluation_windows Sequence[MonitorScheduling Option Evaluation Window] 
- Configuration options for the evaluation window. If hour_startsis set, no other fields may be set. Otherwise,day_startsandmonth_startsmust be set together.
- customSchedules List<Property Map>
- Configuration options for the custom schedules. If startis omitted, the monitor creation time will be used.
- evaluationWindows List<Property Map>
- Configuration options for the evaluation window. If hour_startsis set, no other fields may be set. Otherwise,day_startsandmonth_startsmust be set together.
MonitorSchedulingOptionCustomSchedule, MonitorSchedulingOptionCustomScheduleArgs          
- Recurrence
MonitorScheduling Option Custom Schedule Recurrence 
- A list of recurrence definitions. Length must be 1.
- Recurrence
MonitorScheduling Option Custom Schedule Recurrence 
- A list of recurrence definitions. Length must be 1.
- recurrence
MonitorScheduling Option Custom Schedule Recurrence 
- A list of recurrence definitions. Length must be 1.
- recurrence
MonitorScheduling Option Custom Schedule Recurrence 
- A list of recurrence definitions. Length must be 1.
- recurrence
MonitorScheduling Option Custom Schedule Recurrence 
- A list of recurrence definitions. Length must be 1.
- recurrence Property Map
- A list of recurrence definitions. Length must be 1.
MonitorSchedulingOptionCustomScheduleRecurrence, MonitorSchedulingOptionCustomScheduleRecurrenceArgs            
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:mmformat.
- 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:mmformat.
- 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:mmformat.
- 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:mmformat.
- 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:mmformat.
- 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:mmformat.
- 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    
- CloudCost List<MonitorQueries Variables Cloud Cost Query> 
- The Cloud Cost query using formulas and functions.
- EventQueries List<MonitorVariables Event Query> 
- A timeseries formula and functions events query.
- CloudCost []MonitorQueries Variables Cloud Cost Query 
- The Cloud Cost query using formulas and functions.
- EventQueries []MonitorVariables Event Query 
- A timeseries formula and functions events query.
- cloudCost List<MonitorQueries Variables Cloud Cost Query> 
- The Cloud Cost query using formulas and functions.
- eventQueries List<MonitorVariables Event Query> 
- A timeseries formula and functions events query.
- cloudCost MonitorQueries Variables Cloud Cost Query[] 
- The Cloud Cost query using formulas and functions.
- eventQueries MonitorVariables Event Query[] 
- A timeseries formula and functions events query.
- cloud_cost_ Sequence[Monitorqueries Variables Cloud Cost Query] 
- The Cloud Cost query using formulas and functions.
- event_queries Sequence[MonitorVariables Event Query] 
- A timeseries formula and functions events query.
- cloudCost List<Property Map>Queries 
- The Cloud Cost query using formulas and functions.
- eventQueries List<Property Map>
- A timeseries formula and functions events query.
MonitorVariablesCloudCostQuery, MonitorVariablesCloudCostQueryArgs          
- DataSource string
- The data source for cloud cost queries. Valid values are metrics,cloud_cost,datadog_usage.
- Name string
- The name of the query for use in formulas.
- Query string
- The cloud cost query definition.
- Aggregator string
- The aggregation methods available for cloud cost queries. Valid values are avg,sum,max,min,last,area,l2norm,percentile,stddev.
- DataSource string
- The data source for cloud cost queries. Valid values are metrics,cloud_cost,datadog_usage.
- Name string
- The name of the query for use in formulas.
- Query string
- The cloud cost query definition.
- Aggregator string
- The aggregation methods available for cloud cost queries. Valid values are avg,sum,max,min,last,area,l2norm,percentile,stddev.
- dataSource String
- The data source for cloud cost queries. Valid values are metrics,cloud_cost,datadog_usage.
- name String
- The name of the query for use in formulas.
- query String
- The cloud cost query definition.
- aggregator String
- The aggregation methods available for cloud cost queries. Valid values are avg,sum,max,min,last,area,l2norm,percentile,stddev.
- dataSource string
- The data source for cloud cost queries. Valid values are metrics,cloud_cost,datadog_usage.
- name string
- The name of the query for use in formulas.
- query string
- The cloud cost query definition.
- aggregator string
- The aggregation methods available for cloud cost queries. Valid values are avg,sum,max,min,last,area,l2norm,percentile,stddev.
- data_source str
- The data source for cloud cost queries. Valid values are metrics,cloud_cost,datadog_usage.
- name str
- The name of the query for use in formulas.
- query str
- The cloud cost query definition.
- aggregator str
- The aggregation methods available for cloud cost queries. Valid values are avg,sum,max,min,last,area,l2norm,percentile,stddev.
- dataSource String
- The data source for cloud cost queries. Valid values are metrics,cloud_cost,datadog_usage.
- name String
- The name of the query for use in formulas.
- query String
- The cloud cost query definition.
- aggregator String
- The aggregation methods available for cloud cost queries. Valid values are avg,sum,max,min,last,area,l2norm,percentile,stddev.
MonitorVariablesEventQuery, MonitorVariablesEventQueryArgs        
- Computes
List<MonitorVariables Event Query Compute> 
- 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
MonitorVariables Event Query Search 
- The search options.
- GroupBies List<MonitorVariables Event Query Group By> 
- Group by options.
- Indexes List<string>
- An array of index names to query in the stream.
- Computes
[]MonitorVariables Event Query Compute 
- 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
MonitorVariables Event Query Search 
- The search options.
- GroupBies []MonitorVariables Event Query Group By 
- Group by options.
- Indexes []string
- An array of index names to query in the stream.
- computes
List<MonitorVariables Event Query Compute> 
- 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
MonitorVariables Event Query Search 
- The search options.
- groupBies List<MonitorVariables Event Query Group By> 
- Group by options.
- indexes List<String>
- An array of index names to query in the stream.
- computes
MonitorVariables Event Query Compute[] 
- 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
MonitorVariables Event Query Search 
- The search options.
- groupBies MonitorVariables Event Query Group By[] 
- Group by options.
- indexes string[]
- An array of index names to query in the stream.
- computes
Sequence[MonitorVariables Event Query Compute] 
- 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
MonitorVariables Event Query Search 
- The search options.
- group_bies Sequence[MonitorVariables Event Query Group By] 
- 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
MonitorVariables Event Query Group By Sort 
- The options for sorting group by results.
- Facet string
- The event facet.
- Limit int
- The number of groups to return.
- Sort
MonitorVariables Event Query Group By Sort 
- The options for sorting group by results.
- facet String
- The event facet.
- limit Integer
- The number of groups to return.
- sort
MonitorVariables Event Query Group By Sort 
- The options for sorting group by results.
- facet string
- The event facet.
- limit number
- The number of groups to return.
- sort
MonitorVariables Event Query Group By Sort 
- The options for sorting group by results.
- facet str
- The event facet.
- limit int
- The number of groups to return.
- sort
MonitorVariables Event Query Group By Sort 
- 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 datadogTerraform Provider.