Datadog v4.33.2, Sep 24 24

Datadog v4.33.2 published on Tuesday, Sep 24, 2024 by Pulumi

datadog.getMonitor

Explore with Pulumi AI

Datadog v4.33.2 published on Tuesday, Sep 24, 2024 by Pulumi

Example Usage

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

const test = datadog.getMonitor({
    nameFilter: "My awesome monitor",
    monitorTagsFilters: ["foo:bar"],
});

import pulumi
import pulumi_datadog as datadog

test = datadog.get_monitor(name_filter="My awesome monitor",
    monitor_tags_filters=["foo:bar"])

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.LookupMonitor(ctx, &datadog.LookupMonitorArgs{
			NameFilter: pulumi.StringRef("My awesome monitor"),
			MonitorTagsFilters: []string{
				"foo:bar",
			},
		}, nil)
		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 test = Datadog.GetMonitor.Invoke(new()
    {
        NameFilter = "My awesome monitor",
        MonitorTagsFilters = new[]
        {
            "foo:bar",
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datadog.DatadogFunctions;
import com.pulumi.datadog.inputs.GetMonitorArgs;
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) {
        final var test = DatadogFunctions.getMonitor(GetMonitorArgs.builder()
            .nameFilter("My awesome monitor")
            .monitorTagsFilters("foo:bar")
            .build());

    }
}

variables:
  test:
    fn::invoke:
      Function: datadog:getMonitor
      Arguments:
        nameFilter: My awesome monitor
        monitorTagsFilters:
          - foo:bar

Using getMonitor

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getMonitor(args: GetMonitorArgs, opts?: InvokeOptions): Promise<GetMonitorResult>
function getMonitorOutput(args: GetMonitorOutputArgs, opts?: InvokeOptions): Output<GetMonitorResult>

def get_monitor(monitor_tags_filters: Optional[Sequence[str]] = None,
                name_filter: Optional[str] = None,
                tags_filters: Optional[Sequence[str]] = None,
                opts: Optional[InvokeOptions] = None) -> GetMonitorResult
def get_monitor_output(monitor_tags_filters: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                name_filter: Optional[pulumi.Input[str]] = None,
                tags_filters: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetMonitorResult]

func LookupMonitor(ctx *Context, args *LookupMonitorArgs, opts ...InvokeOption) (*LookupMonitorResult, error)
func LookupMonitorOutput(ctx *Context, args *LookupMonitorOutputArgs, opts ...InvokeOption) LookupMonitorResultOutput

> Note: This function is named LookupMonitor in the Go SDK.

public static class GetMonitor 
{
    public static Task<GetMonitorResult> InvokeAsync(GetMonitorArgs args, InvokeOptions? opts = null)
    public static Output<GetMonitorResult> Invoke(GetMonitorInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetMonitorResult> getMonitor(GetMonitorArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

fn::invoke:
  function: datadog:index/getMonitor:getMonitor
  arguments:
    # arguments dictionary

The following arguments are supported:

MonitorTagsFilters List<string>: A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
NameFilter string: A monitor name to limit the search.
TagsFilters List<string>: A list of tags to limit the search. This filters on the monitor scope.

MonitorTagsFilters []string: A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
NameFilter string: A monitor name to limit the search.
TagsFilters []string: A list of tags to limit the search. This filters on the monitor scope.

monitorTagsFilters List<String>: A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
nameFilter String: A monitor name to limit the search.
tagsFilters List<String>: A list of tags to limit the search. This filters on the monitor scope.

monitorTagsFilters string[]: A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
nameFilter string: A monitor name to limit the search.
tagsFilters string[]: A list of tags to limit the search. This filters on the monitor scope.

monitor_tags_filters Sequence[str]: A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
name_filter str: A monitor name to limit the search.
tags_filters Sequence[str]: A list of tags to limit the search. This filters on the monitor scope.

monitorTagsFilters List<String>: A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
nameFilter String: A monitor name to limit the search.
tagsFilters List<String>: A list of tags to limit the search. This filters on the monitor scope.

getMonitor Result

The following output properties are available:

EnableLogsSample bool: Whether or not a list of log values which triggered the alert is included. This is only used by log monitors.
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: Message included with a re-notification for this monitor.
EvaluationDelay int: Time (in seconds) for which evaluation is delayed. This is only used by metric monitors.
GroupRetentionDuration string: The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
GroupbySimpleMonitor bool: Whether or not to trigger one alert if any source breaches a threshold.
Id string: The provider-assigned unique ID for this managed resource.
IncludeTags bool: Whether or not notifications from the monitor automatically inserts its triggering tags into the title.
Locked bool: Whether or not changes to the monitor are restricted to the creator or admins.
Message string: Message included with notifications for this monitor
MonitorThresholdWindows List<GetMonitorMonitorThresholdWindow>: Mapping containing recovery_window and trigger_window values, e.g. last_15m. This is only used by anomaly monitors.
MonitorThresholds List<GetMonitorMonitorThreshold>: Alert thresholds of the monitor.
Name string: Name of the monitor
NewGroupDelay int: Time (in seconds) to skip evaluations for new groups.
NewHostDelay int: Time (in seconds) allowing a host to boot and applications to fully start before starting the evaluation of monitor results.
NoDataTimeframe int: The number of minutes before the monitor notifies when data stops reporting.
NotificationPresetName string: Toggles the display of additional content sent in the monitor notification. Valid values are: show_all, hide_query, hide_handles, and hide_all.
NotifyAudit bool: Whether or not tagged users are notified on changes to the monitor.
NotifyBies List<string>: Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each new cluster violating the alert conditions by setting notify_by to ['cluster']. Tags mentioned in notify_by must be a subset of the grouping tags in the query. For example, a query grouped by cluster and namespace cannot notify on region. Setting notify_by to [*] configures the monitor to notify as a simple-alert.
NotifyNoData bool: Whether or not this monitor notifies when data stops reporting.
OnMissingData string: Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are: show_no_data, show_and_notify_no_data, resolve, and default.
Query string: Query of the monitor.
RenotifyInterval int: The number of minutes after the last notification before the monitor re-notifies on the current status.
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. Valid values are alert, warn, no data.
RequireFullWindow bool: Whether or not the monitor needs a full window of data before it is evaluated.
RestrictedRoles List<string>
SchedulingOptions List<GetMonitorSchedulingOption>: Configuration options for scheduling.
Tags List<string>: List of tags associated with the monitor.
TimeoutH int: Number of hours of the monitor not reporting data before it automatically resolves from a triggered state.
Type string: Type of the monitor.
MonitorTagsFilters List<string>: A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
NameFilter string: A monitor name to limit the search.
TagsFilters List<string>: A list of tags to limit the search. This filters on the monitor scope.

EnableLogsSample bool: Whether or not a list of log values which triggered the alert is included. This is only used by log monitors.
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: Message included with a re-notification for this monitor.
EvaluationDelay int: Time (in seconds) for which evaluation is delayed. This is only used by metric monitors.
GroupRetentionDuration string: The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
GroupbySimpleMonitor bool: Whether or not to trigger one alert if any source breaches a threshold.
Id string: The provider-assigned unique ID for this managed resource.
IncludeTags bool: Whether or not notifications from the monitor automatically inserts its triggering tags into the title.
Locked bool: Whether or not changes to the monitor are restricted to the creator or admins.
Message string: Message included with notifications for this monitor
MonitorThresholdWindows []GetMonitorMonitorThresholdWindow: Mapping containing recovery_window and trigger_window values, e.g. last_15m. This is only used by anomaly monitors.
MonitorThresholds []GetMonitorMonitorThreshold: Alert thresholds of the monitor.
Name string: Name of the monitor
NewGroupDelay int: Time (in seconds) to skip evaluations for new groups.
NewHostDelay int: Time (in seconds) allowing a host to boot and applications to fully start before starting the evaluation of monitor results.
NoDataTimeframe int: The number of minutes before the monitor notifies when data stops reporting.
NotificationPresetName string: Toggles the display of additional content sent in the monitor notification. Valid values are: show_all, hide_query, hide_handles, and hide_all.
NotifyAudit bool: Whether or not tagged users are notified on changes to the monitor.
NotifyBies []string: Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each new cluster violating the alert conditions by setting notify_by to ['cluster']. Tags mentioned in notify_by must be a subset of the grouping tags in the query. For example, a query grouped by cluster and namespace cannot notify on region. Setting notify_by to [*] configures the monitor to notify as a simple-alert.
NotifyNoData bool: Whether or not this monitor notifies when data stops reporting.
OnMissingData string: Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are: show_no_data, show_and_notify_no_data, resolve, and default.
Query string: Query of the monitor.
RenotifyInterval int: The number of minutes after the last notification before the monitor re-notifies on the current status.
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. Valid values are alert, warn, no data.
RequireFullWindow bool: Whether or not the monitor needs a full window of data before it is evaluated.
RestrictedRoles []string
SchedulingOptions []GetMonitorSchedulingOption: Configuration options for scheduling.
Tags []string: List of tags associated with the monitor.
TimeoutH int: Number of hours of the monitor not reporting data before it automatically resolves from a triggered state.
Type string: Type of the monitor.
MonitorTagsFilters []string: A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
NameFilter string: A monitor name to limit the search.
TagsFilters []string: A list of tags to limit the search. This filters on the monitor scope.

enableLogsSample Boolean: Whether or not a list of log values which triggered the alert is included. This is only used by log monitors.
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: Message included with a re-notification for this monitor.
evaluationDelay Integer: Time (in seconds) for which evaluation is delayed. This is only used by metric monitors.
groupRetentionDuration String: The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
groupbySimpleMonitor Boolean: Whether or not to trigger one alert if any source breaches a threshold.
id String: The provider-assigned unique ID for this managed resource.
includeTags Boolean: Whether or not notifications from the monitor automatically inserts its triggering tags into the title.
locked Boolean: Whether or not changes to the monitor are restricted to the creator or admins.
message String: Message included with notifications for this monitor
monitorThresholdWindows List<GetMonitorMonitorThresholdWindow>: Mapping containing recovery_window and trigger_window values, e.g. last_15m. This is only used by anomaly monitors.
monitorThresholds List<GetMonitorMonitorThreshold>: Alert thresholds of the monitor.
name String: Name of the monitor
newGroupDelay Integer: Time (in seconds) to skip evaluations for new groups.
newHostDelay Integer: Time (in seconds) allowing a host to boot and applications to fully start before starting the evaluation of monitor results.
noDataTimeframe Integer: The number of minutes before the monitor notifies when data stops reporting.
notificationPresetName String: Toggles the display of additional content sent in the monitor notification. Valid values are: show_all, hide_query, hide_handles, and hide_all.
notifyAudit Boolean: Whether or not tagged users are notified on changes to the monitor.
notifyBies List<String>: Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each new cluster violating the alert conditions by setting notify_by to ['cluster']. Tags mentioned in notify_by must be a subset of the grouping tags in the query. For example, a query grouped by cluster and namespace cannot notify on region. Setting notify_by to [*] configures the monitor to notify as a simple-alert.
notifyNoData Boolean: Whether or not this monitor notifies when data stops reporting.
onMissingData String: Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are: show_no_data, show_and_notify_no_data, resolve, and default.
query String: Query of the monitor.
renotifyInterval Integer: The number of minutes after the last notification before the monitor re-notifies on the current status.
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. Valid values are alert, warn, no data.
requireFullWindow Boolean: Whether or not the monitor needs a full window of data before it is evaluated.
restrictedRoles List<String>
schedulingOptions List<GetMonitorSchedulingOption>: Configuration options for scheduling.
tags List<String>: List of tags associated with the monitor.
timeoutH Integer: Number of hours of the monitor not reporting data before it automatically resolves from a triggered state.
type String: Type of the monitor.
monitorTagsFilters List<String>: A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
nameFilter String: A monitor name to limit the search.
tagsFilters List<String>: A list of tags to limit the search. This filters on the monitor scope.

enableLogsSample boolean: Whether or not a list of log values which triggered the alert is included. This is only used by log monitors.
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: Message included with a re-notification for this monitor.
evaluationDelay number: Time (in seconds) for which evaluation is delayed. This is only used by metric monitors.
groupRetentionDuration string: The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
groupbySimpleMonitor boolean: Whether or not to trigger one alert if any source breaches a threshold.
id string: The provider-assigned unique ID for this managed resource.
includeTags boolean: Whether or not notifications from the monitor automatically inserts its triggering tags into the title.
locked boolean: Whether or not changes to the monitor are restricted to the creator or admins.
message string: Message included with notifications for this monitor
monitorThresholdWindows GetMonitorMonitorThresholdWindow[]: Mapping containing recovery_window and trigger_window values, e.g. last_15m. This is only used by anomaly monitors.
monitorThresholds GetMonitorMonitorThreshold[]: Alert thresholds of the monitor.
name string: Name of the monitor
newGroupDelay number: Time (in seconds) to skip evaluations for new groups.
newHostDelay number: Time (in seconds) allowing a host to boot and applications to fully start before starting the evaluation of monitor results.
noDataTimeframe number: The number of minutes before the monitor notifies when data stops reporting.
notificationPresetName string: Toggles the display of additional content sent in the monitor notification. Valid values are: show_all, hide_query, hide_handles, and hide_all.
notifyAudit boolean: Whether or not tagged users are notified on changes to the monitor.
notifyBies string[]: Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each new cluster violating the alert conditions by setting notify_by to ['cluster']. Tags mentioned in notify_by must be a subset of the grouping tags in the query. For example, a query grouped by cluster and namespace cannot notify on region. Setting notify_by to [*] configures the monitor to notify as a simple-alert.
notifyNoData boolean: Whether or not this monitor notifies when data stops reporting.
onMissingData string: Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are: show_no_data, show_and_notify_no_data, resolve, and default.
query string: Query of the monitor.
renotifyInterval number: The number of minutes after the last notification before the monitor re-notifies on the current status.
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. Valid values are alert, warn, no data.
requireFullWindow boolean: Whether or not the monitor needs a full window of data before it is evaluated.
restrictedRoles string[]
schedulingOptions GetMonitorSchedulingOption[]: Configuration options for scheduling.
tags string[]: List of tags associated with the monitor.
timeoutH number: Number of hours of the monitor not reporting data before it automatically resolves from a triggered state.
type string: Type of the monitor.
monitorTagsFilters string[]: A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
nameFilter string: A monitor name to limit the search.
tagsFilters string[]: A list of tags to limit the search. This filters on the monitor scope.

enable_logs_sample bool: Whether or not a list of log values which triggered the alert is included. This is only used by log monitors.
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: Message included with a re-notification for this monitor.
evaluation_delay int: Time (in seconds) for which evaluation is delayed. This is only used by metric monitors.
group_retention_duration str: The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
groupby_simple_monitor bool: Whether or not to trigger one alert if any source breaches a threshold.
id str: The provider-assigned unique ID for this managed resource.
include_tags bool: Whether or not notifications from the monitor automatically inserts its triggering tags into the title.
locked bool: Whether or not changes to the monitor are restricted to the creator or admins.
message str: Message included with notifications for this monitor
monitor_threshold_windows Sequence[GetMonitorMonitorThresholdWindow]: Mapping containing recovery_window and trigger_window values, e.g. last_15m. This is only used by anomaly monitors.
monitor_thresholds Sequence[GetMonitorMonitorThreshold]: Alert thresholds of the monitor.
name str: Name of the monitor
new_group_delay int: Time (in seconds) to skip evaluations for new groups.
new_host_delay int: Time (in seconds) allowing a host to boot and applications to fully start before starting the evaluation of monitor results.
no_data_timeframe int: The number of minutes before the monitor notifies when data stops reporting.
notification_preset_name str: Toggles the display of additional content sent in the monitor notification. Valid values are: show_all, hide_query, hide_handles, and hide_all.
notify_audit bool: Whether or not tagged users are notified on changes to the monitor.
notify_bies Sequence[str]: Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each new cluster violating the alert conditions by setting notify_by to ['cluster']. Tags mentioned in notify_by must be a subset of the grouping tags in the query. For example, a query grouped by cluster and namespace cannot notify on region. Setting notify_by to [*] configures the monitor to notify as a simple-alert.
notify_no_data bool: Whether or not this monitor notifies when data stops reporting.
on_missing_data str: Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are: show_no_data, show_and_notify_no_data, resolve, and default.
query str: Query of the monitor.
renotify_interval int: The number of minutes after the last notification before the monitor re-notifies on the current status.
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. Valid values are alert, warn, no data.
require_full_window bool: Whether or not the monitor needs a full window of data before it is evaluated.
restricted_roles Sequence[str]
scheduling_options Sequence[GetMonitorSchedulingOption]: Configuration options for scheduling.
tags Sequence[str]: List of tags associated with the monitor.
timeout_h int: Number of hours of the monitor not reporting data before it automatically resolves from a triggered state.
type str: Type of the monitor.
monitor_tags_filters Sequence[str]: A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
name_filter str: A monitor name to limit the search.
tags_filters Sequence[str]: A list of tags to limit the search. This filters on the monitor scope.

enableLogsSample Boolean: Whether or not a list of log values which triggered the alert is included. This is only used by log monitors.
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: Message included with a re-notification for this monitor.
evaluationDelay Number: Time (in seconds) for which evaluation is delayed. This is only used by metric monitors.
groupRetentionDuration String: The time span after which groups with missing data are dropped from the monitor state. The minimum value is one hour, and the maximum value is 72 hours. Example values are: 60m, 1h, and 2d. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.
groupbySimpleMonitor Boolean: Whether or not to trigger one alert if any source breaches a threshold.
id String: The provider-assigned unique ID for this managed resource.
includeTags Boolean: Whether or not notifications from the monitor automatically inserts its triggering tags into the title.
locked Boolean: Whether or not changes to the monitor are restricted to the creator or admins.
message String: Message included with notifications for this monitor
monitorThresholdWindows List<Property Map>: Mapping containing recovery_window and trigger_window values, e.g. last_15m. This is only used by anomaly monitors.
monitorThresholds List<Property Map>: Alert thresholds of the monitor.
name String: Name of the monitor
newGroupDelay Number: Time (in seconds) to skip evaluations for new groups.
newHostDelay Number: Time (in seconds) allowing a host to boot and applications to fully start before starting the evaluation of monitor results.
noDataTimeframe Number: The number of minutes before the monitor notifies when data stops reporting.
notificationPresetName String: Toggles the display of additional content sent in the monitor notification. Valid values are: show_all, hide_query, hide_handles, and hide_all.
notifyAudit Boolean: Whether or not tagged users are notified on changes to the monitor.
notifyBies List<String>: Controls what granularity a monitor alerts on. Only available for monitors with groupings. For instance, a monitor grouped by cluster, namespace, and pod can be configured to only notify on each new cluster violating the alert conditions by setting notify_by to ['cluster']. Tags mentioned in notify_by must be a subset of the grouping tags in the query. For example, a query grouped by cluster and namespace cannot notify on region. Setting notify_by to [*] configures the monitor to notify as a simple-alert.
notifyNoData Boolean: Whether or not this monitor notifies when data stops reporting.
onMissingData String: Controls how groups or monitors are treated if an evaluation does not return any data points. The default option results in different behavior depending on the monitor query type. For monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions. For monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status. This option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors. Valid values are: show_no_data, show_and_notify_no_data, resolve, and default.
query String: Query of the monitor.
renotifyInterval Number: The number of minutes after the last notification before the monitor re-notifies on the current status.
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. Valid values are alert, warn, no data.
requireFullWindow Boolean: Whether or not the monitor needs a full window of data before it is evaluated.
restrictedRoles List<String>
schedulingOptions List<Property Map>: Configuration options for scheduling.
tags List<String>: List of tags associated with the monitor.
timeoutH Number: Number of hours of the monitor not reporting data before it automatically resolves from a triggered state.
type String: Type of the monitor.
monitorTagsFilters List<String>: A list of monitor tags to limit the search. This filters on the tags set on the monitor itself.
nameFilter String: A monitor name to limit the search.
tagsFilters List<String>: A list of tags to limit the search. This filters on the monitor scope.

Supporting Types

GetMonitorMonitorThreshold

Critical string
CriticalRecovery string
Ok string
Unknown string
Warning string
WarningRecovery string

Critical string
CriticalRecovery string
Ok string
Unknown string
Warning string
WarningRecovery string

critical String
criticalRecovery String
ok String
unknown String
warning String
warningRecovery String

critical string
criticalRecovery string
ok string
unknown string
warning string
warningRecovery string

critical str
critical_recovery str
ok str
unknown str
warning str
warning_recovery str

critical String
criticalRecovery String
ok String
unknown String
warning String
warningRecovery String

GetMonitorMonitorThresholdWindow

RecoveryWindow string
TriggerWindow string

RecoveryWindow string
TriggerWindow string

recoveryWindow String
triggerWindow String

recoveryWindow string
triggerWindow string

recovery_window str
trigger_window str

recoveryWindow String
triggerWindow String

GetMonitorSchedulingOption

CustomSchedules List<GetMonitorSchedulingOptionCustomSchedule>: Configuration options for the custom schedules. If start is omitted, the monitor creation time will be used.
EvaluationWindows List<GetMonitorSchedulingOptionEvaluationWindow>: Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

CustomSchedules []GetMonitorSchedulingOptionCustomSchedule: Configuration options for the custom schedules. If start is omitted, the monitor creation time will be used.
EvaluationWindows []GetMonitorSchedulingOptionEvaluationWindow: Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

customSchedules List<GetMonitorSchedulingOptionCustomSchedule>: Configuration options for the custom schedules. If start is omitted, the monitor creation time will be used.
evaluationWindows List<GetMonitorSchedulingOptionEvaluationWindow>: Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

customSchedules GetMonitorSchedulingOptionCustomSchedule[]: Configuration options for the custom schedules. If start is omitted, the monitor creation time will be used.
evaluationWindows GetMonitorSchedulingOptionEvaluationWindow[]: Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

custom_schedules Sequence[GetMonitorSchedulingOptionCustomSchedule]: Configuration options for the custom schedules. If start is omitted, the monitor creation time will be used.
evaluation_windows Sequence[GetMonitorSchedulingOptionEvaluationWindow]: Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

customSchedules List<Property Map>: Configuration options for the custom schedules. If start is omitted, the monitor creation time will be used.
evaluationWindows List<Property Map>: Configuration options for the evaluation window. If hour_starts is set, no other fields may be set. Otherwise, day_starts and month_starts must be set together.

GetMonitorSchedulingOptionCustomSchedule

Recurrences List<GetMonitorSchedulingOptionCustomScheduleRecurrence>: A list of recurrence definitions. Length must be 1.

Recurrences []GetMonitorSchedulingOptionCustomScheduleRecurrence: A list of recurrence definitions. Length must be 1.

recurrences List<GetMonitorSchedulingOptionCustomScheduleRecurrence>: A list of recurrence definitions. Length must be 1.

recurrences GetMonitorSchedulingOptionCustomScheduleRecurrence[]: A list of recurrence definitions. Length must be 1.

recurrences Sequence[GetMonitorSchedulingOptionCustomScheduleRecurrence]: A list of recurrence definitions. Length must be 1.

recurrences List<Property Map>: A list of recurrence definitions. Length must be 1.

GetMonitorSchedulingOptionCustomScheduleRecurrence

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

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

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

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

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

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

GetMonitorSchedulingOptionEvaluationWindow

DayStarts string: The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.
HourStarts int: The minute of the hour at which a one hour cumulative evaluation window starts. Must be between 0 and 59.
MonthStarts int: The day of the month at which a one month cumulative evaluation window starts. Must be a value of 1.

DayStarts string: The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.
HourStarts int: The minute of the hour at which a one hour cumulative evaluation window starts. Must be between 0 and 59.
MonthStarts int: The day of the month at which a one month cumulative evaluation window starts. Must be a value of 1.

dayStarts String: The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.
hourStarts Integer: The minute of the hour at which a one hour cumulative evaluation window starts. Must be between 0 and 59.
monthStarts Integer: The day of the month at which a one month cumulative evaluation window starts. Must be a value of 1.

dayStarts string: The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.
hourStarts number: The minute of the hour at which a one hour cumulative evaluation window starts. Must be between 0 and 59.
monthStarts number: The day of the month at which a one month cumulative evaluation window starts. Must be a value of 1.

day_starts str: The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.
hour_starts int: The minute of the hour at which a one hour cumulative evaluation window starts. Must be between 0 and 59.
month_starts int: The day of the month at which a one month cumulative evaluation window starts. Must be a value of 1.

dayStarts String: The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in HH:mm format.
hourStarts Number: The minute of the hour at which a one hour cumulative evaluation window starts. Must be between 0 and 59.
monthStarts Number: The day of the month at which a one month cumulative evaluation window starts. Must be a value of 1.

Package Details

Repository: Datadog pulumi/pulumi-datadog
License: Apache-2.0
Notes: This Pulumi package is based on the datadog Terraform Provider.

Datadog v4.33.2 published on Tuesday, Sep 24, 2024 by Pulumi

pulumi/pulumi-datadog

datadog.getMonitor

On this page

On this page

Example Usage

Using getMonitor

getMonitor Result

Supporting Types

GetMonitorMonitorThreshold

GetMonitorMonitorThresholdWindow

GetMonitorSchedulingOption

GetMonitorSchedulingOptionCustomSchedule

GetMonitorSchedulingOptionCustomScheduleRecurrence

GetMonitorSchedulingOptionEvaluationWindow

Package Details

On this page

On this page