From f8b1b97b2ae54b07818d0e1a25fea2ee614f4809 Mon Sep 17 00:00:00 2001 From: cdklabs-automation <90142015+cdklabs-automation@users.noreply.github.com> Date: Sun, 19 Nov 2023 22:12:53 -0800 Subject: [PATCH] feat: cloudformation registry update (#446) * feat: cloudformation registry update * chore: self mutation Signed-off-by: github-actions --------- Signed-off-by: github-actions Co-authored-by: mergify Co-authored-by: github-actions --- .../datadog-monitors-monitor/README.md | 6 +++--- .../datadog-monitors-monitor/package.json | 4 ++-- .../datadog-monitors-monitor/src/index.ts | 4 ++-- registry/types/datadog-monitors-monitor.json | 10 +++++----- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/packages/@cdk-cloudformation/datadog-monitors-monitor/README.md b/packages/@cdk-cloudformation/datadog-monitors-monitor/README.md index 65b66a84e..ac0f087ae 100644 --- a/packages/@cdk-cloudformation/datadog-monitors-monitor/README.md +++ b/packages/@cdk-cloudformation/datadog-monitors-monitor/README.md @@ -1,13 +1,13 @@ # datadog-monitors-monitor -> AWS CDK [L1 construct] and data structures for the [AWS CloudFormation Registry] type `Datadog::Monitors::Monitor` v4.7.0. +> AWS CDK [L1 construct] and data structures for the [AWS CloudFormation Registry] type `Datadog::Monitors::Monitor` v4.7.1. [L1 construct]: https://docs.aws.amazon.com/cdk/latest/guide/constructs.html [AWS CloudFormation Registry]: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/registry.html ## Description -Datadog Monitor 4.7.0 +Datadog Monitor 4.7.1 ## Usage @@ -35,7 +35,7 @@ You can find more information about activating this type in the [AWS CloudFormat This library is auto-generated and published to all supported programming languages by the [cdklabs/cdk-cloudformation] project based on the API schema published for `Datadog::Monitors::Monitor`. -* Issues related to this generated library should be [reported here](https://github.com/cdklabs/cdk-cloudformation/issues/new?title=Issue+with+%40cdk-cloudformation%2Fdatadog-monitors-monitor+v4.7.0). +* Issues related to this generated library should be [reported here](https://github.com/cdklabs/cdk-cloudformation/issues/new?title=Issue+with+%40cdk-cloudformation%2Fdatadog-monitors-monitor+v4.7.1). * Issues related to `Datadog::Monitors::Monitor` should be reported to the [publisher](undefined). [cdklabs/cdk-cloudformation]: https://github.com/cdklabs/cdk-cloudformation diff --git a/packages/@cdk-cloudformation/datadog-monitors-monitor/package.json b/packages/@cdk-cloudformation/datadog-monitors-monitor/package.json index f3910a9a7..f5ae8a4e1 100644 --- a/packages/@cdk-cloudformation/datadog-monitors-monitor/package.json +++ b/packages/@cdk-cloudformation/datadog-monitors-monitor/package.json @@ -1,7 +1,7 @@ { "name": "@cdk-cloudformation/datadog-monitors-monitor", - "description": "Datadog Monitor 4.7.0", - "version": "4.7.0-alpha.7", + "description": "Datadog Monitor 4.7.1", + "version": "4.7.1-alpha.7", "author": { "name": "Amazon Web Services", "url": "https://aws.amazon.com", diff --git a/packages/@cdk-cloudformation/datadog-monitors-monitor/src/index.ts b/packages/@cdk-cloudformation/datadog-monitors-monitor/src/index.ts index 9b1ec63c6..09c5570f3 100644 --- a/packages/@cdk-cloudformation/datadog-monitors-monitor/src/index.ts +++ b/packages/@cdk-cloudformation/datadog-monitors-monitor/src/index.ts @@ -3,7 +3,7 @@ import * as cdk from 'aws-cdk-lib'; import * as constructs from 'constructs'; /** - * Datadog Monitor 4.7.0 + * Datadog Monitor 4.7.1 * * @schema CfnMonitorProps */ @@ -222,7 +222,7 @@ export interface MonitorOptions { readonly noDataTimeframe?: number; /** - * Whether or not to notify tagged users when changes are made to the monitor + * A Boolean indicating whether tagged users is notified on changes to this monitor. * * @schema MonitorOptions#NotifyAudit */ diff --git a/registry/types/datadog-monitors-monitor.json b/registry/types/datadog-monitors-monitor.json index 14ce3f1ff..438fa804e 100644 --- a/registry/types/datadog-monitors-monitor.json +++ b/registry/types/datadog-monitors-monitor.json @@ -2,15 +2,15 @@ "Arn": "arn:aws:cloudformation:us-east-1::type/resource/7171b96e5d207b947eb72ca9ce05247c246de623/Datadog-Monitors-Monitor", "Type": "RESOURCE", "TypeName": "Datadog::Monitors::Monitor", - "Description": "Datadog Monitor 4.7.0", - "Schema": "{\n \"typeName\": \"Datadog::Monitors::Monitor\",\n \"description\": \"Datadog Monitor 4.7.0\",\n \"typeConfiguration\": {\n \"properties\": {\n \"DatadogCredentials\": {\n \"$ref\": \"#/definitions/DatadogCredentials\"\n }\n },\n \"additionalProperties\": false\n },\n \"definitions\": {\n \"Creator\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Name\": {\n \"description\": \"Name of the creator of the monitor\",\n \"type\": \"string\"\n },\n \"Handle\": {\n \"description\": \"Handle of the creator of the monitor\",\n \"type\": \"string\"\n },\n \"Email\": {\n \"description\": \"Email of the creator of the monitor\",\n \"type\": \"string\"\n }\n }\n },\n \"MonitorNotificationPresetName\":{\n \"description\": \"Toggles the display of additional content sent in the monitor notification.\",\n \"type\": \"string\",\n \"enum\": [\n \"show_all\",\n \"hide_query\",\n \"hide_handles\",\n \"hide_all\"\n ]\n },\n \"MonitorOnMissingData\":{\n \"description\": \"Controls how groups or monitors are treated if an evaluation does not return any data points.\\nThe default option results in different behavior depending on the monitor query type.\\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.\",\n \"type\": \"string\",\n \"enum\": [\n \"default\",\n \"show_no_data\",\n \"show_and_notify_no_data\",\n \"resolve\"\n ]\n },\n \"MonitorSchedulingOptions\":{\n \"description\": \"Configuration options for scheduling.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"EvaluationWindow\":{\n \"$ref\":\"#/definitions/MonitorSchedulingOptionsEvaluationWindow\"\n }\n }\n },\n \"MonitorSchedulingOptionsEvaluationWindow\":{\n \"description\": \"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.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\":{\n \"DayStarts\":{\n \"description\": \"The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.\",\n \"type\": \"string\"\n },\n \"MonthStarts\":{\n \"description\": \"The day of the month at which a one month cumulative evaluation window starts.\",\n \"type\": \"integer\",\n \"minimum\": 1,\n \"maximum\": 1\n\n },\n \"HourStarts\":{\n \"description\": \"The minute of the hour at which a one hour cumulative evaluation window starts.\",\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 59\n }\n }\n },\n \"MonitorThresholds\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Critical\": {\n \"description\": \"Threshold value for triggering an alert\",\n \"type\": \"number\"\n },\n \"CriticalRecovery\": {\n \"description\": \"Threshold value for recovering from an alert state\",\n \"type\": \"number\"\n },\n \"OK\": {\n \"description\": \"Threshold value for recovering from an alert state\",\n \"type\": \"number\"\n },\n \"Warning\": {\n \"description\": \"Threshold value for triggering a warning\",\n \"type\": \"number\"\n },\n \"WarningRecovery\": {\n \"description\": \"Threshold value for recovering from a warning state\",\n \"type\": \"number\"\n }\n }\n },\n \"MonitorThresholdWindows\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"TriggerWindow\": {\n \"description\": \"How long a metric must be anomalous before triggering an alert\",\n \"type\": \"string\"\n },\n \"RecoveryWindow\": {\n \"description\": \"How long an anomalous metric must be normal before recovering from an alert state\",\n \"type\": \"string\"\n }\n }\n },\n \"MonitorOptions\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"EnableLogsSample\": {\n \"description\": \"Whether or not to include a sample of the logs\",\n \"type\": \"boolean\"\n },\n \"EnableSamples\":{\n \"description\":\"Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.\",\n \"type\":\"boolean\"\n },\n \"EscalationMessage\": {\n \"description\": \"Message to include with a re-notification when renotify_interval is set\",\n \"type\": \"string\"\n },\n \"EvaluationDelay\": {\n \"description\": \"Time in seconds to delay evaluation\",\n \"type\": \"integer\"\n },\n \"GroupRetentionDuration\":{\n \"description\": \"The time span after which groups with missing data are dropped from the monitor state.\\nThe minimum value is one hour, and the maximum value is 72 hours.\\nExample values are: \\\"60m\\\", \\\"1h\\\", and \\\"2d\\\".\\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.\",\n \"type\": \"string\"\n },\n \"IncludeTags\": {\n \"description\": \"Whether or not to include triggering tags into notification title\",\n \"type\": \"boolean\",\n \"insertionOrder\": false,\n \"default\": true\n },\n \"Locked\": {\n \"description\": \"Whether or not changes to this monitor should be restricted to the creator or admins\",\n \"type\": \"boolean\"\n },\n \"MinLocationFailed\": {\n \"description\": \"Number of locations allowed to fail before triggering alert\",\n \"type\": \"integer\"\n },\n \"NewHostDelay\": {\n \"description\": \"Time in seconds to allow a host to start reporting data before starting the evaluation of monitor results\",\n \"type\": \"integer\",\n \"default\": 300\n },\n \"NoDataTimeframe\": {\n \"description\": \"Number of minutes data stopped reporting before notifying\",\n \"type\": \"integer\"\n },\n \"NotifyAudit\": {\n \"description\": \"Whether or not to notify tagged users when changes are made to the monitor\",\n \"type\": \"boolean\"\n },\n \"NotifyBy\":{\n \"description\": \"Controls what granularity a monitor alerts on. Only available for monitors with groupings.\\nFor 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\\\"]`.\\nTags mentioned in `notify_by` must be a subset of the grouping tags in the query.\\nFor example, a query grouped by `cluster` and `namespace` cannot notify on `region`.\\nSetting `notify_by` to `[*]` configures the monitor to notify as a simple-alert.\",\n \"type\":\"array\",\n \"items\" : {\n \"type\": \"string\",\n \"description\": \"A grouping tag.\"\n },\n \"insertionOrder\": false\n },\n \"NotifyNoData\": {\n \"description\": \"Whether or not to notify when data stops reporting\",\n \"type\": \"boolean\"\n },\n \"NotificationPresetName\":{\n \"$ref\": \"#/definitions/MonitorNotificationPresetName\"\n },\n \"OnMissingData\":{\n \"$ref\": \"#/definitions/MonitorOnMissingData\"\n },\n \"RenotifyInterval\": {\n \"description\": \"Number of minutes after the last notification before the monitor re-notifies on the current status\",\n \"type\": \"integer\"\n },\n \"RequireFullWindow\": {\n \"description\": \"Whether or not the monitor requires a full window of data before it is evaluated\",\n \"type\": \"boolean\"\n },\n \"SchedulingOptions\":{\n \"$ref\": \"#/definitions/MonitorSchedulingOptions\"\n },\n \"SyntheticsCheckID\": {\n \"description\": \"ID of the corresponding synthetics check\",\n \"type\": \"integer\"\n },\n \"Thresholds\": {\n \"description\": \"The threshold definitions\",\n \"$ref\": \"#/definitions/MonitorThresholds\"\n },\n \"ThresholdWindows\": {\n \"description\": \"The threshold window definitions\",\n \"$ref\": \"#/definitions/MonitorThresholdWindows\"\n },\n \"TimeoutH\": {\n \"description\": \"Number of hours of the monitor not reporting data before it automatically resolves\",\n \"type\": \"integer\"\n },\n \"RenotifyOccurrences\": {\n \"description\": \"The number of times re-notification messages should be sent on the current status at the provided re-notification interval.\",\n \"type\": \"integer\"\n },\n \"RenotifyStatuses\": {\n \"description\":\"The types of monitor statuses for which re-notification messages are sent.\",\n \"type\": \"array\",\n \"insertionOrder\": false,\n \"items\": {\n \"type\": \"string\",\n \"enum\": [\n \"alert\",\n \"no data\",\n \"warn\"\n ]\n }\n },\n \"MinFailureDuration\": {\n \"description\": \"How long the test should be in failure before alerting (integer, number of seconds, max 7200).\",\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 7200\n },\n \"NewGroupDelay\": {\n \"description\": \"Time (in seconds) to skip evaluations for new groups. For example, this option can be used to skip evaluations for new hosts while they initialize. Must be a non negative integer.\",\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"Variables\": {\n \"description\": \"List of requests that can be used in the monitor query.\",\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventQueryDefinition\"}\n ]\n },\n \"insertionOrder\": true\n }\n }\n },\n \"MonitorFormulaAndFunctionEventQueryDefinition\": {\n \"description\": \"A formula and functions events query.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"DataSource\": {\n \"description\": \"Threshold value for triggering an alert.\",\n \"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventsDataSource\"\n },\n \"Search\": {\n \"description\": \"Search options.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Query\": {\n \"description\": \"The monitor query.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"Query\"\n ]\n },\n \"Indexes\": {\n \"description\": \"An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.\",\n \"type\": \"array\",\n \"insertionOrder\": false,\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"Compute\": {\n \"description\": \"Compute options.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Aggregation\": {\"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventAggregation\"},\n \"Interval\": {\n \"description\": \"A time interval in milliseconds.\",\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"Metric\": {\n \"description\": \"Measurable attribute to compute.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"Aggregation\"\n ]\n },\n \"GroupBy\": {\n \"description\": \"Group by options.\",\n \"type\": \"array\",\n \"items\": {\"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventQueryGroupBy\"},\n \"insertionOrder\": true\n },\n \"Name\": {\n \"description\": \"Name of the monitor\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"Compute\",\n \"DataSource\",\n \"Name\"\n ]\n },\n \"MonitorFormulaAndFunctionEventsDataSource\": {\n \"description\": \"Data source for event platform-based queries.\",\n \"type\": \"string\",\n \"enum\": [\n \"rum\",\n \"ci_pipelines\",\n \"ci_tests\",\n \"audit\",\n \"events\",\n \"logs\",\n \"spans\"\n ]\n },\n \"MonitorFormulaAndFunctionEventAggregation\": {\n \"description\": \"Data source for event platform-based queries.\",\n \"type\": \"string\",\n \"enum\": [\n \"count\",\n \"cardinality\",\n \"median\",\n \"pc75\",\n \"pc90\",\n \"pc95\",\n \"pc98\",\n \"pc99\",\n \"sum\",\n \"min\",\n \"max\",\n \"avg\"\n ]\n },\n \"MonitorFormulaAndFunctionEventQueryGroupBy\": {\n \"description\": \"Credentials for the Datadog API\",\n \"properties\": {\n \"Facet\": {\n \"description\": \"Event facet.\",\n \"type\": \"string\"\n },\n \"Limit\": {\n \"description\": \"Event facet.\",\n \"type\": \"integer\"\n },\n \"Sort\": {\n \"description\": \"Options for sorting group by results.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Aggregation\": {\"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventAggregation\"},\n \"Metric\": {\n \"description\": \"Options for sorting group by results.\",\n \"type\": \"string\"\n },\n \"Order\": {\n \"description\": \"Direction of sort.\",\n \"type\": \"string\",\n \"enum\": [\n \"asc\",\n \"desc\"\n ]\n }\n },\n \"required\": [\n \"Aggregation\"\n ]\n }\n },\n \"required\": [\n \"Facet\"\n ],\n \"type\": \"object\",\n \"additionalProperties\": false\n },\n \"DatadogCredentials\": {\n \"description\": \"Credentials for the Datadog API\",\n \"properties\": {\n \"ApiKey\": {\n \"description\": \"Datadog API key\",\n \"type\": \"string\"\n },\n \"ApplicationKey\": {\n \"description\": \"Datadog application key\",\n \"type\": \"string\"\n },\n \"ApiURL\": {\n \"description\": \"Datadog API URL (defaults to https://api.datadoghq.com) Use https://api.datadoghq.eu for EU accounts.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"ApiKey\",\n \"ApplicationKey\"\n ],\n \"type\": \"object\",\n \"additionalProperties\": false\n }\n },\n \"properties\": {\n \"Creator\": {\n \"$ref\": \"#/definitions/Creator\"\n },\n \"Id\": {\n \"description\": \"ID of the monitor\",\n \"type\": \"integer\"\n },\n \"Message\": {\n \"description\": \"A message to include with notifications for the monitor\",\n \"type\": \"string\"\n },\n \"Name\": {\n \"description\": \"Name of the monitor\",\n \"type\": \"string\"\n },\n \"Tags\": {\n \"description\": \"Tags associated with the monitor\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"insertionOrder\": false\n },\n \"Priority\": {\n \"description\": \"Integer from 1 (high) to 5 (low) indicating alert severity.\",\n \"type\": \"integer\"\n },\n \"Options\": {\n \"description\": \"The monitor options\",\n \"$ref\": \"#/definitions/MonitorOptions\"\n },\n \"Query\": {\n \"description\": \"The monitor query\",\n \"type\": \"string\"\n },\n \"Type\": {\n \"type\": \"string\",\n \"description\": \"The type of the monitor\",\n \"enum\": [\n \"audit alert\",\n \"composite\",\n \"event alert\",\n \"event-v2 alert\",\n \"log alert\",\n \"metric alert\",\n \"process alert\",\n \"query alert\",\n \"service check\",\n \"synthetics alert\",\n \"trace-analytics alert\",\n \"slo alert\",\n \"rum alert\",\n \"ci-pipelines alert\",\n \"error-tracking alert\",\n \"ci-tests alert\"\n ]\n },\n \"Multi\": {\n \"description\": \"Whether or not the monitor is multi alert\",\n \"type\": \"boolean\"\n },\n \"Created\": {\n \"description\": \"Date of creation of the monitor\",\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"Deleted\": {\n \"description\": \"Date of deletion of the monitor\",\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"Modified\": {\n \"description\": \"Date of modification of the monitor\",\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"RestrictedRoles\": {\n \"description\": \"A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the [Roles API](https://docs.datadoghq.com/api/latest/roles/#list-roles) and are located in the `data.id` field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. `restricted_roles` is the successor of `locked`. For more information about `locked` and `restricted_roles`, see the [monitor options docs](https://docs.datadoghq.com/monitors/guide/monitor_api_options/#permissions-options).\",\n \"type\": \"array\",\n \"insertionOrder\": false,\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"Query\",\n \"Type\"\n ],\n \"primaryIdentifier\": [\n \"/properties/Id\"\n ],\n \"readOnlyProperties\": [\n \"/properties/Modified\",\n \"/properties/Id\",\n \"/properties/Deleted\",\n \"/properties/State\",\n \"/properties/OverallState\",\n \"/properties/Creator\",\n \"/properties/Created\"\n ],\n \"additionalProperties\": false,\n \"handlers\": {\n \"create\": {\n \"permissions\": []\n },\n \"read\": {\n \"permissions\": []\n },\n \"update\": {\n \"permissions\": []\n },\n \"delete\": {\n \"permissions\": []\n }\n }\n}\n", + "Description": "Datadog Monitor 4.7.1", + "Schema": "{\n \"typeName\": \"Datadog::Monitors::Monitor\",\n \"description\": \"Datadog Monitor 4.7.1\",\n \"typeConfiguration\": {\n \"properties\": {\n \"DatadogCredentials\": {\n \"$ref\": \"#/definitions/DatadogCredentials\"\n }\n },\n \"additionalProperties\": false\n },\n \"definitions\": {\n \"Creator\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Name\": {\n \"description\": \"Name of the creator of the monitor\",\n \"type\": \"string\"\n },\n \"Handle\": {\n \"description\": \"Handle of the creator of the monitor\",\n \"type\": \"string\"\n },\n \"Email\": {\n \"description\": \"Email of the creator of the monitor\",\n \"type\": \"string\"\n }\n }\n },\n \"MonitorNotificationPresetName\":{\n \"description\": \"Toggles the display of additional content sent in the monitor notification.\",\n \"type\": \"string\",\n \"enum\": [\n \"show_all\",\n \"hide_query\",\n \"hide_handles\",\n \"hide_all\"\n ]\n },\n \"MonitorOnMissingData\":{\n \"description\": \"Controls how groups or monitors are treated if an evaluation does not return any data points.\\nThe default option results in different behavior depending on the monitor query type.\\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.\",\n \"type\": \"string\",\n \"enum\": [\n \"default\",\n \"show_no_data\",\n \"show_and_notify_no_data\",\n \"resolve\"\n ]\n },\n \"MonitorSchedulingOptions\":{\n \"description\": \"Configuration options for scheduling.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"EvaluationWindow\":{\n \"$ref\":\"#/definitions/MonitorSchedulingOptionsEvaluationWindow\"\n }\n }\n },\n \"MonitorSchedulingOptionsEvaluationWindow\":{\n \"description\": \"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.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\":{\n \"DayStarts\":{\n \"description\": \"The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.\",\n \"type\": \"string\"\n },\n \"MonthStarts\":{\n \"description\": \"The day of the month at which a one month cumulative evaluation window starts.\",\n \"type\": \"integer\",\n \"minimum\": 1,\n \"maximum\": 1\n\n },\n \"HourStarts\":{\n \"description\": \"The minute of the hour at which a one hour cumulative evaluation window starts.\",\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 59\n }\n }\n },\n \"MonitorThresholds\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Critical\": {\n \"description\": \"Threshold value for triggering an alert\",\n \"type\": \"number\"\n },\n \"CriticalRecovery\": {\n \"description\": \"Threshold value for recovering from an alert state\",\n \"type\": \"number\"\n },\n \"OK\": {\n \"description\": \"Threshold value for recovering from an alert state\",\n \"type\": \"number\"\n },\n \"Warning\": {\n \"description\": \"Threshold value for triggering a warning\",\n \"type\": \"number\"\n },\n \"WarningRecovery\": {\n \"description\": \"Threshold value for recovering from a warning state\",\n \"type\": \"number\"\n }\n }\n },\n \"MonitorThresholdWindows\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"TriggerWindow\": {\n \"description\": \"How long a metric must be anomalous before triggering an alert\",\n \"type\": \"string\"\n },\n \"RecoveryWindow\": {\n \"description\": \"How long an anomalous metric must be normal before recovering from an alert state\",\n \"type\": \"string\"\n }\n }\n },\n \"MonitorOptions\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"EnableLogsSample\": {\n \"description\": \"Whether or not to include a sample of the logs\",\n \"type\": \"boolean\"\n },\n \"EnableSamples\":{\n \"description\":\"Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.\",\n \"type\":\"boolean\"\n },\n \"EscalationMessage\": {\n \"description\": \"Message to include with a re-notification when renotify_interval is set\",\n \"type\": \"string\"\n },\n \"EvaluationDelay\": {\n \"description\": \"Time in seconds to delay evaluation\",\n \"type\": \"integer\"\n },\n \"GroupRetentionDuration\":{\n \"description\": \"The time span after which groups with missing data are dropped from the monitor state.\\nThe minimum value is one hour, and the maximum value is 72 hours.\\nExample values are: \\\"60m\\\", \\\"1h\\\", and \\\"2d\\\".\\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.\",\n \"type\": \"string\"\n },\n \"IncludeTags\": {\n \"description\": \"Whether or not to include triggering tags into notification title\",\n \"type\": \"boolean\",\n \"insertionOrder\": false,\n \"default\": true\n },\n \"Locked\": {\n \"description\": \"Whether or not changes to this monitor should be restricted to the creator or admins\",\n \"type\": \"boolean\"\n },\n \"MinLocationFailed\": {\n \"description\": \"Number of locations allowed to fail before triggering alert\",\n \"type\": \"integer\"\n },\n \"NewHostDelay\": {\n \"description\": \"Time in seconds to allow a host to start reporting data before starting the evaluation of monitor results\",\n \"type\": \"integer\",\n \"default\": 300\n },\n \"NoDataTimeframe\": {\n \"description\": \"Number of minutes data stopped reporting before notifying\",\n \"type\": \"integer\"\n },\n \"NotifyAudit\": {\n \"description\": \"A Boolean indicating whether tagged users is notified on changes to this monitor.\",\n \"type\": \"boolean\"\n },\n \"NotifyBy\":{\n \"description\": \"Controls what granularity a monitor alerts on. Only available for monitors with groupings.\\nFor 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\\\"]`.\\nTags mentioned in `notify_by` must be a subset of the grouping tags in the query.\\nFor example, a query grouped by `cluster` and `namespace` cannot notify on `region`.\\nSetting `notify_by` to `[*]` configures the monitor to notify as a simple-alert.\",\n \"type\":\"array\",\n \"items\" : {\n \"type\": \"string\",\n \"description\": \"A grouping tag.\"\n },\n \"insertionOrder\": false\n },\n \"NotifyNoData\": {\n \"description\": \"Whether or not to notify when data stops reporting\",\n \"type\": \"boolean\"\n },\n \"NotificationPresetName\":{\n \"$ref\": \"#/definitions/MonitorNotificationPresetName\"\n },\n \"OnMissingData\":{\n \"$ref\": \"#/definitions/MonitorOnMissingData\"\n },\n \"RenotifyInterval\": {\n \"description\": \"Number of minutes after the last notification before the monitor re-notifies on the current status\",\n \"type\": \"integer\"\n },\n \"RequireFullWindow\": {\n \"description\": \"Whether or not the monitor requires a full window of data before it is evaluated\",\n \"type\": \"boolean\"\n },\n \"SchedulingOptions\":{\n \"$ref\": \"#/definitions/MonitorSchedulingOptions\"\n },\n \"SyntheticsCheckID\": {\n \"description\": \"ID of the corresponding synthetics check\",\n \"type\": \"integer\"\n },\n \"Thresholds\": {\n \"description\": \"The threshold definitions\",\n \"$ref\": \"#/definitions/MonitorThresholds\"\n },\n \"ThresholdWindows\": {\n \"description\": \"The threshold window definitions\",\n \"$ref\": \"#/definitions/MonitorThresholdWindows\"\n },\n \"TimeoutH\": {\n \"description\": \"Number of hours of the monitor not reporting data before it automatically resolves\",\n \"type\": \"integer\"\n },\n \"RenotifyOccurrences\": {\n \"description\": \"The number of times re-notification messages should be sent on the current status at the provided re-notification interval.\",\n \"type\": \"integer\"\n },\n \"RenotifyStatuses\": {\n \"description\":\"The types of monitor statuses for which re-notification messages are sent.\",\n \"type\": \"array\",\n \"insertionOrder\": false,\n \"items\": {\n \"type\": \"string\",\n \"enum\": [\n \"alert\",\n \"no data\",\n \"warn\"\n ]\n }\n },\n \"MinFailureDuration\": {\n \"description\": \"How long the test should be in failure before alerting (integer, number of seconds, max 7200).\",\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 7200\n },\n \"NewGroupDelay\": {\n \"description\": \"Time (in seconds) to skip evaluations for new groups. For example, this option can be used to skip evaluations for new hosts while they initialize. Must be a non negative integer.\",\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"Variables\": {\n \"description\": \"List of requests that can be used in the monitor query.\",\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventQueryDefinition\"}\n ]\n },\n \"insertionOrder\": true\n }\n }\n },\n \"MonitorFormulaAndFunctionEventQueryDefinition\": {\n \"description\": \"A formula and functions events query.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"DataSource\": {\n \"description\": \"Threshold value for triggering an alert.\",\n \"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventsDataSource\"\n },\n \"Search\": {\n \"description\": \"Search options.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Query\": {\n \"description\": \"The monitor query.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"Query\"\n ]\n },\n \"Indexes\": {\n \"description\": \"An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.\",\n \"type\": \"array\",\n \"insertionOrder\": false,\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"Compute\": {\n \"description\": \"Compute options.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Aggregation\": {\"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventAggregation\"},\n \"Interval\": {\n \"description\": \"A time interval in milliseconds.\",\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"Metric\": {\n \"description\": \"Measurable attribute to compute.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"Aggregation\"\n ]\n },\n \"GroupBy\": {\n \"description\": \"Group by options.\",\n \"type\": \"array\",\n \"items\": {\"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventQueryGroupBy\"},\n \"insertionOrder\": true\n },\n \"Name\": {\n \"description\": \"Name of the monitor\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"Compute\",\n \"DataSource\",\n \"Name\"\n ]\n },\n \"MonitorFormulaAndFunctionEventsDataSource\": {\n \"description\": \"Data source for event platform-based queries.\",\n \"type\": \"string\",\n \"enum\": [\n \"rum\",\n \"ci_pipelines\",\n \"ci_tests\",\n \"audit\",\n \"events\",\n \"logs\",\n \"spans\"\n ]\n },\n \"MonitorFormulaAndFunctionEventAggregation\": {\n \"description\": \"Data source for event platform-based queries.\",\n \"type\": \"string\",\n \"enum\": [\n \"count\",\n \"cardinality\",\n \"median\",\n \"pc75\",\n \"pc90\",\n \"pc95\",\n \"pc98\",\n \"pc99\",\n \"sum\",\n \"min\",\n \"max\",\n \"avg\"\n ]\n },\n \"MonitorFormulaAndFunctionEventQueryGroupBy\": {\n \"description\": \"Credentials for the Datadog API\",\n \"properties\": {\n \"Facet\": {\n \"description\": \"Event facet.\",\n \"type\": \"string\"\n },\n \"Limit\": {\n \"description\": \"Event facet.\",\n \"type\": \"integer\"\n },\n \"Sort\": {\n \"description\": \"Options for sorting group by results.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Aggregation\": {\"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventAggregation\"},\n \"Metric\": {\n \"description\": \"Options for sorting group by results.\",\n \"type\": \"string\"\n },\n \"Order\": {\n \"description\": \"Direction of sort.\",\n \"type\": \"string\",\n \"enum\": [\n \"asc\",\n \"desc\"\n ]\n }\n },\n \"required\": [\n \"Aggregation\"\n ]\n }\n },\n \"required\": [\n \"Facet\"\n ],\n \"type\": \"object\",\n \"additionalProperties\": false\n },\n \"DatadogCredentials\": {\n \"description\": \"Credentials for the Datadog API\",\n \"properties\": {\n \"ApiKey\": {\n \"description\": \"Datadog API key\",\n \"type\": \"string\"\n },\n \"ApplicationKey\": {\n \"description\": \"Datadog application key\",\n \"type\": \"string\"\n },\n \"ApiURL\": {\n \"description\": \"Datadog API URL (defaults to https://api.datadoghq.com) Use https://api.datadoghq.eu for EU accounts.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"ApiKey\",\n \"ApplicationKey\"\n ],\n \"type\": \"object\",\n \"additionalProperties\": false\n }\n },\n \"properties\": {\n \"Creator\": {\n \"$ref\": \"#/definitions/Creator\"\n },\n \"Id\": {\n \"description\": \"ID of the monitor\",\n \"type\": \"integer\"\n },\n \"Message\": {\n \"description\": \"A message to include with notifications for the monitor\",\n \"type\": \"string\"\n },\n \"Name\": {\n \"description\": \"Name of the monitor\",\n \"type\": \"string\"\n },\n \"Tags\": {\n \"description\": \"Tags associated with the monitor\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\"\n },\n \"insertionOrder\": false\n },\n \"Priority\": {\n \"description\": \"Integer from 1 (high) to 5 (low) indicating alert severity.\",\n \"type\": \"integer\"\n },\n \"Options\": {\n \"description\": \"The monitor options\",\n \"$ref\": \"#/definitions/MonitorOptions\"\n },\n \"Query\": {\n \"description\": \"The monitor query\",\n \"type\": \"string\"\n },\n \"Type\": {\n \"type\": \"string\",\n \"description\": \"The type of the monitor\",\n \"enum\": [\n \"audit alert\",\n \"composite\",\n \"event alert\",\n \"event-v2 alert\",\n \"log alert\",\n \"metric alert\",\n \"process alert\",\n \"query alert\",\n \"service check\",\n \"synthetics alert\",\n \"trace-analytics alert\",\n \"slo alert\",\n \"rum alert\",\n \"ci-pipelines alert\",\n \"error-tracking alert\",\n \"ci-tests alert\"\n ]\n },\n \"Multi\": {\n \"description\": \"Whether or not the monitor is multi alert\",\n \"type\": \"boolean\"\n },\n \"Created\": {\n \"description\": \"Date of creation of the monitor\",\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"Deleted\": {\n \"description\": \"Date of deletion of the monitor\",\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"Modified\": {\n \"description\": \"Date of modification of the monitor\",\n \"type\": \"string\",\n \"format\": \"date-time\"\n },\n \"RestrictedRoles\": {\n \"description\": \"A list of unique role identifiers to define which roles are allowed to edit the monitor. The unique identifiers for all roles can be pulled from the [Roles API](https://docs.datadoghq.com/api/latest/roles/#list-roles) and are located in the `data.id` field. Editing a monitor includes any updates to the monitor configuration, monitor deletion, and muting of the monitor for any amount of time. `restricted_roles` is the successor of `locked`. For more information about `locked` and `restricted_roles`, see the [monitor options docs](https://docs.datadoghq.com/monitors/guide/monitor_api_options/#permissions-options).\",\n \"type\": \"array\",\n \"insertionOrder\": false,\n \"items\": {\n \"type\": \"string\"\n }\n }\n },\n \"required\": [\n \"Query\",\n \"Type\"\n ],\n \"primaryIdentifier\": [\n \"/properties/Id\"\n ],\n \"readOnlyProperties\": [\n \"/properties/Modified\",\n \"/properties/Id\",\n \"/properties/Deleted\",\n \"/properties/State\",\n \"/properties/OverallState\",\n \"/properties/Creator\",\n \"/properties/Created\"\n ],\n \"additionalProperties\": false,\n \"handlers\": {\n \"create\": {\n \"permissions\": []\n },\n \"read\": {\n \"permissions\": []\n },\n \"update\": {\n \"permissions\": []\n },\n \"delete\": {\n \"permissions\": []\n }\n }\n}\n", "ProvisioningType": "FULLY_MUTABLE", "DeprecatedStatus": "LIVE", "RequiredActivatedTypes": [], "Visibility": "PUBLIC", - "TimeCreated": "2023-10-02T18:00:29.322Z", - "ConfigurationSchema": "{\n \"properties\": {\n \"DatadogCredentials\": {\n \"$ref\": \"#/definitions/DatadogCredentials\"\n }\n },\n \"additionalProperties\": false,\n \"definitions\": {\n \"Creator\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Name\": {\n \"description\": \"Name of the creator of the monitor\",\n \"type\": \"string\"\n },\n \"Handle\": {\n \"description\": \"Handle of the creator of the monitor\",\n \"type\": \"string\"\n },\n \"Email\": {\n \"description\": \"Email of the creator of the monitor\",\n \"type\": \"string\"\n }\n }\n },\n \"MonitorNotificationPresetName\": {\n \"description\": \"Toggles the display of additional content sent in the monitor notification.\",\n \"type\": \"string\",\n \"enum\": [\n \"show_all\",\n \"hide_query\",\n \"hide_handles\",\n \"hide_all\"\n ]\n },\n \"MonitorOnMissingData\": {\n \"description\": \"Controls how groups or monitors are treated if an evaluation does not return any data points.\\nThe default option results in different behavior depending on the monitor query type.\\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.\",\n \"type\": \"string\",\n \"enum\": [\n \"default\",\n \"show_no_data\",\n \"show_and_notify_no_data\",\n \"resolve\"\n ]\n },\n \"MonitorSchedulingOptions\": {\n \"description\": \"Configuration options for scheduling.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"EvaluationWindow\": {\n \"$ref\": \"#/definitions/MonitorSchedulingOptionsEvaluationWindow\"\n }\n }\n },\n \"MonitorSchedulingOptionsEvaluationWindow\": {\n \"description\": \"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.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"DayStarts\": {\n \"description\": \"The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.\",\n \"type\": \"string\"\n },\n \"MonthStarts\": {\n \"description\": \"The day of the month at which a one month cumulative evaluation window starts.\",\n \"type\": \"integer\",\n \"minimum\": 1,\n \"maximum\": 1\n },\n \"HourStarts\": {\n \"description\": \"The minute of the hour at which a one hour cumulative evaluation window starts.\",\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 59\n }\n }\n },\n \"MonitorThresholds\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Critical\": {\n \"description\": \"Threshold value for triggering an alert\",\n \"type\": \"number\"\n },\n \"CriticalRecovery\": {\n \"description\": \"Threshold value for recovering from an alert state\",\n \"type\": \"number\"\n },\n \"OK\": {\n \"description\": \"Threshold value for recovering from an alert state\",\n \"type\": \"number\"\n },\n \"Warning\": {\n \"description\": \"Threshold value for triggering a warning\",\n \"type\": \"number\"\n },\n \"WarningRecovery\": {\n \"description\": \"Threshold value for recovering from a warning state\",\n \"type\": \"number\"\n }\n }\n },\n \"MonitorThresholdWindows\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"TriggerWindow\": {\n \"description\": \"How long a metric must be anomalous before triggering an alert\",\n \"type\": \"string\"\n },\n \"RecoveryWindow\": {\n \"description\": \"How long an anomalous metric must be normal before recovering from an alert state\",\n \"type\": \"string\"\n }\n }\n },\n \"MonitorOptions\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"EnableLogsSample\": {\n \"description\": \"Whether or not to include a sample of the logs\",\n \"type\": \"boolean\"\n },\n \"EnableSamples\": {\n \"description\": \"Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.\",\n \"type\": \"boolean\"\n },\n \"EscalationMessage\": {\n \"description\": \"Message to include with a re-notification when renotify_interval is set\",\n \"type\": \"string\"\n },\n \"EvaluationDelay\": {\n \"description\": \"Time in seconds to delay evaluation\",\n \"type\": \"integer\"\n },\n \"GroupRetentionDuration\": {\n \"description\": \"The time span after which groups with missing data are dropped from the monitor state.\\nThe minimum value is one hour, and the maximum value is 72 hours.\\nExample values are: \\\"60m\\\", \\\"1h\\\", and \\\"2d\\\".\\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.\",\n \"type\": \"string\"\n },\n \"IncludeTags\": {\n \"description\": \"Whether or not to include triggering tags into notification title\",\n \"type\": \"boolean\",\n \"insertionOrder\": false,\n \"default\": true\n },\n \"Locked\": {\n \"description\": \"Whether or not changes to this monitor should be restricted to the creator or admins\",\n \"type\": \"boolean\"\n },\n \"MinLocationFailed\": {\n \"description\": \"Number of locations allowed to fail before triggering alert\",\n \"type\": \"integer\"\n },\n \"NewHostDelay\": {\n \"description\": \"Time in seconds to allow a host to start reporting data before starting the evaluation of monitor results\",\n \"type\": \"integer\",\n \"default\": 300\n },\n \"NoDataTimeframe\": {\n \"description\": \"Number of minutes data stopped reporting before notifying\",\n \"type\": \"integer\"\n },\n \"NotifyAudit\": {\n \"description\": \"Whether or not to notify tagged users when changes are made to the monitor\",\n \"type\": \"boolean\"\n },\n \"NotifyBy\": {\n \"description\": \"Controls what granularity a monitor alerts on. Only available for monitors with groupings.\\nFor 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\\\"]`.\\nTags mentioned in `notify_by` must be a subset of the grouping tags in the query.\\nFor example, a query grouped by `cluster` and `namespace` cannot notify on `region`.\\nSetting `notify_by` to `[*]` configures the monitor to notify as a simple-alert.\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\",\n \"description\": \"A grouping tag.\"\n },\n \"insertionOrder\": false\n },\n \"NotifyNoData\": {\n \"description\": \"Whether or not to notify when data stops reporting\",\n \"type\": \"boolean\"\n },\n \"NotificationPresetName\": {\n \"$ref\": \"#/definitions/MonitorNotificationPresetName\"\n },\n \"OnMissingData\": {\n \"$ref\": \"#/definitions/MonitorOnMissingData\"\n },\n \"RenotifyInterval\": {\n \"description\": \"Number of minutes after the last notification before the monitor re-notifies on the current status\",\n \"type\": \"integer\"\n },\n \"RequireFullWindow\": {\n \"description\": \"Whether or not the monitor requires a full window of data before it is evaluated\",\n \"type\": \"boolean\"\n },\n \"SchedulingOptions\": {\n \"$ref\": \"#/definitions/MonitorSchedulingOptions\"\n },\n \"SyntheticsCheckID\": {\n \"description\": \"ID of the corresponding synthetics check\",\n \"type\": \"integer\"\n },\n \"Thresholds\": {\n \"description\": \"The threshold definitions\",\n \"$ref\": \"#/definitions/MonitorThresholds\"\n },\n \"ThresholdWindows\": {\n \"description\": \"The threshold window definitions\",\n \"$ref\": \"#/definitions/MonitorThresholdWindows\"\n },\n \"TimeoutH\": {\n \"description\": \"Number of hours of the monitor not reporting data before it automatically resolves\",\n \"type\": \"integer\"\n },\n \"RenotifyOccurrences\": {\n \"description\": \"The number of times re-notification messages should be sent on the current status at the provided re-notification interval.\",\n \"type\": \"integer\"\n },\n \"RenotifyStatuses\": {\n \"description\": \"The types of monitor statuses for which re-notification messages are sent.\",\n \"type\": \"array\",\n \"insertionOrder\": false,\n \"items\": {\n \"type\": \"string\",\n \"enum\": [\n \"alert\",\n \"no data\",\n \"warn\"\n ]\n }\n },\n \"MinFailureDuration\": {\n \"description\": \"How long the test should be in failure before alerting (integer, number of seconds, max 7200).\",\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 7200\n },\n \"NewGroupDelay\": {\n \"description\": \"Time (in seconds) to skip evaluations for new groups. For example, this option can be used to skip evaluations for new hosts while they initialize. Must be a non negative integer.\",\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"Variables\": {\n \"description\": \"List of requests that can be used in the monitor query.\",\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventQueryDefinition\"\n }\n ]\n },\n \"insertionOrder\": true\n }\n }\n },\n \"MonitorFormulaAndFunctionEventQueryDefinition\": {\n \"description\": \"A formula and functions events query.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"DataSource\": {\n \"description\": \"Threshold value for triggering an alert.\",\n \"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventsDataSource\"\n },\n \"Search\": {\n \"description\": \"Search options.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Query\": {\n \"description\": \"The monitor query.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"Query\"\n ]\n },\n \"Indexes\": {\n \"description\": \"An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.\",\n \"type\": \"array\",\n \"insertionOrder\": false,\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"Compute\": {\n \"description\": \"Compute options.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Aggregation\": {\n \"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventAggregation\"\n },\n \"Interval\": {\n \"description\": \"A time interval in milliseconds.\",\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"Metric\": {\n \"description\": \"Measurable attribute to compute.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"Aggregation\"\n ]\n },\n \"GroupBy\": {\n \"description\": \"Group by options.\",\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventQueryGroupBy\"\n },\n \"insertionOrder\": true\n },\n \"Name\": {\n \"description\": \"Name of the monitor\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"Compute\",\n \"DataSource\",\n \"Name\"\n ]\n },\n \"MonitorFormulaAndFunctionEventsDataSource\": {\n \"description\": \"Data source for event platform-based queries.\",\n \"type\": \"string\",\n \"enum\": [\n \"rum\",\n \"ci_pipelines\",\n \"ci_tests\",\n \"audit\",\n \"events\",\n \"logs\",\n \"spans\"\n ]\n },\n \"MonitorFormulaAndFunctionEventAggregation\": {\n \"description\": \"Data source for event platform-based queries.\",\n \"type\": \"string\",\n \"enum\": [\n \"count\",\n \"cardinality\",\n \"median\",\n \"pc75\",\n \"pc90\",\n \"pc95\",\n \"pc98\",\n \"pc99\",\n \"sum\",\n \"min\",\n \"max\",\n \"avg\"\n ]\n },\n \"MonitorFormulaAndFunctionEventQueryGroupBy\": {\n \"description\": \"Credentials for the Datadog API\",\n \"properties\": {\n \"Facet\": {\n \"description\": \"Event facet.\",\n \"type\": \"string\"\n },\n \"Limit\": {\n \"description\": \"Event facet.\",\n \"type\": \"integer\"\n },\n \"Sort\": {\n \"description\": \"Options for sorting group by results.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Aggregation\": {\n \"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventAggregation\"\n },\n \"Metric\": {\n \"description\": \"Options for sorting group by results.\",\n \"type\": \"string\"\n },\n \"Order\": {\n \"description\": \"Direction of sort.\",\n \"type\": \"string\",\n \"enum\": [\n \"asc\",\n \"desc\"\n ]\n }\n },\n \"required\": [\n \"Aggregation\"\n ]\n }\n },\n \"required\": [\n \"Facet\"\n ],\n \"type\": \"object\",\n \"additionalProperties\": false\n },\n \"DatadogCredentials\": {\n \"description\": \"Credentials for the Datadog API\",\n \"properties\": {\n \"ApiKey\": {\n \"description\": \"Datadog API key\",\n \"type\": \"string\"\n },\n \"ApplicationKey\": {\n \"description\": \"Datadog application key\",\n \"type\": \"string\"\n },\n \"ApiURL\": {\n \"description\": \"Datadog API URL (defaults to https://api.datadoghq.com) Use https://api.datadoghq.eu for EU accounts.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"ApiKey\",\n \"ApplicationKey\"\n ],\n \"type\": \"object\",\n \"additionalProperties\": false\n }\n },\n \"typeName\": \"Datadog::Monitors::Monitor\"\n}", + "TimeCreated": "2023-11-14T17:16:07.194Z", + "ConfigurationSchema": "{\n \"properties\": {\n \"DatadogCredentials\": {\n \"$ref\": \"#/definitions/DatadogCredentials\"\n }\n },\n \"additionalProperties\": false,\n \"definitions\": {\n \"Creator\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Name\": {\n \"description\": \"Name of the creator of the monitor\",\n \"type\": \"string\"\n },\n \"Handle\": {\n \"description\": \"Handle of the creator of the monitor\",\n \"type\": \"string\"\n },\n \"Email\": {\n \"description\": \"Email of the creator of the monitor\",\n \"type\": \"string\"\n }\n }\n },\n \"MonitorNotificationPresetName\": {\n \"description\": \"Toggles the display of additional content sent in the monitor notification.\",\n \"type\": \"string\",\n \"enum\": [\n \"show_all\",\n \"hide_query\",\n \"hide_handles\",\n \"hide_all\"\n ]\n },\n \"MonitorOnMissingData\": {\n \"description\": \"Controls how groups or monitors are treated if an evaluation does not return any data points.\\nThe default option results in different behavior depending on the monitor query type.\\nFor monitors using Count queries, an empty monitor evaluation is treated as 0 and is compared to the threshold conditions.\\nFor monitors using any query type other than Count, for example Gauge, Measure, or Rate, the monitor shows the last known status.\\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.\",\n \"type\": \"string\",\n \"enum\": [\n \"default\",\n \"show_no_data\",\n \"show_and_notify_no_data\",\n \"resolve\"\n ]\n },\n \"MonitorSchedulingOptions\": {\n \"description\": \"Configuration options for scheduling.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"EvaluationWindow\": {\n \"$ref\": \"#/definitions/MonitorSchedulingOptionsEvaluationWindow\"\n }\n }\n },\n \"MonitorSchedulingOptionsEvaluationWindow\": {\n \"description\": \"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.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"DayStarts\": {\n \"description\": \"The time of the day at which a one day cumulative evaluation window starts. Must be defined in UTC time in `HH:mm` format.\",\n \"type\": \"string\"\n },\n \"MonthStarts\": {\n \"description\": \"The day of the month at which a one month cumulative evaluation window starts.\",\n \"type\": \"integer\",\n \"minimum\": 1,\n \"maximum\": 1\n },\n \"HourStarts\": {\n \"description\": \"The minute of the hour at which a one hour cumulative evaluation window starts.\",\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 59\n }\n }\n },\n \"MonitorThresholds\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Critical\": {\n \"description\": \"Threshold value for triggering an alert\",\n \"type\": \"number\"\n },\n \"CriticalRecovery\": {\n \"description\": \"Threshold value for recovering from an alert state\",\n \"type\": \"number\"\n },\n \"OK\": {\n \"description\": \"Threshold value for recovering from an alert state\",\n \"type\": \"number\"\n },\n \"Warning\": {\n \"description\": \"Threshold value for triggering a warning\",\n \"type\": \"number\"\n },\n \"WarningRecovery\": {\n \"description\": \"Threshold value for recovering from a warning state\",\n \"type\": \"number\"\n }\n }\n },\n \"MonitorThresholdWindows\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"TriggerWindow\": {\n \"description\": \"How long a metric must be anomalous before triggering an alert\",\n \"type\": \"string\"\n },\n \"RecoveryWindow\": {\n \"description\": \"How long an anomalous metric must be normal before recovering from an alert state\",\n \"type\": \"string\"\n }\n }\n },\n \"MonitorOptions\": {\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"EnableLogsSample\": {\n \"description\": \"Whether or not to include a sample of the logs\",\n \"type\": \"boolean\"\n },\n \"EnableSamples\": {\n \"description\": \"Whether or not to send a list of samples when the monitor triggers. This is only used by CI Test and Pipeline monitors.\",\n \"type\": \"boolean\"\n },\n \"EscalationMessage\": {\n \"description\": \"Message to include with a re-notification when renotify_interval is set\",\n \"type\": \"string\"\n },\n \"EvaluationDelay\": {\n \"description\": \"Time in seconds to delay evaluation\",\n \"type\": \"integer\"\n },\n \"GroupRetentionDuration\": {\n \"description\": \"The time span after which groups with missing data are dropped from the monitor state.\\nThe minimum value is one hour, and the maximum value is 72 hours.\\nExample values are: \\\"60m\\\", \\\"1h\\\", and \\\"2d\\\".\\nThis option is only available for APM Trace Analytics, Audit Trail, CI, Error Tracking, Event, Logs, and RUM monitors.\",\n \"type\": \"string\"\n },\n \"IncludeTags\": {\n \"description\": \"Whether or not to include triggering tags into notification title\",\n \"type\": \"boolean\",\n \"insertionOrder\": false,\n \"default\": true\n },\n \"Locked\": {\n \"description\": \"Whether or not changes to this monitor should be restricted to the creator or admins\",\n \"type\": \"boolean\"\n },\n \"MinLocationFailed\": {\n \"description\": \"Number of locations allowed to fail before triggering alert\",\n \"type\": \"integer\"\n },\n \"NewHostDelay\": {\n \"description\": \"Time in seconds to allow a host to start reporting data before starting the evaluation of monitor results\",\n \"type\": \"integer\",\n \"default\": 300\n },\n \"NoDataTimeframe\": {\n \"description\": \"Number of minutes data stopped reporting before notifying\",\n \"type\": \"integer\"\n },\n \"NotifyAudit\": {\n \"description\": \"A Boolean indicating whether tagged users is notified on changes to this monitor.\",\n \"type\": \"boolean\"\n },\n \"NotifyBy\": {\n \"description\": \"Controls what granularity a monitor alerts on. Only available for monitors with groupings.\\nFor 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\\\"]`.\\nTags mentioned in `notify_by` must be a subset of the grouping tags in the query.\\nFor example, a query grouped by `cluster` and `namespace` cannot notify on `region`.\\nSetting `notify_by` to `[*]` configures the monitor to notify as a simple-alert.\",\n \"type\": \"array\",\n \"items\": {\n \"type\": \"string\",\n \"description\": \"A grouping tag.\"\n },\n \"insertionOrder\": false\n },\n \"NotifyNoData\": {\n \"description\": \"Whether or not to notify when data stops reporting\",\n \"type\": \"boolean\"\n },\n \"NotificationPresetName\": {\n \"$ref\": \"#/definitions/MonitorNotificationPresetName\"\n },\n \"OnMissingData\": {\n \"$ref\": \"#/definitions/MonitorOnMissingData\"\n },\n \"RenotifyInterval\": {\n \"description\": \"Number of minutes after the last notification before the monitor re-notifies on the current status\",\n \"type\": \"integer\"\n },\n \"RequireFullWindow\": {\n \"description\": \"Whether or not the monitor requires a full window of data before it is evaluated\",\n \"type\": \"boolean\"\n },\n \"SchedulingOptions\": {\n \"$ref\": \"#/definitions/MonitorSchedulingOptions\"\n },\n \"SyntheticsCheckID\": {\n \"description\": \"ID of the corresponding synthetics check\",\n \"type\": \"integer\"\n },\n \"Thresholds\": {\n \"description\": \"The threshold definitions\",\n \"$ref\": \"#/definitions/MonitorThresholds\"\n },\n \"ThresholdWindows\": {\n \"description\": \"The threshold window definitions\",\n \"$ref\": \"#/definitions/MonitorThresholdWindows\"\n },\n \"TimeoutH\": {\n \"description\": \"Number of hours of the monitor not reporting data before it automatically resolves\",\n \"type\": \"integer\"\n },\n \"RenotifyOccurrences\": {\n \"description\": \"The number of times re-notification messages should be sent on the current status at the provided re-notification interval.\",\n \"type\": \"integer\"\n },\n \"RenotifyStatuses\": {\n \"description\": \"The types of monitor statuses for which re-notification messages are sent.\",\n \"type\": \"array\",\n \"insertionOrder\": false,\n \"items\": {\n \"type\": \"string\",\n \"enum\": [\n \"alert\",\n \"no data\",\n \"warn\"\n ]\n }\n },\n \"MinFailureDuration\": {\n \"description\": \"How long the test should be in failure before alerting (integer, number of seconds, max 7200).\",\n \"type\": \"integer\",\n \"minimum\": 0,\n \"maximum\": 7200\n },\n \"NewGroupDelay\": {\n \"description\": \"Time (in seconds) to skip evaluations for new groups. For example, this option can be used to skip evaluations for new hosts while they initialize. Must be a non negative integer.\",\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"Variables\": {\n \"description\": \"List of requests that can be used in the monitor query.\",\n \"type\": \"array\",\n \"items\": {\n \"oneOf\": [\n {\n \"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventQueryDefinition\"\n }\n ]\n },\n \"insertionOrder\": true\n }\n }\n },\n \"MonitorFormulaAndFunctionEventQueryDefinition\": {\n \"description\": \"A formula and functions events query.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"DataSource\": {\n \"description\": \"Threshold value for triggering an alert.\",\n \"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventsDataSource\"\n },\n \"Search\": {\n \"description\": \"Search options.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Query\": {\n \"description\": \"The monitor query.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"Query\"\n ]\n },\n \"Indexes\": {\n \"description\": \"An array of index names to query in the stream. Omit or use `[]` to query all indexes at once.\",\n \"type\": \"array\",\n \"insertionOrder\": false,\n \"items\": {\n \"type\": \"string\"\n }\n },\n \"Compute\": {\n \"description\": \"Compute options.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Aggregation\": {\n \"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventAggregation\"\n },\n \"Interval\": {\n \"description\": \"A time interval in milliseconds.\",\n \"type\": \"integer\",\n \"minimum\": 0\n },\n \"Metric\": {\n \"description\": \"Measurable attribute to compute.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"Aggregation\"\n ]\n },\n \"GroupBy\": {\n \"description\": \"Group by options.\",\n \"type\": \"array\",\n \"items\": {\n \"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventQueryGroupBy\"\n },\n \"insertionOrder\": true\n },\n \"Name\": {\n \"description\": \"Name of the monitor\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"Compute\",\n \"DataSource\",\n \"Name\"\n ]\n },\n \"MonitorFormulaAndFunctionEventsDataSource\": {\n \"description\": \"Data source for event platform-based queries.\",\n \"type\": \"string\",\n \"enum\": [\n \"rum\",\n \"ci_pipelines\",\n \"ci_tests\",\n \"audit\",\n \"events\",\n \"logs\",\n \"spans\"\n ]\n },\n \"MonitorFormulaAndFunctionEventAggregation\": {\n \"description\": \"Data source for event platform-based queries.\",\n \"type\": \"string\",\n \"enum\": [\n \"count\",\n \"cardinality\",\n \"median\",\n \"pc75\",\n \"pc90\",\n \"pc95\",\n \"pc98\",\n \"pc99\",\n \"sum\",\n \"min\",\n \"max\",\n \"avg\"\n ]\n },\n \"MonitorFormulaAndFunctionEventQueryGroupBy\": {\n \"description\": \"Credentials for the Datadog API\",\n \"properties\": {\n \"Facet\": {\n \"description\": \"Event facet.\",\n \"type\": \"string\"\n },\n \"Limit\": {\n \"description\": \"Event facet.\",\n \"type\": \"integer\"\n },\n \"Sort\": {\n \"description\": \"Options for sorting group by results.\",\n \"type\": \"object\",\n \"additionalProperties\": false,\n \"properties\": {\n \"Aggregation\": {\n \"$ref\": \"#/definitions/MonitorFormulaAndFunctionEventAggregation\"\n },\n \"Metric\": {\n \"description\": \"Options for sorting group by results.\",\n \"type\": \"string\"\n },\n \"Order\": {\n \"description\": \"Direction of sort.\",\n \"type\": \"string\",\n \"enum\": [\n \"asc\",\n \"desc\"\n ]\n }\n },\n \"required\": [\n \"Aggregation\"\n ]\n }\n },\n \"required\": [\n \"Facet\"\n ],\n \"type\": \"object\",\n \"additionalProperties\": false\n },\n \"DatadogCredentials\": {\n \"description\": \"Credentials for the Datadog API\",\n \"properties\": {\n \"ApiKey\": {\n \"description\": \"Datadog API key\",\n \"type\": \"string\"\n },\n \"ApplicationKey\": {\n \"description\": \"Datadog application key\",\n \"type\": \"string\"\n },\n \"ApiURL\": {\n \"description\": \"Datadog API URL (defaults to https://api.datadoghq.com) Use https://api.datadoghq.eu for EU accounts.\",\n \"type\": \"string\"\n }\n },\n \"required\": [\n \"ApiKey\",\n \"ApplicationKey\"\n ],\n \"type\": \"object\",\n \"additionalProperties\": false\n }\n },\n \"typeName\": \"Datadog::Monitors::Monitor\"\n}", "PublisherId": "7171b96e5d207b947eb72ca9ce05247c246de623", - "LatestPublicVersion": "4.7.0", + "LatestPublicVersion": "4.7.1", "IsActivated": false } \ No newline at end of file