{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/mongodb/main/json-schema/mongodb-paginated-alert-config-view-schema.json", "title": "PaginatedAlertConfigView", "x-generated": "2026-10-03", "x-method": "derived", "x-generator": "derive-json-schema.py", "x-source": "openapi/mongodb-alert-configurations-api-openapi.yml#/components/schemas/PaginatedAlertConfigView", "properties": { "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" }, "results": { "description": "List of returned documents that MongoDB Cloud provides when completing this request.", "items": { "$ref": "#/$defs/GroupAlertsConfig" }, "readOnly": true, "type": "array" }, "totalCount": { "description": "Total number of documents available. MongoDB Cloud omits this value if `includeCount` is set to `false`. The total number is an estimate and may not be exact.", "format": "int32", "minimum": 0, "readOnly": true, "type": "integer" } }, "required": [ "results" ], "type": "object", "$defs": { "AlertMatcher": { "description": "Rules to apply when comparing an target instance against this alert configuration.", "properties": { "fieldName": { "description": "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value against **matcher[n].value**. The `REGEX` operator only supports inclusive matches. Use the `NOT_CONTAINS` operator to exclude values.", "enum": [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ], "type": "string" }, "value": { "description": "Value to match or exceed using the specified `matchers.operator`.", "type": "string" } }, "required": [ "fieldName", "operator", "value" ], "title": "Matchers", "type": "object" }, "AlertsNotificationRootForGroup": { "description": "One target that MongoDB Cloud sends notifications when an alert triggers.", "oneOf": [ { "$ref": "#/$defs/DatadogNotification" }, { "$ref": "#/$defs/EmailNotification" }, { "$ref": "#/$defs/GroupNotification" }, { "$ref": "#/$defs/HipChatNotification" }, { "$ref": "#/$defs/MicrosoftTeamsNotification" }, { "$ref": "#/$defs/OpsGenieNotification" }, { "$ref": "#/$defs/OrgNotification" }, { "$ref": "#/$defs/PagerDutyNotification" }, { "$ref": "#/$defs/SlackNotification" }, { "$ref": "#/$defs/SMSNotification" }, { "$ref": "#/$defs/TeamNotification" }, { "$ref": "#/$defs/UserNotification" }, { "$ref": "#/$defs/VictorOpsNotification" }, { "$ref": "#/$defs/WebhookNotification" } ], "type": "object" }, "AlertsThresholdInteger": { "description": "A Limit that triggers an alert when exceeded. The resource returns this parameter when `eventTypeName` has not been set to `OUTSIDE_METRIC_THRESHOLD`.", "properties": { "operator": { "$ref": "#/$defs/Operator" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "int32", "type": "integer" }, "units": { "description": "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", "enum": [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "tokens", "million tokens", "pixels", "billion pixels", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion" ], "type": "string" } }, "title": "Threshold", "type": "object" }, "AppServiceAlertConfigViewForNdsGroup": { "description": "App Services metric alert configuration allows to select which app service conditions and events trigger alerts and how users are notified.", "properties": { "created": { "description": "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" }, "enabled": { "default": false, "description": "Flag that indicates whether someone enabled this alert configuration for the specified project.", "type": "boolean" }, "eventTypeName": { "$ref": "#/$defs/AppServiceEventTypeViewAlertableNoThreshold" }, "groupId": { "description": "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "id": { "description": "Unique 24-hexadecimal digit string that identifies this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" }, "matchers": { "description": "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the `eventTypeName` specifies an event for a host, replica set, or sharded cluster.", "items": { "$ref": "#/$defs/AppServiceMetricMatcher" }, "type": "array" }, "notifications": { "description": "List that contains the targets that MongoDB Cloud sends notifications.", "items": { "$ref": "#/$defs/AlertsNotificationRootForGroup" }, "maxItems": 25, "minItems": 1, "type": "array" }, "severityOverride": { "$ref": "#/$defs/EventSeverity" }, "updated": { "description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "eventTypeName", "notifications" ], "title": "App Services Alert Configuration", "type": "object" }, "AppServiceEventTypeViewAlertableNoThreshold": { "description": "Event type that triggers an alert.", "enum": [ "URL_CONFIRMATION", "SUCCESSFUL_DEPLOY", "DEPLOYMENT_FAILURE", "REQUEST_RATE_LIMIT", "LOG_FORWARDER_FAILURE", "SYNC_FAILURE", "TRIGGER_FAILURE", "TRIGGER_AUTO_RESUMED", "DEPLOYMENT_MODEL_CHANGE_SUCCESS", "DEPLOYMENT_MODEL_CHANGE_FAILURE" ], "title": "App Services Event Types", "type": "string" }, "AppServiceEventTypeViewAlertableWithThreshold": { "description": "Event type that triggers an alert.", "enum": [ "OUTSIDE_REALM_METRIC_THRESHOLD" ], "title": "App Services Event Types", "type": "string" }, "AppServiceMetricAlertConfigViewForNdsGroup": { "description": "App Services metric alert configuration allows to select which app service metrics trigger alerts and how users are notified.", "properties": { "created": { "description": "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" }, "enabled": { "default": false, "description": "Flag that indicates whether someone enabled this alert configuration for the specified project.", "type": "boolean" }, "eventTypeName": { "$ref": "#/$defs/AppServiceEventTypeViewAlertableWithThreshold" }, "groupId": { "description": "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "id": { "description": "Unique 24-hexadecimal digit string that identifies this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" }, "matchers": { "description": "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the `eventTypeName` specifies an event for a host, replica set, or sharded cluster.", "items": { "$ref": "#/$defs/AppServiceMetricMatcher" }, "type": "array" }, "metricThreshold": { "$ref": "#/$defs/AppServiceMetricThreshold" }, "notifications": { "description": "List that contains the targets that MongoDB Cloud sends notifications.", "items": { "$ref": "#/$defs/AlertsNotificationRootForGroup" }, "maxItems": 25, "minItems": 1, "type": "array" }, "severityOverride": { "$ref": "#/$defs/EventSeverity" }, "updated": { "description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "eventTypeName", "notifications" ], "title": "App Services Metric Alert Configuration", "type": "object" }, "AppServiceMetricMatcher": { "description": "Rules to apply when comparing an app service metric against this alert configuration.", "properties": { "fieldName": { "$ref": "#/$defs/AppServiceMetricMatcherField" }, "operator": { "description": "Comparison operator to apply when checking the current metric value against **matcher[n].value**. The `REGEX` operator only supports inclusive matches. Use the `NOT_CONTAINS` operator to exclude values.", "enum": [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ], "type": "string" }, "value": { "description": "Value to match or exceed using the specified `matchers.operator`.", "type": "string" } }, "required": [ "fieldName", "operator", "value" ], "title": "Matchers", "type": "object" }, "AppServiceMetricMatcherField": { "description": "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", "enum": [ "APPLICATION_ID" ], "title": "App Services Metric Matcher Fields", "type": "string" }, "AppServiceMetricThreshold": { "description": "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in the app services.", "oneOf": [ { "$ref": "#/$defs/RawMetricThresholdView" }, { "$ref": "#/$defs/DataMetricThresholdView" }, { "$ref": "#/$defs/TimeMetricThresholdView" } ], "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "description": "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", "enum": [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "tokens", "million tokens", "pixels", "billion pixels", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion" ], "type": "string" } }, "required": [ "metricName" ], "title": "App Services Metric Threshold", "type": "object" }, "AssertMsgRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "AssertRegularRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "AssertUserRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "AssertWarningRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "AvgCommandExecutionTimeTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "AvgReadExecutionTimeTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "AvgWriteExecutionTimeTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "BillingEventTypeViewAlertableWithThreshold": { "description": "Event type that triggers an alert.", "enum": [ "PENDING_INVOICE_OVER_THRESHOLD", "DAILY_BILL_OVER_THRESHOLD", "DAILY_BILLING_CHANGE_OVER_THRESHOLD", "WEEKLY_BILLING_CHANGE_OVER_THRESHOLD", "MONTHLY_BILLING_CHANGE_OVER_THRESHOLD" ], "title": "Billing Event Type", "type": "string" }, "BillingThresholdAlertConfigViewForNdsGroup": { "description": "Billing threshold alert configuration allows to select thresholds for bills and invoices which trigger alerts and how users are notified.", "properties": { "created": { "description": "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" }, "enabled": { "default": false, "description": "Flag that indicates whether someone enabled this alert configuration for the specified project.", "type": "boolean" }, "eventTypeName": { "$ref": "#/$defs/BillingEventTypeViewAlertableWithThreshold" }, "groupId": { "description": "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "id": { "description": "Unique 24-hexadecimal digit string that identifies this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" }, "matchers": { "description": "Matching conditions for target resources.", "items": { "$ref": "#/$defs/AlertMatcher" }, "type": "array" }, "notifications": { "description": "List that contains the targets that MongoDB Cloud sends notifications.", "items": { "$ref": "#/$defs/AlertsNotificationRootForGroup" }, "maxItems": 25, "minItems": 1, "type": "array" }, "severityOverride": { "$ref": "#/$defs/EventSeverity" }, "threshold": { "$ref": "#/$defs/GreaterThanRawThreshold" }, "updated": { "description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "eventTypeName", "notifications" ], "title": "Billing Threshold Alert Configuration", "type": "object" }, "CacheBytesReadIntoDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "CacheBytesWrittenFromDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "CacheUsageDirtyDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "CacheUsageUsedDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "ClusterAlertConfigViewForNdsGroup": { "description": "Cluster alert configuration allows to select which conditions of mongod cluster which trigger alerts and how users are notified.", "properties": { "created": { "description": "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" }, "enabled": { "default": false, "description": "Flag that indicates whether someone enabled this alert configuration for the specified project.", "type": "boolean" }, "eventTypeName": { "$ref": "#/$defs/ClusterEventTypeViewForNdsGroupAlertable" }, "groupId": { "description": "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "id": { "description": "Unique 24-hexadecimal digit string that identifies this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" }, "matchers": { "description": "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the `eventTypeName` specifies an event for a host, replica set, or sharded cluster.", "items": { "$ref": "#/$defs/ClusterMatcher" }, "type": "array" }, "notifications": { "description": "List that contains the targets that MongoDB Cloud sends notifications.", "items": { "$ref": "#/$defs/AlertsNotificationRootForGroup" }, "maxItems": 25, "minItems": 1, "type": "array" }, "severityOverride": { "$ref": "#/$defs/EventSeverity" }, "updated": { "description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "eventTypeName", "notifications" ], "title": "Cluster Alert Configuration", "type": "object" }, "ClusterEventTypeViewForNdsGroupAlertable": { "description": "Event type that triggers an alert.", "enum": [ "CLUSTER_MONGOS_IS_MISSING" ], "title": "Cluster Event Types", "type": "string" }, "ClusterMatcher": { "description": "Rules to apply when comparing an cluster against this alert configuration.", "properties": { "fieldName": { "$ref": "#/$defs/ClusterMatcherField" }, "operator": { "description": "Comparison operator to apply when checking the current metric value against **matcher[n].value**. The `REGEX` operator only supports inclusive matches. Use the `NOT_CONTAINS` operator to exclude values.", "enum": [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ], "type": "string" }, "value": { "description": "Value to match or exceed using the specified `matchers.operator`.", "type": "string" } }, "required": [ "fieldName", "operator", "value" ], "title": "Matchers", "type": "object" }, "ClusterMatcherField": { "description": "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", "enum": [ "CLUSTER_NAME" ], "title": "Cluster Matcher Fields", "type": "string" }, "ComputedMemoryDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "ConnectionsMaxRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "ConnectionsPercentRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "ConnectionsRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold": { "description": "Event type that triggers an alert.", "enum": [ "CPS_SNAPSHOT_BEHIND", "CPS_PREV_SNAPSHOT_OLD", "CPS_OPLOG_BEHIND" ], "title": "Cps Backup Event Type", "type": "string" }, "CpsBackupThresholdAlertConfigViewForNdsGroup": { "description": "Cps Backup threshold alert configuration allows to select thresholds for conditions of CPS backup or oplogs anomalies which trigger alerts and how users are notified.", "properties": { "created": { "description": "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" }, "enabled": { "default": false, "description": "Flag that indicates whether someone enabled this alert configuration for the specified project.", "type": "boolean" }, "eventTypeName": { "$ref": "#/$defs/CpsBackupEventTypeViewForNdsGroupAlertableWithThreshold" }, "groupId": { "description": "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "id": { "description": "Unique 24-hexadecimal digit string that identifies this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" }, "matchers": { "description": "Matching conditions for target resources.", "items": { "$ref": "#/$defs/AlertMatcher" }, "type": "array" }, "notifications": { "description": "List that contains the targets that MongoDB Cloud sends notifications.", "items": { "$ref": "#/$defs/AlertsNotificationRootForGroup" }, "maxItems": 25, "minItems": 1, "type": "array" }, "severityOverride": { "$ref": "#/$defs/EventSeverity" }, "threshold": { "$ref": "#/$defs/GreaterThanTimeThreshold" }, "updated": { "description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "eventTypeName", "notifications" ], "title": "Cps Backup Threshold Alert Configuration", "type": "object" }, "CursorsTotalClientCursorsSizeRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "CursorsTotalOpenRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "CursorsTotalTimedOutRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DLQRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DataMetricUnits": { "description": "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", "enum": [ "BITS", "KILOBITS", "MEGABITS", "GIGABITS", "BYTES", "KILOBYTES", "MEGABYTES", "GIGABYTES", "TERABYTES", "PETABYTES" ], "title": "Data Metric Units", "type": "string" }, "DatadogNotification": { "description": "Datadog notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties": { "datadogApiKey": { "description": "Datadog API Key that MongoDB Cloud needs to send alert notifications to Datadog. You can find this API key in the Datadog dashboard. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", "type": "string" }, "datadogRegion": { "default": "US", "description": "Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when `\"notifications.[n].typeName\" : \"DATADOG\"`.", "enum": [ "US", "EU", "US3", "US5", "AP1", "US1_FED" ], "type": "string" }, "delayMin": { "description": "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.", "format": "int32", "type": "integer" }, "integrationId": { "description": "The id of the associated integration, the credentials of which to use for requests.", "type": "string" }, "intervalMin": { "description": "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", "format": "int32", "minimum": 5, "type": "integer" }, "notifierId": { "description": "The `notifierId` is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", "pattern": "^([a-f0-9]{24})$", "type": "string" }, "typeName": { "description": "Human-readable label that displays the alert notification type.", "enum": [ "DATADOG" ], "type": "string" } }, "required": [ "typeName" ], "title": "Datadog Notification", "type": "object" }, "DbDataSizeTotalDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DbDataSizeTotalWoSystemDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DbIndexSizeTotalDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DbStorageTotalDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DefaultAlertConfigViewForNdsGroup": { "description": "Other alerts which don't have extra details beside of basic one.", "properties": { "created": { "description": "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" }, "enabled": { "default": false, "description": "Flag that indicates whether someone enabled this alert configuration for the specified project.", "type": "boolean" }, "eventTypeName": { "description": "Incident that triggered this alert.", "oneOf": [ { "enum": [ "CREDIT_CARD_ABOUT_TO_EXPIRE" ], "title": "Billing Event Types", "type": "string" }, { "enum": [ "CPS_SNAPSHOT_STARTED", "CPS_SNAPSHOT_SUCCESSFUL", "CPS_SNAPSHOT_FAILED", "CPS_CONCURRENT_SNAPSHOT_FAILED_WILL_RETRY", "CPS_SNAPSHOT_FALLBACK_SUCCESSFUL", "CPS_SNAPSHOT_FALLBACK_FAILED", "CPS_COPY_SNAPSHOT_STARTED", "CPS_COPY_SNAPSHOT_FAILED", "CPS_COPY_SNAPSHOT_FAILED_WILL_RETRY", "CPS_COPY_SNAPSHOT_SUCCESSFUL", "CPS_RESTORE_SUCCESSFUL", "CPS_EXPORT_SUCCESSFUL", "CPS_RESTORE_FAILED", "CPS_EXPORT_FAILED", "CPS_COLLECTION_RESTORE_SUCCESSFUL", "CPS_COLLECTION_RESTORE_FAILED", "CPS_COLLECTION_RESTORE_PARTIAL_SUCCESS", "CPS_COLLECTION_RESTORE_CANCELED", "CPS_AUTO_EXPORT_FAILED", "CPS_SNAPSHOT_DOWNLOAD_REQUEST_FAILED", "CPS_OPLOG_CAUGHT_UP" ], "title": "Cps Backup Event Types", "type": "string" }, { "enum": [ "CPS_DATA_PROTECTION_ENABLE_REQUESTED", "CPS_DATA_PROTECTION_ENABLED", "CPS_DATA_PROTECTION_UPDATE_REQUESTED", "CPS_DATA_PROTECTION_UPDATED", "CPS_DATA_PROTECTION_DISABLE_REQUESTED", "CPS_DATA_PROTECTION_DISABLED", "CPS_DATA_PROTECTION_APPROVED_FOR_DISABLEMENT" ], "title": "Data Protection Event Types", "type": "string" }, { "enum": [ "FTS_INDEX_DELETION_FAILED", "FTS_INDEX_BUILD_COMPLETE", "FTS_INDEX_BUILD_FAILED", "FTS_INDEX_CLEANED_UP", "FTS_INDEX_STALE", "FTS_INDEXES_RESTORE_FAILED", "FTS_INDEXES_SYNONYM_MAPPING_INVALID" ], "title": "FTS Index Audit Types", "type": "string" }, { "enum": [ "USERS_WITHOUT_MULTI_FACTOR_AUTH", "ENCRYPTION_AT_REST_KMS_NETWORK_ACCESS_DENIED", "ENCRYPTION_AT_REST_CONFIG_NO_LONGER_VALID", "GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRING", "GROUP_SERVICE_ACCOUNT_SECRETS_EXPIRED", "ACTIVE_LEGACY_TLS_CONNECTIONS" ], "title": "Group Event Types", "type": "string" }, { "enum": [ "MONGOTUNE_ALERT" ], "title": "Mongotune Event Types", "type": "string" }, { "enum": [ "CLUSTER_INSTANCE_STOP_START", "CLUSTER_INSTANCE_RESYNC_REQUESTED", "CLUSTER_INSTANCE_UPDATE_REQUESTED", "SAMPLE_DATASET_LOAD_REQUESTED", "TENANT_UPGRADE_TO_SERVERLESS_SUCCESSFUL", "TENANT_UPGRADE_TO_SERVERLESS_FAILED", "NETWORK_PERMISSION_ENTRY_ADDED", "NETWORK_PERMISSION_ENTRY_REMOVED", "NETWORK_PERMISSION_ENTRY_UPDATED", "CLUSTER_BLOCK_WRITE", "CLUSTER_UNBLOCK_WRITE" ], "title": "Atlas Audit Types", "type": "string" }, { "enum": [ "MAINTENANCE_IN_ADVANCED", "MAINTENANCE_AUTO_DEFERRED", "MAINTENANCE_STARTED", "MAINTENANCE_COMPLETED", "MAINTENANCE_NO_LONGER_NEEDED" ], "title": "Maintenance Window Audit Types", "type": "string" }, { "enum": [ "ONLINE_ARCHIVE_INSUFFICIENT_INDEXES_CHECK", "ONLINE_ARCHIVE_MAX_CONSECUTIVE_OFFLOAD_WINDOWS_CHECK" ], "title": "Online Archive Event Types", "type": "string" }, { "enum": [ "JOINED_GROUP", "REMOVED_FROM_GROUP", "USER_ROLES_CHANGED_AUDIT" ], "title": "User Event Types", "type": "string" }, { "enum": [ "TAGS_MODIFIED", "CLUSTER_TAGS_MODIFIED", "GROUP_TAGS_MODIFIED" ], "title": "Resource Event Types", "type": "string" }, { "enum": [ "STREAM_PROCESSOR_STATE_IS_FAILED", "OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD" ], "title": "Stream Processor Event Types", "type": "string" }, { "enum": [ "COMPUTE_AUTO_SCALE_INITIATED_BASE", "COMPUTE_AUTO_SCALE_INITIATED_ANALYTICS", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_BASE", "COMPUTE_AUTO_SCALE_SCALE_DOWN_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_DOWNSCALE_SKIPPED_FALLBACK_BASE", "COMPUTE_AUTO_SCALE_DOWNSCALE_SKIPPED_FALLBACK_ANALYTICS", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_ANALYTICS", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "COMPUTE_AUTO_SCALE_OPLOG_FAIL_ANALYTICS", "DISK_AUTO_SCALE_INITIATED", "DISK_AUTO_SCALE_MAX_DISK_SIZE_FAIL", "DISK_AUTO_SCALE_OPLOG_FAIL", "PREDICTIVE_COMPUTE_AUTO_SCALE_INITIATED_BASE", "PREDICTIVE_COMPUTE_AUTO_SCALE_MAX_INSTANCE_SIZE_FAIL_BASE", "PREDICTIVE_COMPUTE_AUTO_SCALE_OPLOG_FAIL_BASE", "CLUSTER_AUTO_SHARDING_INITIATED" ], "title": "Auto Scaling Audit Types", "type": "string" }, { "enum": [ "RESOURCE_POLICY_VIOLATED" ], "title": "Atlas Resource Policy Audit Types", "type": "string" }, { "enum": [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_MONGOT_STOP_REPLICATION", "HOST_MONGOT_APPROACHING_STOP_REPLICATION", "HOST_MONGOT_PAUSE_INITIAL_SYNC", "HOST_SEARCH_NODE_INDEX_FAILED", "HOST_EXTERNAL_LOG_SINK_EXPORT_DOWN", "HOST_NOT_ENOUGH_DISK_SPACE", "SSH_KEY_NDS_HOST_ACCESS_REQUESTED", "SSH_KEY_NDS_HOST_ACCESS_REFRESHED", "PUSH_BASED_LOG_EXPORT_STOPPED", "PUSH_BASED_LOG_EXPORT_DROPPED_LOG", "HOST_VERSION_BEHIND", "VERSION_BEHIND", "HOST_EXPOSED", "HOST_SSL_CERTIFICATE_STALE", "HOST_SECURITY_CHECKUP_NOT_MET", "ALERT_HOST_SSH_SESSION_STARTED", "PROFILER_CONFIGURED_TOO_WIDELY" ], "title": "Host Event Types", "type": "string" } ], "type": "object" }, "groupId": { "description": "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "id": { "description": "Unique 24-hexadecimal digit string that identifies this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" }, "matchers": { "description": "Matching conditions for target resources.", "items": { "$ref": "#/$defs/AlertMatcher" }, "type": "array" }, "notifications": { "description": "List that contains the targets that MongoDB Cloud sends notifications.", "items": { "$ref": "#/$defs/AlertsNotificationRootForGroup" }, "maxItems": 25, "minItems": 1, "type": "array" }, "severityOverride": { "$ref": "#/$defs/EventSeverity" }, "updated": { "description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "eventTypeName", "notifications" ], "title": "Any Other Alert Configurations", "type": "object" }, "DeprecatedStreamProcessorMetricThreshold": { "deprecated": true, "description": "Threshold value that triggers an alert. Deprecated: use `metricThreshold` instead.", "oneOf": [ { "$ref": "#/$defs/KafkaRawMetricThresholdView" }, { "$ref": "#/$defs/TimeMetricThresholdView" }, { "$ref": "#/$defs/DLQRawMetricThresholdView" }, { "$ref": "#/$defs/RawMetricThresholdView" } ], "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "description": "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", "enum": [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "tokens", "million tokens", "pixels", "billion pixels", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion" ], "type": "string" } }, "required": [ "metricName" ], "type": "object" }, "DiskPartitionQueueDepthDataRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DiskPartitionQueueDepthIndexRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DiskPartitionQueueDepthJournalRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DiskPartitionReadIopsDataRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DiskPartitionReadIopsIndexRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DiskPartitionReadIopsJournalRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DiskPartitionReadLatencyDataTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DiskPartitionReadLatencyIndexTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DiskPartitionReadLatencyJournalTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DiskPartitionSpaceUsedDataRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DiskPartitionSpaceUsedIndexRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DiskPartitionSpaceUsedJournalRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DiskPartitionWriteIopsDataRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DiskPartitionWriteIopsIndexRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DiskPartitionWriteIopsJournalRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DiskPartitionWriteLatencyDataTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DiskPartitionWriteLatencyIndexTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DiskPartitionWriteLatencyJournalTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DocumentDeletedRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DocumentInsertedRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DocumentReturnedRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "DocumentUpdatedRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "EmailNotification": { "description": "Email notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties": { "delayMin": { "description": "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.", "format": "int32", "type": "integer" }, "emailAddress": { "description": "Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"EMAIL\"`. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:\n\n- specific MongoDB Cloud users (`\"notifications.[n].typeName\" : \"USER\"`)\n- MongoDB Cloud users with specific project roles (`\"notifications.[n].typeName\" : \"GROUP\"`)\n- MongoDB Cloud users with specific organization roles (`\"notifications.[n].typeName\" : \"ORG\"`)\n- MongoDB Cloud teams (`\"notifications.[n].typeName\" : \"TEAM\"`)\n\nTo send emails to one MongoDB Cloud user or grouping of users, set the `notifications.[n].emailEnabled` parameter.", "format": "email", "type": "string" }, "intervalMin": { "description": "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", "format": "int32", "minimum": 5, "type": "integer" }, "notifierId": { "description": "The `notifierId` is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", "pattern": "^([a-f0-9]{24})$", "type": "string" }, "typeName": { "description": "Human-readable label that displays the alert notification type.", "enum": [ "EMAIL" ], "type": "string" } }, "required": [ "typeName" ], "title": "Email Notification", "type": "object" }, "EncryptionKeyAlertConfigViewForNdsGroup": { "description": "Encryption key alert configuration allows to select thresholds which trigger alerts and how users are notified.", "properties": { "created": { "description": "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" }, "enabled": { "default": false, "description": "Flag that indicates whether someone enabled this alert configuration for the specified project.", "type": "boolean" }, "eventTypeName": { "$ref": "#/$defs/EncryptionKeyEventTypeViewAlertable" }, "groupId": { "description": "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "id": { "description": "Unique 24-hexadecimal digit string that identifies this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" }, "matchers": { "description": "Matching conditions for target resources.", "items": { "$ref": "#/$defs/AlertMatcher" }, "type": "array" }, "notifications": { "description": "List that contains the targets that MongoDB Cloud sends notifications.", "items": { "$ref": "#/$defs/AlertsNotificationRootForGroup" }, "maxItems": 25, "minItems": 1, "type": "array" }, "severityOverride": { "$ref": "#/$defs/EventSeverity" }, "threshold": { "$ref": "#/$defs/GreaterThanDaysThresholdView" }, "updated": { "description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "eventTypeName", "notifications" ], "title": "Encryption Key Alert Configuration", "type": "object" }, "EncryptionKeyEventTypeViewAlertable": { "description": "Event type that triggers an alert.", "enum": [ "AWS_ENCRYPTION_KEY_NEEDS_ROTATION", "AZURE_ENCRYPTION_KEY_NEEDS_ROTATION", "GCP_ENCRYPTION_KEY_NEEDS_ROTATION", "AWS_ENCRYPTION_KEY_INVALID", "AZURE_ENCRYPTION_KEY_INVALID", "GCP_ENCRYPTION_KEY_INVALID" ], "title": "Encryption Event Types", "type": "string" }, "EventSeverity": { "description": "Severity of the event.", "enum": [ "INFO", "WARNING", "ERROR", "CRITICAL" ], "type": "string" }, "ExtraInfoPageFaultsRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FlexAVGCommandExecutionTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FlexAVGWriteExecutionTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FlexClusterMetricThreshold": { "description": "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", "oneOf": [ { "$ref": "#/$defs/RawMetricThresholdView" }, { "$ref": "#/$defs/FlexConnectionPercentRawMetricThresholdView" }, { "$ref": "#/$defs/DataMetricThresholdView" }, { "$ref": "#/$defs/FlexNetworkBytesInDataMetricThresholdView" }, { "$ref": "#/$defs/FlexNetworkBytesOutDataMetricThresholdView" }, { "$ref": "#/$defs/FlexNetworkNumRequestsRawMetricThresholdView" }, { "$ref": "#/$defs/FlexOpCounterCMDRawMetricThresholdView" }, { "$ref": "#/$defs/FlexOpCounterDeleteRawMetricThresholdView" }, { "$ref": "#/$defs/FlexOpCounterInsertRawMetricThresholdView" }, { "$ref": "#/$defs/FlexOpCounterQueryRawMetricThresholdView" }, { "$ref": "#/$defs/FlexOpCounterUpdateRawMetricThresholdView" }, { "$ref": "#/$defs/FlexOpCounterGetMoreRawMetricThresholdView" }, { "$ref": "#/$defs/TimeMetricThresholdView" }, { "$ref": "#/$defs/FlexAVGWriteExecutionTimeMetricThresholdView" }, { "$ref": "#/$defs/FlexAVGCommandExecutionTimeMetricThresholdView" } ], "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "description": "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", "enum": [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "tokens", "million tokens", "pixels", "billion pixels", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion" ], "type": "string" } }, "required": [ "metricName" ], "title": "Flex Cluster Metric Threshold", "type": "object" }, "FlexConnectionPercentRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FlexMetricAlertConfigViewForNdsGroup": { "description": "Flex metric alert configuration allows to select which Flex database metrics trigger alerts and how users are notified.", "properties": { "created": { "description": "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" }, "enabled": { "default": false, "description": "Flag that indicates whether someone enabled this alert configuration for the specified project.", "type": "boolean" }, "eventTypeName": { "$ref": "#/$defs/FlexMetricEventTypeViewAlertable" }, "groupId": { "description": "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "id": { "description": "Unique 24-hexadecimal digit string that identifies this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" }, "matchers": { "description": "Matching conditions for target resources.", "items": { "$ref": "#/$defs/AlertMatcher" }, "type": "array" }, "metricThreshold": { "$ref": "#/$defs/FlexClusterMetricThreshold" }, "notifications": { "description": "List that contains the targets that MongoDB Cloud sends notifications.", "items": { "$ref": "#/$defs/AlertsNotificationRootForGroup" }, "maxItems": 25, "minItems": 1, "type": "array" }, "severityOverride": { "$ref": "#/$defs/EventSeverity" }, "updated": { "description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "eventTypeName", "notifications" ], "title": "Flex Alert Configuration", "type": "object" }, "FlexMetricEventTypeViewAlertable": { "description": "Event type that triggers an alert.", "enum": [ "OUTSIDE_FLEX_METRIC_THRESHOLD" ], "title": "Flex Metric Event Types", "type": "string" }, "FlexNetworkBytesInDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FlexNetworkBytesOutDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FlexNetworkNumRequestsRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FlexOpCounterCMDRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FlexOpCounterDeleteRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FlexOpCounterGetMoreRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FlexOpCounterInsertRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FlexOpCounterQueryRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FlexOpCounterUpdateRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FtsDiskUtilizationDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FtsJvmCurrentMemoryDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FtsJvmMaxMemoryDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FtsMemoryMappedDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FtsMemoryResidentDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FtsMemoryVirtualDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FtsProcessCpuKernelRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "FtsProcessCpuUserRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "GlobalAccessesNotInMemoryRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "GlobalLockCurrentQueueReadersRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "GlobalLockCurrentQueueTotalRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "GlobalLockCurrentQueueWritersRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "GlobalLockPercentageRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "GlobalPageFaultExceptionsThrownRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "GreaterThanDaysThresholdView": { "description": "Threshold value that triggers an alert.", "properties": { "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "int32", "type": "integer" }, "units": { "description": "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", "enum": [ "DAYS" ], "type": "string" } }, "type": "object" }, "GreaterThanRawThreshold": { "description": "A Limit that triggers an alert when greater than a number.", "properties": { "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "int32", "type": "integer" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "title": "Greater Than Raw Threshold", "type": "object" }, "GreaterThanTimeThreshold": { "description": "A Limit that triggers an alert when greater than a time period.", "properties": { "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "int32", "type": "integer" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "title": "Greater Than Time Threshold", "type": "object" }, "GroupAlertsConfig": { "oneOf": [ { "$ref": "#/$defs/DefaultAlertConfigViewForNdsGroup" }, { "$ref": "#/$defs/AppServiceAlertConfigViewForNdsGroup" }, { "$ref": "#/$defs/AppServiceMetricAlertConfigViewForNdsGroup" }, { "$ref": "#/$defs/BillingThresholdAlertConfigViewForNdsGroup" }, { "$ref": "#/$defs/ClusterAlertConfigViewForNdsGroup" }, { "$ref": "#/$defs/CpsBackupThresholdAlertConfigViewForNdsGroup" }, { "$ref": "#/$defs/EncryptionKeyAlertConfigViewForNdsGroup" }, { "$ref": "#/$defs/HostAlertConfigViewForNdsGroup" }, { "$ref": "#/$defs/HostMetricAlertConfigViewForNdsGroup" }, { "$ref": "#/$defs/MongotuneAlertConfigViewForNdsGroup" }, { "$ref": "#/$defs/NDSX509UserAuthenticationAlertConfigViewForNdsGroup" }, { "$ref": "#/$defs/ReplicaSetAlertConfigViewForNdsGroup" }, { "$ref": "#/$defs/ReplicaSetThresholdAlertConfigViewForNdsGroup" }, { "$ref": "#/$defs/ServerlessMetricAlertConfigViewForNdsGroup" }, { "$ref": "#/$defs/FlexMetricAlertConfigViewForNdsGroup" }, { "$ref": "#/$defs/StreamProcessorAlertConfigViewForNdsGroup" }, { "$ref": "#/$defs/StreamProcessorMetricAlertConfigViewForNdsGroup" } ], "type": "object" }, "GroupNotification": { "description": "Group notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties": { "delayMin": { "description": "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.", "format": "int32", "type": "integer" }, "emailEnabled": { "description": "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`", "type": "boolean" }, "intervalMin": { "description": "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", "format": "int32", "minimum": 5, "type": "integer" }, "notifierId": { "description": "The `notifierId` is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", "pattern": "^([a-f0-9]{24})$", "type": "string" }, "roles": { "description": "List that contains the one or more project roles that receive the configured alert. This parameter is available when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", "items": { "description": "One or more project roles that receive the configured alert.", "type": "string" }, "type": "array" }, "smsEnabled": { "description": "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`", "type": "boolean" }, "typeName": { "description": "Human-readable label that displays the alert notification type.", "enum": [ "GROUP" ], "type": "string" } }, "required": [ "typeName" ], "title": "Group Notification", "type": "object" }, "HipChatNotification": { "description": "HipChat notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties": { "delayMin": { "description": "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.", "format": "int32", "type": "integer" }, "integrationId": { "description": "The id of the associated integration, the credentials of which to use for requests.", "type": "string" }, "intervalMin": { "description": "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", "format": "int32", "minimum": 5, "type": "integer" }, "notificationToken": { "description": "HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\". If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", "type": "string" }, "notifierId": { "description": "The `notifierId` is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", "pattern": "^([a-f0-9]{24})$", "type": "string" }, "roomName": { "description": "HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"HIP_CHAT\"`\".", "type": "string" }, "typeName": { "description": "Human-readable label that displays the alert notification type.", "enum": [ "HIP_CHAT" ], "type": "string" } }, "required": [ "typeName" ], "title": "HipChat Notification", "type": "object" }, "HostAlertConfigViewForNdsGroup": { "description": "Host alert configuration allows to select which mongod host events trigger alerts and how users are notified.", "properties": { "created": { "description": "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" }, "enabled": { "default": false, "description": "Flag that indicates whether someone enabled this alert configuration for the specified project.", "type": "boolean" }, "eventTypeName": { "$ref": "#/$defs/HostEventTypeViewForNdsGroupAlertable" }, "groupId": { "description": "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "id": { "description": "Unique 24-hexadecimal digit string that identifies this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" }, "matchers": { "description": "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the `eventTypeName` specifies an event for a host, replica set, or sharded cluster.", "items": { "$ref": "#/$defs/HostMatcher" }, "type": "array" }, "notifications": { "description": "List that contains the targets that MongoDB Cloud sends notifications.", "items": { "$ref": "#/$defs/AlertsNotificationRootForGroup" }, "maxItems": 25, "minItems": 1, "type": "array" }, "severityOverride": { "$ref": "#/$defs/EventSeverity" }, "updated": { "description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "eventTypeName", "notifications" ], "title": "Host Alert Configuration", "type": "object" }, "HostEventTypeViewForNdsGroupAlertable": { "description": "Event type that triggers an alert.", "enum": [ "HOST_DOWN", "HOST_HAS_INDEX_SUGGESTIONS", "HOST_MONGOT_CRASHING_OOM", "HOST_MONGOT_STOP_REPLICATION", "HOST_MONGOT_APPROACHING_STOP_REPLICATION", "HOST_MONGOT_PAUSE_INITIAL_SYNC", "HOST_SEARCH_NODE_INDEX_FAILED", "HOST_EXTERNAL_LOG_SINK_EXPORT_DOWN", "HOST_NOT_ENOUGH_DISK_SPACE", "SSH_KEY_NDS_HOST_ACCESS_REQUESTED", "SSH_KEY_NDS_HOST_ACCESS_REFRESHED", "PUSH_BASED_LOG_EXPORT_STOPPED", "PUSH_BASED_LOG_EXPORT_DROPPED_LOG", "HOST_VERSION_BEHIND", "VERSION_BEHIND", "HOST_EXPOSED", "HOST_SSL_CERTIFICATE_STALE", "HOST_SECURITY_CHECKUP_NOT_MET", "ALERT_HOST_SSH_SESSION_STARTED", "PROFILER_CONFIGURED_TOO_WIDELY" ], "title": "Host Event Types", "type": "string" }, "HostMatcher": { "description": "Rules to apply when comparing an host against this alert configuration.", "properties": { "fieldName": { "$ref": "#/$defs/HostMatcherField" }, "operator": { "description": "Comparison operator to apply when checking the current metric value against **matcher[n].value**. The `REGEX` operator only supports inclusive matches. Use the `NOT_CONTAINS` operator to exclude values.", "enum": [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ], "type": "string" }, "value": { "$ref": "#/$defs/MatcherHostType" } }, "required": [ "fieldName", "operator" ], "title": "Matchers", "type": "object" }, "HostMatcherField": { "description": "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", "enum": [ "TYPE_NAME", "HOSTNAME", "PORT", "HOSTNAME_AND_PORT", "REPLICA_SET_NAME", "ATLAS_NODE_TYPE" ], "title": "Host Matcher Fields", "type": "string" }, "HostMetricAlertConfigViewForNdsGroup": { "description": "Host metric alert configuration allows to select which mongod host metrics trigger alerts and how users are notified.", "properties": { "created": { "description": "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" }, "enabled": { "default": false, "description": "Flag that indicates whether someone enabled this alert configuration for the specified project.", "type": "boolean" }, "eventTypeName": { "$ref": "#/$defs/HostMetricEventTypeViewAlertable" }, "groupId": { "description": "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "id": { "description": "Unique 24-hexadecimal digit string that identifies this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" }, "matchers": { "description": "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the `eventTypeName` specifies an event for a host, replica set, or sharded cluster.", "items": { "$ref": "#/$defs/HostMatcher" }, "type": "array" }, "metricThreshold": { "$ref": "#/$defs/HostMetricThreshold" }, "notifications": { "description": "List that contains the targets that MongoDB Cloud sends notifications.", "items": { "$ref": "#/$defs/AlertsNotificationRootForGroup" }, "maxItems": 25, "minItems": 1, "type": "array" }, "severityOverride": { "$ref": "#/$defs/EventSeverity" }, "updated": { "description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "eventTypeName", "notifications" ], "title": "Host Metric Alert Configuration", "type": "object" }, "HostMetricEventTypeViewAlertable": { "description": "Event type that triggers an alert.", "enum": [ "OUTSIDE_METRIC_THRESHOLD" ], "title": "Host Metric Event Types", "type": "string" }, "HostMetricThreshold": { "description": "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about mongod host.", "oneOf": [ { "$ref": "#/$defs/AssertRegularRawMetricThresholdView" }, { "$ref": "#/$defs/AssertWarningRawMetricThresholdView" }, { "$ref": "#/$defs/AssertMsgRawMetricThresholdView" }, { "$ref": "#/$defs/AssertUserRawMetricThresholdView" }, { "$ref": "#/$defs/OpCounterCmdRawMetricThresholdView" }, { "$ref": "#/$defs/OpCounterQueryRawMetricThresholdView" }, { "$ref": "#/$defs/OpCounterUpdateRawMetricThresholdView" }, { "$ref": "#/$defs/OpCounterDeleteRawMetricThresholdView" }, { "$ref": "#/$defs/OpCounterTtlDeletedRawMetricThresholdView" }, { "$ref": "#/$defs/OpCounterInsertRawMetricThresholdView" }, { "$ref": "#/$defs/OpCounterGetMoreRawMetricThresholdView" }, { "$ref": "#/$defs/OpCounterReplCmdRawMetricThresholdView" }, { "$ref": "#/$defs/OpCounterReplUpdateRawMetricThresholdView" }, { "$ref": "#/$defs/OpCounterReplDeleteRawMetricThresholdView" }, { "$ref": "#/$defs/OpCounterReplInsertRawMetricThresholdView" }, { "$ref": "#/$defs/FtsMemoryResidentDataMetricThresholdView" }, { "$ref": "#/$defs/FtsMemoryVirtualDataMetricThresholdView" }, { "$ref": "#/$defs/FtsMemoryMappedDataMetricThresholdView" }, { "$ref": "#/$defs/FtsProcessCpuUserRawMetricThresholdView" }, { "$ref": "#/$defs/FtsProcessCpuKernelRawMetricThresholdView" }, { "$ref": "#/$defs/NormalizedFtsProcessCpuUserRawMetricThresholdView" }, { "$ref": "#/$defs/NormalizedFtsProcessCpuKernelRawMetricThresholdView" }, { "$ref": "#/$defs/SystemMemoryPercentUsedRawMetricThresholdView" }, { "$ref": "#/$defs/MemoryResidentDataMetricThresholdView" }, { "$ref": "#/$defs/MemoryVirtualDataMetricThresholdView" }, { "$ref": "#/$defs/MemoryMappedDataMetricThresholdView" }, { "$ref": "#/$defs/ComputedMemoryDataMetricThresholdView" }, { "$ref": "#/$defs/IndexCountersBtreeAccessesRawMetricThresholdView" }, { "$ref": "#/$defs/IndexCountersBtreeHitsRawMetricThresholdView" }, { "$ref": "#/$defs/IndexCountersBtreeMissesRawMetricThresholdView" }, { "$ref": "#/$defs/IndexCountersBtreeMissRatioRawMetricThresholdView" }, { "$ref": "#/$defs/GlobalLockPercentageRawMetricThresholdView" }, { "$ref": "#/$defs/TimeMetricThresholdView" }, { "$ref": "#/$defs/ConnectionsRawMetricThresholdView" }, { "$ref": "#/$defs/ConnectionsMaxRawMetricThresholdView" }, { "$ref": "#/$defs/ConnectionsPercentRawMetricThresholdView" }, { "$ref": "#/$defs/GlobalAccessesNotInMemoryRawMetricThresholdView" }, { "$ref": "#/$defs/GlobalPageFaultExceptionsThrownRawMetricThresholdView" }, { "$ref": "#/$defs/GlobalLockCurrentQueueTotalRawMetricThresholdView" }, { "$ref": "#/$defs/GlobalLockCurrentQueueReadersRawMetricThresholdView" }, { "$ref": "#/$defs/GlobalLockCurrentQueueWritersRawMetricThresholdView" }, { "$ref": "#/$defs/CursorsTotalOpenRawMetricThresholdView" }, { "$ref": "#/$defs/CursorsTotalTimedOutRawMetricThresholdView" }, { "$ref": "#/$defs/CursorsTotalClientCursorsSizeRawMetricThresholdView" }, { "$ref": "#/$defs/NetworkBytesInDataMetricThresholdView" }, { "$ref": "#/$defs/NetworkBytesOutDataMetricThresholdView" }, { "$ref": "#/$defs/NetworkNumRequestsRawMetricThresholdView" }, { "$ref": "#/$defs/OplogMasterTimeTimeMetricThresholdView" }, { "$ref": "#/$defs/OplogMasterTimeEstimatedTtlTimeMetricThresholdView" }, { "$ref": "#/$defs/OplogSlaveLagMasterTimeTimeMetricThresholdView" }, { "$ref": "#/$defs/OplogMasterLagTimeDiffTimeMetricThresholdView" }, { "$ref": "#/$defs/OplogRateGbPerHourDataMetricThresholdView" }, { "$ref": "#/$defs/ExtraInfoPageFaultsRawMetricThresholdView" }, { "$ref": "#/$defs/DbStorageTotalDataMetricThresholdView" }, { "$ref": "#/$defs/DbDataSizeTotalDataMetricThresholdView" }, { "$ref": "#/$defs/DbDataSizeTotalWoSystemDataMetricThresholdView" }, { "$ref": "#/$defs/DbIndexSizeTotalDataMetricThresholdView" }, { "$ref": "#/$defs/JournalingCommitsInWriteLockRawMetricThresholdView" }, { "$ref": "#/$defs/JournalingMbDataMetricThresholdView" }, { "$ref": "#/$defs/JournalingWriteDataFilesMbDataMetricThresholdView" }, { "$ref": "#/$defs/TicketsAvailableReadsRawMetricThresholdView" }, { "$ref": "#/$defs/TicketsAvailableWritesRawMetricThresholdView" }, { "$ref": "#/$defs/CacheUsageDirtyDataMetricThresholdView" }, { "$ref": "#/$defs/CacheUsageUsedDataMetricThresholdView" }, { "$ref": "#/$defs/CacheBytesReadIntoDataMetricThresholdView" }, { "$ref": "#/$defs/CacheBytesWrittenFromDataMetricThresholdView" }, { "$ref": "#/$defs/NormalizedSystemCpuUserRawMetricThresholdView" }, { "$ref": "#/$defs/NormalizedSystemCpuStealRawMetricThresholdView" }, { "$ref": "#/$defs/DiskPartitionSpaceUsedDataRawMetricThresholdView" }, { "$ref": "#/$defs/DiskPartitionSpaceUsedIndexRawMetricThresholdView" }, { "$ref": "#/$defs/DiskPartitionSpaceUsedJournalRawMetricThresholdView" }, { "$ref": "#/$defs/DiskPartitionReadIopsDataRawMetricThresholdView" }, { "$ref": "#/$defs/DiskPartitionReadIopsIndexRawMetricThresholdView" }, { "$ref": "#/$defs/DiskPartitionReadIopsJournalRawMetricThresholdView" }, { "$ref": "#/$defs/DiskPartitionWriteIopsDataRawMetricThresholdView" }, { "$ref": "#/$defs/DiskPartitionWriteIopsIndexRawMetricThresholdView" }, { "$ref": "#/$defs/DiskPartitionWriteIopsJournalRawMetricThresholdView" }, { "$ref": "#/$defs/DiskPartitionReadLatencyDataTimeMetricThresholdView" }, { "$ref": "#/$defs/DiskPartitionReadLatencyIndexTimeMetricThresholdView" }, { "$ref": "#/$defs/DiskPartitionReadLatencyJournalTimeMetricThresholdView" }, { "$ref": "#/$defs/DiskPartitionWriteLatencyDataTimeMetricThresholdView" }, { "$ref": "#/$defs/DiskPartitionWriteLatencyIndexTimeMetricThresholdView" }, { "$ref": "#/$defs/DiskPartitionWriteLatencyJournalTimeMetricThresholdView" }, { "$ref": "#/$defs/DiskPartitionQueueDepthDataRawMetricThresholdView" }, { "$ref": "#/$defs/DiskPartitionQueueDepthIndexRawMetricThresholdView" }, { "$ref": "#/$defs/DiskPartitionQueueDepthJournalRawMetricThresholdView" }, { "$ref": "#/$defs/FtsDiskUtilizationDataMetricThresholdView" }, { "$ref": "#/$defs/MuninCpuUserRawMetricThresholdView" }, { "$ref": "#/$defs/MuninCpuNiceRawMetricThresholdView" }, { "$ref": "#/$defs/MuninCpuSystemRawMetricThresholdView" }, { "$ref": "#/$defs/MuninCpuIowaitRawMetricThresholdView" }, { "$ref": "#/$defs/MuninCpuIrqRawMetricThresholdView" }, { "$ref": "#/$defs/MuninCpuSoftirqRawMetricThresholdView" }, { "$ref": "#/$defs/MuninCpuStealRawMetricThresholdView" }, { "$ref": "#/$defs/DocumentReturnedRawMetricThresholdView" }, { "$ref": "#/$defs/DocumentInsertedRawMetricThresholdView" }, { "$ref": "#/$defs/DocumentUpdatedRawMetricThresholdView" }, { "$ref": "#/$defs/DocumentDeletedRawMetricThresholdView" }, { "$ref": "#/$defs/OperationsScanAndOrderRawMetricThresholdView" }, { "$ref": "#/$defs/QueryExecutorScannedRawMetricThresholdView" }, { "$ref": "#/$defs/QueryExecutorScannedObjectsRawMetricThresholdView" }, { "$ref": "#/$defs/OperationThrottlingRejectedOperationsRawMetricThresholdView" }, { "$ref": "#/$defs/QuerySpillToDiskDuringSortRawMetricThresholdView" }, { "$ref": "#/$defs/OperationsQueriesKilledRawMetricThresholdView" }, { "$ref": "#/$defs/QueryTargetingScannedPerReturnedRawMetricThresholdView" }, { "$ref": "#/$defs/QueryTargetingScannedObjectsPerReturnedRawMetricThresholdView" }, { "$ref": "#/$defs/AvgReadExecutionTimeTimeMetricThresholdView" }, { "$ref": "#/$defs/AvgWriteExecutionTimeTimeMetricThresholdView" }, { "$ref": "#/$defs/AvgCommandExecutionTimeTimeMetricThresholdView" }, { "$ref": "#/$defs/LogicalSizeDataMetricThresholdView" }, { "$ref": "#/$defs/RestartsInLastHourRawMetricThresholdView" }, { "$ref": "#/$defs/SystemMemoryUsedDataMetricThresholdView" }, { "$ref": "#/$defs/SystemMemoryAvailableDataMetricThresholdView" }, { "$ref": "#/$defs/SwapUsageUsedDataMetricThresholdView" }, { "$ref": "#/$defs/SwapUsageFreeDataMetricThresholdView" }, { "$ref": "#/$defs/SystemNetworkInDataMetricThresholdView" }, { "$ref": "#/$defs/SystemNetworkOutDataMetricThresholdView" }, { "$ref": "#/$defs/MaxNormalizedSystemCpuUserRawMetricThresholdView" }, { "$ref": "#/$defs/MaxNormalizedSystemCpuStealRawMetricThresholdView" }, { "$ref": "#/$defs/MaxDiskPartitionSpaceUsedDataRawMetricThresholdView" }, { "$ref": "#/$defs/MaxDiskPartitionSpaceUsedIndexRawMetricThresholdView" }, { "$ref": "#/$defs/MaxDiskPartitionSpaceUsedJournalRawMetricThresholdView" }, { "$ref": "#/$defs/MaxDiskPartitionReadIopsDataRawMetricThresholdView" }, { "$ref": "#/$defs/MaxDiskPartitionReadIopsIndexRawMetricThresholdView" }, { "$ref": "#/$defs/MaxDiskPartitionReadIopsJournalRawMetricThresholdView" }, { "$ref": "#/$defs/MaxDiskPartitionWriteIopsDataRawMetricThresholdView" }, { "$ref": "#/$defs/MaxDiskPartitionWriteIopsIndexRawMetricThresholdView" }, { "$ref": "#/$defs/MaxDiskPartitionWriteIopsJournalRawMetricThresholdView" }, { "$ref": "#/$defs/MaxDiskPartitionReadLatencyDataTimeMetricThresholdView" }, { "$ref": "#/$defs/MaxDiskPartitionReadLatencyIndexTimeMetricThresholdView" }, { "$ref": "#/$defs/MaxDiskPartitionReadLatencyJournalTimeMetricThresholdView" }, { "$ref": "#/$defs/MaxDiskPartitionWriteLatencyDataTimeMetricThresholdView" }, { "$ref": "#/$defs/MaxDiskPartitionWriteLatencyIndexTimeMetricThresholdView" }, { "$ref": "#/$defs/MaxDiskPartitionWriteLatencyJournalTimeMetricThresholdView" }, { "$ref": "#/$defs/MaxDiskPartitionQueueDepthDataRawMetricThresholdView" }, { "$ref": "#/$defs/MaxDiskPartitionQueueDepthIndexRawMetricThresholdView" }, { "$ref": "#/$defs/MaxDiskPartitionQueueDepthJournalRawMetricThresholdView" }, { "$ref": "#/$defs/MaxSystemMemoryPercentUsedRawMetricThresholdView" }, { "$ref": "#/$defs/MaxSystemMemoryUsedDataMetricThresholdView" }, { "$ref": "#/$defs/MaxSystemMemoryAvailableDataMetricThresholdView" }, { "$ref": "#/$defs/MaxSwapUsageUsedDataMetricThresholdView" }, { "$ref": "#/$defs/MaxSwapUsageFreeDataMetricThresholdView" }, { "$ref": "#/$defs/MaxSystemNetworkInDataMetricThresholdView" }, { "$ref": "#/$defs/MaxSystemNetworkOutDataMetricThresholdView" }, { "$ref": "#/$defs/SearchIndexSizeDataMetricThresholdView" }, { "$ref": "#/$defs/SearchMaxFieldsIndexedRawMetricThresholdView" }, { "$ref": "#/$defs/SearchProcessThrottlingRawMetricThresholdView" }, { "$ref": "#/$defs/SearchNumberOfFieldsInIndexRawMetricThresholdView" }, { "$ref": "#/$defs/SearchMaxNgramFieldsIndexedRawMetricThresholdView" }, { "$ref": "#/$defs/SearchReplicationLagTimeMetricThresholdView" }, { "$ref": "#/$defs/NumberMetricThresholdView" }, { "$ref": "#/$defs/SearchOpCounterInsertRawMetricThresholdView" }, { "$ref": "#/$defs/SearchOpCounterDeleteRawMetricThresholdView" }, { "$ref": "#/$defs/SearchOpCounterUpdateRawMetricThresholdView" }, { "$ref": "#/$defs/SearchOpCounterGetMoreRawMetricThresholdView" }, { "$ref": "#/$defs/SearchNumberOfQueriesTotalRawMetricThresholdView" }, { "$ref": "#/$defs/SearchNumberOfQueriesErrorRawMetricThresholdView" }, { "$ref": "#/$defs/SearchNumberOfQueriesSuccessRawMetricThresholdView" }, { "$ref": "#/$defs/FtsJvmMaxMemoryDataMetricThresholdView" }, { "$ref": "#/$defs/FtsJvmCurrentMemoryDataMetricThresholdView" } ], "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "description": "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", "enum": [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "tokens", "million tokens", "pixels", "billion pixels", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion" ], "type": "string" } }, "required": [ "metricName" ], "title": "Host Metric Threshold", "type": "object" }, "IndexCountersBtreeAccessesRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "IndexCountersBtreeHitsRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "IndexCountersBtreeMissRatioRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "IndexCountersBtreeMissesRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "JournalingCommitsInWriteLockRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "JournalingMbDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "JournalingWriteDataFilesMbDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "KafkaRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "LessThanDaysThresholdView": { "description": "Threshold value that triggers an alert.", "properties": { "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "int32", "type": "integer" }, "units": { "description": "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", "enum": [ "DAYS" ], "type": "string" } }, "type": "object" }, "Link": { "properties": { "href": { "description": "Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", "type": "string" }, "rel": { "description": "Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with `https://cloud.mongodb.com/api/atlas`.", "type": "string" } }, "type": "object" }, "LogicalSizeDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MatcherHostType": { "description": "Value to match or exceed using the specified `matchers.operator`.", "enum": [ "STANDALONE", "PRIMARY", "SECONDARY", "ARBITER", "MONGOS", "CONFIG", "MONGOT" ], "title": "Matcher Host Types", "type": "string" }, "MaxDiskPartitionQueueDepthDataRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxDiskPartitionQueueDepthIndexRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxDiskPartitionQueueDepthJournalRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxDiskPartitionReadIopsDataRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxDiskPartitionReadIopsIndexRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxDiskPartitionReadIopsJournalRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxDiskPartitionReadLatencyDataTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxDiskPartitionReadLatencyIndexTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxDiskPartitionReadLatencyJournalTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxDiskPartitionSpaceUsedDataRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxDiskPartitionSpaceUsedIndexRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxDiskPartitionSpaceUsedJournalRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxDiskPartitionWriteIopsDataRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxDiskPartitionWriteIopsIndexRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxDiskPartitionWriteIopsJournalRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxDiskPartitionWriteLatencyDataTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxDiskPartitionWriteLatencyIndexTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxDiskPartitionWriteLatencyJournalTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxNormalizedSystemCpuStealRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxNormalizedSystemCpuUserRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxSwapUsageFreeDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxSwapUsageUsedDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxSystemMemoryAvailableDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxSystemMemoryPercentUsedRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxSystemMemoryUsedDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxSystemNetworkInDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MaxSystemNetworkOutDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MemoryMappedDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MemoryResidentDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MemoryVirtualDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MicrosoftTeamsNotification": { "description": "Microsoft Teams notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties": { "delayMin": { "description": "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.", "format": "int32", "type": "integer" }, "integrationId": { "description": "The id of the associated integration, the credentials of which to use for requests.", "type": "string" }, "intervalMin": { "description": "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", "format": "int32", "minimum": 5, "type": "integer" }, "microsoftTeamsWebhookUrl": { "description": "Microsoft Teams Webhook Uniform Resource Locator (URL) that MongoDB Cloud needs to send this notification via Microsoft Teams. The resource requires this parameter when `\"notifications.[n].typeName\" : \"MICROSOFT_TEAMS\"`. If the URL later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: When you view or edit the alert for a Microsoft Teams notification, the URL appears partially redacted.", "type": "string" }, "notifierId": { "description": "The `notifierId` is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", "pattern": "^([a-f0-9]{24})$", "type": "string" }, "typeName": { "description": "Human-readable label that displays the alert notification type.", "enum": [ "MICROSOFT_TEAMS" ], "type": "string" } }, "required": [ "typeName" ], "title": "Microsoft Teams Notification", "type": "object" }, "MongotuneAlertConfigViewForNdsGroup": { "description": "Intelligent Workload Management alert configuration allows to select which Intelligent Workload Management events trigger alerts and how users are notified.", "properties": { "created": { "description": "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" }, "enabled": { "default": false, "description": "Flag that indicates whether someone enabled this alert configuration for the specified project.", "type": "boolean" }, "eventTypeName": { "$ref": "#/$defs/MongotuneEventTypeViewAlertable" }, "groupId": { "description": "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "id": { "description": "Unique 24-hexadecimal digit string that identifies this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" }, "matchers": { "description": "Matching conditions for target resources.", "items": { "$ref": "#/$defs/AlertMatcher" }, "type": "array" }, "notifications": { "description": "List that contains the targets that MongoDB Cloud sends notifications.", "items": { "$ref": "#/$defs/AlertsNotificationRootForGroup" }, "maxItems": 25, "minItems": 1, "type": "array" }, "severityOverride": { "$ref": "#/$defs/EventSeverity" }, "updated": { "description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "eventTypeName", "notifications" ], "title": "Intelligent Workload Management Alert Configuration", "type": "object" }, "MongotuneEventTypeViewAlertable": { "description": "Event type that triggers an alert.", "enum": [ "MONGOTUNE_ALERT" ], "title": "Mongotune Event Types", "type": "string" }, "MuninCpuIowaitRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MuninCpuIrqRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MuninCpuNiceRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MuninCpuSoftirqRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MuninCpuStealRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MuninCpuSystemRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "MuninCpuUserRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "NDSX509UserAuthenticationAlertConfigViewForNdsGroup": { "description": "X509 User Authentication alert configuration allows to select thresholds for expiration of client, CA certificates and CRL which trigger alerts and how users are notified.", "properties": { "created": { "description": "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" }, "enabled": { "default": false, "description": "Flag that indicates whether someone enabled this alert configuration for the specified project.", "type": "boolean" }, "eventTypeName": { "$ref": "#/$defs/NDSX509UserAuthenticationEventTypeViewAlertable" }, "groupId": { "description": "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "id": { "description": "Unique 24-hexadecimal digit string that identifies this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" }, "matchers": { "description": "Matching conditions for target resources.", "items": { "$ref": "#/$defs/AlertMatcher" }, "type": "array" }, "notifications": { "description": "List that contains the targets that MongoDB Cloud sends notifications.", "items": { "$ref": "#/$defs/AlertsNotificationRootForGroup" }, "maxItems": 25, "minItems": 1, "type": "array" }, "severityOverride": { "$ref": "#/$defs/EventSeverity" }, "threshold": { "$ref": "#/$defs/LessThanDaysThresholdView" }, "updated": { "description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "eventTypeName", "notifications" ], "title": "X509 User Authentication Alert Configuration", "type": "object" }, "NDSX509UserAuthenticationEventTypeViewAlertable": { "description": "Event type that triggers an alert.", "enum": [ "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CA_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_CUSTOMER_CRL_EXPIRATION_CHECK", "NDS_X509_USER_AUTHENTICATION_MANAGED_USER_CERTS_EXPIRATION_CHECK" ], "title": "x509 User Auth Event Types", "type": "string" }, "NetworkBytesInDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "NetworkBytesOutDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "NetworkNumRequestsRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "NormalizedFtsProcessCpuKernelRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "NormalizedFtsProcessCpuUserRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "NormalizedSystemCpuStealRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "NormalizedSystemCpuUserRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "NumberMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/NumberMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "NumberMetricUnits": { "description": "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", "enum": [ "COUNT", "THOUSAND", "MILLION", "BILLION" ], "title": "Number Metric Units", "type": "string" }, "OpCounterCmdRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "OpCounterDeleteRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "OpCounterGetMoreRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "OpCounterInsertRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "OpCounterQueryRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "OpCounterReplCmdRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "OpCounterReplDeleteRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "OpCounterReplInsertRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "OpCounterReplUpdateRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "OpCounterTtlDeletedRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "OpCounterUpdateRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "OperationThrottlingRejectedOperationsRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "OperationsQueriesKilledRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "OperationsScanAndOrderRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "Operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "<", ">" ], "type": "string" }, "OplogMasterLagTimeDiffTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "OplogMasterTimeEstimatedTtlTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "OplogMasterTimeTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "OplogRateGbPerHourDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "OplogSlaveLagMasterTimeTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "OpsGenieNotification": { "description": "OpsGenie notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties": { "delayMin": { "description": "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.", "format": "int32", "type": "integer" }, "integrationId": { "description": "The id of the associated integration, the credentials of which to use for requests.", "type": "string" }, "intervalMin": { "description": "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", "format": "int32", "minimum": 5, "type": "integer" }, "notifierId": { "description": "The `notifierId` is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", "pattern": "^([a-f0-9]{24})$", "type": "string" }, "opsGenieApiKey": { "description": "API Key that MongoDB Cloud needs to send this notification via OpsGenie. The resource requires this parameter when `\"notifications.[n].typeName\" : \"OPS_GENIE\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", "type": "string" }, "opsGenieRegion": { "default": "US", "description": "OpsGenie region that indicates which API Uniform Resource Locator (URL) to use.", "enum": [ "US", "EU" ], "type": "string" }, "typeName": { "description": "Human-readable label that displays the alert notification type.", "enum": [ "OPS_GENIE" ], "type": "string" } }, "required": [ "typeName" ], "title": "OpsGenie Notification", "type": "object" }, "OrgNotification": { "description": "Organization notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties": { "delayMin": { "description": "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.", "format": "int32", "type": "integer" }, "emailEnabled": { "description": "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`", "type": "boolean" }, "intervalMin": { "description": "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", "format": "int32", "minimum": 5, "type": "integer" }, "notifierId": { "description": "The `notifierId` is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", "pattern": "^([a-f0-9]{24})$", "type": "string" }, "roles": { "description": "List that contains the one or more organization roles that receive the configured alert. This parameter is available when `\"notifications.[n].typeName\" : \"GROUP\"` or `\"notifications.[n].typeName\" : \"ORG\"`. If you include this parameter, MongoDB Cloud sends alerts only to users assigned the roles you specify in the array. If you omit this parameter, MongoDB Cloud sends alerts to users assigned any role.", "items": { "description": "One or more organization roles that receive the configured alert.", "enum": [ "ORG_OWNER", "ORG_MEMBER", "ORG_GROUP_CREATOR", "ORG_BILLING_ADMIN", "ORG_BILLING_READ_ONLY", "ORG_READ_ONLY" ], "type": "string" }, "type": "array" }, "smsEnabled": { "description": "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`", "type": "boolean" }, "typeName": { "description": "Human-readable label that displays the alert notification type.", "enum": [ "ORG" ], "type": "string" } }, "required": [ "typeName" ], "title": "Organization Notification", "type": "object" }, "PagerDutyNotification": { "description": "PagerDuty notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties": { "delayMin": { "description": "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.", "format": "int32", "type": "integer" }, "integrationId": { "description": "The id of the associated integration, the credentials of which to use for requests.", "type": "string" }, "intervalMin": { "description": "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", "format": "int32", "minimum": 5, "type": "integer" }, "notifierId": { "description": "The `notifierId` is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", "pattern": "^([a-f0-9]{24})$", "type": "string" }, "region": { "default": "US", "description": "PagerDuty region that indicates which API Uniform Resource Locator (URL) to use.", "enum": [ "US", "EU" ], "type": "string" }, "serviceKey": { "description": "PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when `\"notifications.[n].typeName\" : \"PAGER_DUTY\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", "type": "string" }, "typeName": { "description": "Human-readable label that displays the alert notification type.", "enum": [ "PAGER_DUTY" ], "type": "string" } }, "required": [ "typeName" ], "title": "PagerDuty Notification", "type": "object" }, "QueryExecutorScannedObjectsRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "QueryExecutorScannedRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "QuerySpillToDiskDuringSortRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "QueryTargetingScannedObjectsPerReturnedRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "QueryTargetingScannedPerReturnedRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "RPUMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/ServerlessMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "RawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "RawMetricUnits": { "default": "RAW", "description": "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", "enum": [ "RAW" ], "title": "Raw Metric Units", "type": "string" }, "ReplicaSetAlertConfigViewForNdsGroup": { "description": "Replica Set alert configuration allows to select which conditions of mongod replica set trigger alerts and how users are notified.", "properties": { "created": { "description": "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" }, "enabled": { "default": false, "description": "Flag that indicates whether someone enabled this alert configuration for the specified project.", "type": "boolean" }, "eventTypeName": { "$ref": "#/$defs/ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold" }, "groupId": { "description": "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "id": { "description": "Unique 24-hexadecimal digit string that identifies this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" }, "matchers": { "description": "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the `eventTypeName` specifies an event for a host, replica set, or sharded cluster.", "items": { "$ref": "#/$defs/ReplicaSetMatcher" }, "type": "array" }, "notifications": { "description": "List that contains the targets that MongoDB Cloud sends notifications.", "items": { "$ref": "#/$defs/AlertsNotificationRootForGroup" }, "maxItems": 25, "minItems": 1, "type": "array" }, "severityOverride": { "$ref": "#/$defs/EventSeverity" }, "threshold": { "$ref": "#/$defs/AlertsThresholdInteger" }, "updated": { "description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "eventTypeName", "notifications" ], "title": "Replica Set Alert Configuration", "type": "object" }, "ReplicaSetEventTypeViewForNdsGroupAlertableNoThreshold": { "description": "Event type that triggers an alert.", "enum": [ "NO_PRIMARY", "PRIMARY_ELECTED" ], "title": "ReplicaSet Event Types", "type": "string" }, "ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold": { "description": "Event type that triggers an alert.", "enum": [ "TOO_MANY_ELECTIONS", "REPLICATION_OPLOG_WINDOW_RUNNING_OUT", "TOO_FEW_HEALTHY_MEMBERS", "TOO_MANY_UNHEALTHY_MEMBERS" ], "title": "ReplicaSet Event Types", "type": "string" }, "ReplicaSetMatcher": { "description": "Rules to apply when comparing an replica set against this alert configuration.", "properties": { "fieldName": { "$ref": "#/$defs/ReplicaSetMatcherField" }, "operator": { "description": "Comparison operator to apply when checking the current metric value against **matcher[n].value**. The `REGEX` operator only supports inclusive matches. Use the `NOT_CONTAINS` operator to exclude values.", "enum": [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ], "type": "string" }, "value": { "description": "Value to match or exceed using the specified `matchers.operator`.", "type": "string" } }, "required": [ "fieldName", "operator", "value" ], "title": "Matchers", "type": "object" }, "ReplicaSetMatcherField": { "description": "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", "enum": [ "REPLICA_SET_NAME", "SHARD_NAME", "CLUSTER_NAME" ], "title": "Replica Set Matcher Fields", "type": "string" }, "ReplicaSetThresholdAlertConfigViewForNdsGroup": { "description": "Replica Set threshold alert configuration allows to select thresholds for conditions of mongod replica set which trigger alerts and how users are notified.", "properties": { "created": { "description": "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" }, "enabled": { "default": false, "description": "Flag that indicates whether someone enabled this alert configuration for the specified project.", "type": "boolean" }, "eventTypeName": { "$ref": "#/$defs/ReplicaSetEventTypeViewForNdsGroupAlertableWithThreshold" }, "groupId": { "description": "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "id": { "description": "Unique 24-hexadecimal digit string that identifies this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" }, "matchers": { "description": "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration. You can filter using the matchers array if the `eventTypeName` specifies an event for a host, replica set, or sharded cluster.", "items": { "$ref": "#/$defs/ReplicaSetMatcher" }, "type": "array" }, "notifications": { "description": "List that contains the targets that MongoDB Cloud sends notifications.", "items": { "$ref": "#/$defs/AlertsNotificationRootForGroup" }, "maxItems": 25, "minItems": 1, "type": "array" }, "severityOverride": { "$ref": "#/$defs/EventSeverity" }, "threshold": { "$ref": "#/$defs/AlertsThresholdInteger" }, "updated": { "description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "eventTypeName", "notifications" ], "title": "Replica Set Threshold Alert Configuration", "type": "object" }, "RestartsInLastHourRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SMSNotification": { "description": "SMS notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties": { "delayMin": { "description": "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.", "format": "int32", "type": "integer" }, "intervalMin": { "description": "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", "format": "int32", "minimum": 5, "type": "integer" }, "mobileNumber": { "description": "Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SMS\"`.", "type": "string" }, "notifierId": { "description": "The `notifierId` is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", "pattern": "^([a-f0-9]{24})$", "type": "string" }, "typeName": { "description": "Human-readable label that displays the alert notification type.", "enum": [ "SMS" ], "type": "string" } }, "required": [ "typeName" ], "title": "SMS Notification", "type": "object" }, "SearchIndexSizeDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SearchMaxFieldsIndexedRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SearchMaxNgramFieldsIndexedRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SearchNumberOfFieldsInIndexRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SearchNumberOfQueriesErrorRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SearchNumberOfQueriesSuccessRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SearchNumberOfQueriesTotalRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SearchOpCounterDeleteRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SearchOpCounterGetMoreRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SearchOpCounterInsertRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SearchOpCounterUpdateRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SearchProcessThrottlingRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SearchReplicationLagTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "ServerlessAVGCommandExecutionTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "ServerlessAVGWriteExecutionTimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "ServerlessConnectionPercentageRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "ServerlessEventTypeViewAlertable": { "description": "Event type that triggers an alert.", "enum": [ "OUTSIDE_SERVERLESS_METRIC_THRESHOLD" ], "title": "Serverless Event Types", "type": "string" }, "ServerlessMetricAlertConfigViewForNdsGroup": { "description": "Serverless metric alert configuration allows to select which serverless database metrics trigger alerts and how users are notified.", "properties": { "created": { "description": "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" }, "enabled": { "default": false, "description": "Flag that indicates whether someone enabled this alert configuration for the specified project.", "type": "boolean" }, "eventTypeName": { "$ref": "#/$defs/ServerlessEventTypeViewAlertable" }, "groupId": { "description": "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "id": { "description": "Unique 24-hexadecimal digit string that identifies this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" }, "matchers": { "description": "Matching conditions for target resources.", "items": { "$ref": "#/$defs/AlertMatcher" }, "type": "array" }, "metricThreshold": { "$ref": "#/$defs/ServerlessMetricThreshold" }, "notifications": { "description": "List that contains the targets that MongoDB Cloud sends notifications.", "items": { "$ref": "#/$defs/AlertsNotificationRootForGroup" }, "maxItems": 25, "minItems": 1, "type": "array" }, "severityOverride": { "$ref": "#/$defs/EventSeverity" }, "updated": { "description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "eventTypeName", "notifications" ], "title": "Serverless Alert Configuration", "type": "object" }, "ServerlessMetricThreshold": { "description": "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics about the serverless database.", "oneOf": [ { "$ref": "#/$defs/ServerlessAVGCommandExecutionTimeMetricThresholdView" }, { "$ref": "#/$defs/ServerlessAVGWriteExecutionTimeMetricThresholdView" }, { "$ref": "#/$defs/TimeMetricThresholdView" }, { "$ref": "#/$defs/ServerlessTotalWriteUnitsRPUMetricThresholdView" }, { "$ref": "#/$defs/RPUMetricThresholdView" }, { "$ref": "#/$defs/ServerlessOpCounterUpdateRawMetricThresholdView" }, { "$ref": "#/$defs/ServerlessOpCounterQueryRawMetricThresholdView" }, { "$ref": "#/$defs/ServerlessOpCounterInsertRawMetricThresholdView" }, { "$ref": "#/$defs/ServerlessOpCounterGetMoreRawMetricThresholdView" }, { "$ref": "#/$defs/ServerlessOpCounterDeleteRawMetricThresholdView" }, { "$ref": "#/$defs/ServerlessOpCounterCDMRawMetricThresholdView" }, { "$ref": "#/$defs/ServerlessNetworkNumRequestRawMetricThresholdView" }, { "$ref": "#/$defs/ServerlessNetworkBytesOutDataMetricThresholdView" }, { "$ref": "#/$defs/ServerlessNetworkBytesInDataMetricThresholdView" }, { "$ref": "#/$defs/DataMetricThresholdView" }, { "$ref": "#/$defs/ServerlessConnectionPercentageRawMetricThresholdView" }, { "$ref": "#/$defs/RawMetricThresholdView" } ], "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "description": "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", "enum": [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "tokens", "million tokens", "pixels", "billion pixels", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion" ], "type": "string" } }, "required": [ "metricName" ], "title": "Serverless Metric Threshold", "type": "object" }, "ServerlessMetricUnits": { "description": "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", "enum": [ "RPU", "THOUSAND_RPU", "MILLION_RPU", "WPU", "THOUSAND_WPU", "MILLION_WPU" ], "title": "Serverless Metric Units", "type": "string" }, "ServerlessNetworkBytesInDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "ServerlessNetworkBytesOutDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "ServerlessNetworkNumRequestRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "ServerlessOpCounterCDMRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "ServerlessOpCounterDeleteRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "ServerlessOpCounterGetMoreRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "ServerlessOpCounterInsertRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "ServerlessOpCounterQueryRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "ServerlessOpCounterUpdateRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "ServerlessTotalWriteUnitsRPUMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/ServerlessMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SlackNotification": { "description": "Slack notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties": { "apiToken": { "description": "Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`. If the token later becomes invalid, MongoDB Cloud sends an email to the project owners. If the token remains invalid, MongoDB Cloud removes the token. \n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", "type": "string" }, "channelName": { "description": "Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when `\"notifications.[n].typeName\" : \"SLACK\"`.", "type": "string" }, "delayMin": { "description": "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.", "format": "int32", "type": "integer" }, "integrationId": { "description": "The id of the associated integration, the credentials of which to use for requests.", "type": "string" }, "intervalMin": { "description": "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", "format": "int32", "minimum": 5, "type": "integer" }, "notifierId": { "description": "The `notifierId` is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", "pattern": "^([a-f0-9]{24})$", "type": "string" }, "typeName": { "description": "Human-readable label that displays the alert notification type.", "enum": [ "SLACK" ], "type": "string" } }, "required": [ "typeName" ], "title": "Slack Notification", "type": "object" }, "StreamProcessorAlertConfigViewForNdsGroup": { "description": "Host metric alert configuration allows to select which Atlas streams processors trigger alerts and how users are notified.", "properties": { "created": { "description": "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" }, "enabled": { "default": false, "description": "Flag that indicates whether someone enabled this alert configuration for the specified project.", "type": "boolean" }, "eventTypeName": { "$ref": "#/$defs/StreamProcessorEventTypeViewAlertableNoThreshold" }, "groupId": { "description": "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "id": { "description": "Unique 24-hexadecimal digit string that identifies this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" }, "matchers": { "description": "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", "items": { "$ref": "#/$defs/StreamsMatcher" }, "type": "array" }, "notifications": { "description": "List that contains the targets that MongoDB Cloud sends notifications.", "items": { "$ref": "#/$defs/AlertsNotificationRootForGroup" }, "maxItems": 25, "minItems": 1, "type": "array" }, "severityOverride": { "$ref": "#/$defs/EventSeverity" }, "updated": { "description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "eventTypeName", "notifications" ], "title": "Stream Processor Alert Configuration", "type": "object" }, "StreamProcessorEventTypeViewAlertableNoThreshold": { "description": "Event type that triggers an alert.", "enum": [ "STREAM_PROCESSOR_STATE_IS_FAILED" ], "title": "Stream Processor Event Types", "type": "string" }, "StreamProcessorEventTypeViewAlertableWithThreshold": { "description": "Event type that triggers an alert.", "enum": [ "OUTSIDE_STREAM_PROCESSOR_METRIC_THRESHOLD" ], "title": "Stream Processor Event Types", "type": "string" }, "StreamProcessorMetricAlertConfigViewForNdsGroup": { "description": "Stream Processor threshold alert configuration allows to select thresholds on metrics which trigger alerts and how users are notified.", "properties": { "created": { "description": "Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" }, "enabled": { "default": false, "description": "Flag that indicates whether someone enabled this alert configuration for the specified project.", "type": "boolean" }, "eventTypeName": { "$ref": "#/$defs/StreamProcessorEventTypeViewAlertableWithThreshold" }, "groupId": { "description": "Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "id": { "description": "Unique 24-hexadecimal digit string that identifies this alert configuration.", "pattern": "^([a-f0-9]{24})$", "readOnly": true, "type": "string" }, "links": { "description": "List of one or more Uniform Resource Locators (URLs) that point to API sub-resources, related API resources, or both. RFC 5988 outlines these relationships.", "items": { "$ref": "#/$defs/Link" }, "readOnly": true, "type": "array" }, "matchers": { "description": "List of rules that determine whether MongoDB Cloud checks an object for the alert configuration.", "items": { "$ref": "#/$defs/StreamsMatcher" }, "type": "array" }, "metricThreshold": { "$ref": "#/$defs/StreamProcessorMetricThreshold" }, "notifications": { "description": "List that contains the targets that MongoDB Cloud sends notifications.", "items": { "$ref": "#/$defs/AlertsNotificationRootForGroup" }, "maxItems": 25, "minItems": 1, "type": "array" }, "severityOverride": { "$ref": "#/$defs/EventSeverity" }, "threshold": { "$ref": "#/$defs/DeprecatedStreamProcessorMetricThreshold" }, "updated": { "description": "Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.", "format": "date-time", "readOnly": true, "type": "string" } }, "required": [ "eventTypeName", "notifications" ], "title": "Stream Processor Metric Alert Configuration", "type": "object" }, "StreamProcessorMetricThreshold": { "description": "Threshold for the metric that, when exceeded, triggers an alert. The metric threshold pertains to event types which reflects changes of measurements and metrics in stream processors.", "oneOf": [ { "$ref": "#/$defs/KafkaRawMetricThresholdView" }, { "$ref": "#/$defs/TimeMetricThresholdView" }, { "$ref": "#/$defs/DLQRawMetricThresholdView" }, { "$ref": "#/$defs/RawMetricThresholdView" } ], "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "description": "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", "enum": [ "bits", "Kbits", "Mbits", "Gbits", "bytes", "KB", "MB", "GB", "TB", "PB", "nsec", "msec", "sec", "min", "hours", "million minutes", "days", "requests", "1000 requests", "tokens", "million tokens", "pixels", "billion pixels", "GB seconds", "GB hours", "GB days", "RPU", "thousand RPU", "million RPU", "WPU", "thousand WPU", "million WPU", "count", "thousand", "million", "billion" ], "type": "string" } }, "required": [ "metricName" ], "title": "Stream Processor Metric Threshold", "type": "object" }, "StreamsMatcher": { "description": "Rules to apply when comparing a stream processing workspace or stream processor against this alert configuration.", "properties": { "fieldName": { "$ref": "#/$defs/StreamsMatcherField" }, "operator": { "description": "Comparison operator to apply when checking the current metric value against **matcher[n].value**. The `REGEX` operator only supports inclusive matches. Use the `NOT_CONTAINS` operator to exclude values.", "enum": [ "EQUALS", "CONTAINS", "STARTS_WITH", "ENDS_WITH", "NOT_EQUALS", "NOT_CONTAINS", "REGEX" ], "type": "string" }, "value": { "description": "Value to match or exceed using the specified `matchers.operator`.", "type": "string" } }, "required": [ "fieldName", "operator", "value" ], "title": "Matchers", "type": "object" }, "StreamsMatcherField": { "description": "Name of the parameter in the target object that MongoDB Cloud checks. The parameter must match all rules for MongoDB Cloud to check for alert configurations.", "enum": [ "INSTANCE_NAME", "PROCESSOR_NAME" ], "title": "Streams Matcher Fields", "type": "string" }, "SwapUsageFreeDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SwapUsageUsedDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SystemMemoryAvailableDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SystemMemoryPercentUsedRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SystemMemoryUsedDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SystemNetworkInDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "SystemNetworkOutDataMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/DataMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "TeamNotification": { "description": "Team notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties": { "delayMin": { "description": "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.", "format": "int32", "type": "integer" }, "emailEnabled": { "description": "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`", "type": "boolean" }, "intervalMin": { "description": "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", "format": "int32", "minimum": 5, "type": "integer" }, "notifierId": { "description": "The `notifierId` is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", "pattern": "^([a-f0-9]{24})$", "type": "string" }, "smsEnabled": { "description": "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`", "type": "boolean" }, "teamId": { "description": "Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", "pattern": "^([a-f0-9]{24})$", "type": "string" }, "teamName": { "description": "Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when `\"notifications.[n].typeName\" : \"TEAM\"`.", "type": "string" }, "typeName": { "description": "Human-readable label that displays the alert notification type.", "enum": [ "TEAM" ], "type": "string" } }, "required": [ "typeName" ], "title": "Team Notification", "type": "object" }, "TicketsAvailableReadsRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "TicketsAvailableWritesRawMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/RawMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "TimeMetricThresholdView": { "properties": { "metricName": { "description": "Human-readable label that identifies the metric against which MongoDB Cloud checks the configured `metricThreshold.threshold`.", "type": "string" }, "mode": { "description": "MongoDB Cloud computes the current metric value as an average.", "enum": [ "AVERAGE" ], "type": "string" }, "operator": { "description": "Comparison operator to apply when checking the current metric value.", "enum": [ "LESS_THAN", "GREATER_THAN" ], "type": "string" }, "threshold": { "description": "Value of metric that, when exceeded, triggers an alert.", "format": "double", "type": "number" }, "units": { "$ref": "#/$defs/TimeMetricUnits" } }, "required": [ "metricName" ], "type": "object" }, "TimeMetricUnits": { "default": "HOURS", "description": "Element used to express the quantity. This can be an element of time, storage capacity, and the like.", "enum": [ "NANOSECONDS", "MILLISECONDS", "MILLION_MINUTES", "SECONDS", "MINUTES", "HOURS", "DAYS" ], "title": "Time Metric Units", "type": "string" }, "UserNotification": { "description": "User notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties": { "delayMin": { "description": "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.", "format": "int32", "type": "integer" }, "emailEnabled": { "description": "Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`", "type": "boolean" }, "intervalMin": { "description": "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", "format": "int32", "minimum": 5, "type": "integer" }, "notifierId": { "description": "The `notifierId` is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", "pattern": "^([a-f0-9]{24})$", "type": "string" }, "smsEnabled": { "description": "Flag that indicates whether MongoDB Cloud should send text message notifications. The resource requires this parameter when one of the following values have been set:\n\n- `\"notifications.[n].typeName\" : \"ORG\"`\n- `\"notifications.[n].typeName\" : \"GROUP\"`\n- `\"notifications.[n].typeName\" : \"USER\"`", "type": "boolean" }, "typeName": { "description": "Human-readable label that displays the alert notification type.", "enum": [ "USER" ], "type": "string" }, "username": { "description": "MongoDB Cloud username of the person to whom MongoDB Cloud sends notifications. Specify only MongoDB Cloud users who belong to the project that owns the alert configuration. The resource requires this parameter when `\"notifications.[n].typeName\" : \"USER\"`.", "format": "email", "type": "string" } }, "required": [ "typeName" ], "title": "User Notification", "type": "object" }, "VictorOpsNotification": { "description": "VictorOps notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties": { "delayMin": { "description": "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.", "format": "int32", "type": "integer" }, "integrationId": { "description": "The id of the associated integration, the credentials of which to use for requests.", "type": "string" }, "intervalMin": { "description": "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", "format": "int32", "minimum": 5, "type": "integer" }, "notifierId": { "description": "The `notifierId` is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", "pattern": "^([a-f0-9]{24})$", "type": "string" }, "typeName": { "description": "Human-readable label that displays the alert notification type.", "enum": [ "VICTOR_OPS" ], "type": "string" }, "victorOpsApiKey": { "description": "API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.\n\n**NOTE**: After you create a notification which requires an API or integration key, the key appears partially redacted when you:\n\n* View or edit the alert through the Atlas UI.\n\n* Query the alert for the notification through the Atlas Administration API.", "type": "string" }, "victorOpsRoutingKey": { "description": "Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when `\"notifications.[n].typeName\" : \"VICTOR_OPS\"`. If the key later becomes invalid, MongoDB Cloud sends an email to the project owners. If the key remains invalid, MongoDB Cloud removes it.", "type": "string" } }, "required": [ "typeName" ], "title": "VictorOps Notification", "type": "object" }, "WebhookNotification": { "description": "Webhook notification configuration for MongoDB Cloud to send information when an event triggers an alert condition.", "properties": { "delayMin": { "description": "Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.", "format": "int32", "type": "integer" }, "integrationId": { "description": "The id of the associated integration, the credentials of which to use for requests.", "type": "string" }, "intervalMin": { "description": "Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.\n\nPagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.", "format": "int32", "minimum": 5, "type": "integer" }, "notifierId": { "description": "The `notifierId` is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.", "pattern": "^([a-f0-9]{24})$", "type": "string" }, "typeName": { "description": "Human-readable label that displays the alert notification type.", "enum": [ "WEBHOOK" ], "type": "string" }, "webhookSecret": { "description": "Authentication secret for a webhook-based alert.\n\nAtlas returns this value if you set `notifications.[n].typeName` :`WEBHOOK` and either:\n* You set `notification.[n].webhookSecret` to a non-empty string\n* You set a default webhook secret either on the Integrations page, or with the Integrations API\n\n**NOTE**: When you view or edit the alert for a webhook notification, the secret appears completely redacted.", "format": "password", "type": "string" }, "webhookUrl": { "description": "Target URL for a webhook-based alert.\n\nAtlas returns this value if you set `\"notifications.[n].typeName\" :\"WEBHOOK\"` and either:\n* You set `notification.[n].webhookURL` to a non-empty string\n* You set a default webhook URL either on the Integrations page, or with the Integrations API\n\n**NOTE**: When you view or edit the alert for a Webhook URL notification, the URL appears partially redacted.", "type": "string" } }, "required": [ "typeName" ], "title": "Webhook Notification", "type": "object" } } }