latest--mongodb-atlas-alertconfiguration
sharedReturns and edits the conditions that trigger alerts and how MongoDB Cloud notifies users. This collection remains under revision and may change. Refer to the legacy documentation for this collection in the following link.. Source:- https://github.com/aws-cloudformation/aws-cloudformation-rpdk.git
Properties
Profile used to provide credentials information, (a secret with the cfn/atlas/profile/{Profile}, is required), if not provided default is used
Event type that triggers an alert.
Unique 24-hexadecimal digit string that identifies your project.
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.
5 nested properties
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
MongoDB Cloud computes the current metric value as an average.
Comparison operator to apply when checking the current metric value.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
List that contains the targets that MongoDB Cloud sends notifications.
3 nested properties
Comparison operator to apply when checking the current metric value.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Human-readable label that displays the alert type.
Definitions
Date and time when MongoDB Cloud created the alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Flag that indicates whether someone enabled this alert configuration for the specified project.
Event type that triggers an alert.
Unique 24-hexadecimal digit string that identifies the project that owns this alert configuration.
Unique 24-hexadecimal digit string that identifies this alert configuration.
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.
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.
5 nested properties
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
MongoDB Cloud computes the current metric value as an average.
Comparison operator to apply when checking the current metric value.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
List that contains the targets that MongoDB Cloud sends notifications.
3 nested properties
Comparison operator to apply when checking the current metric value.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Human-readable label that displays the alert type.
Date and time when someone last updated this alert configuration. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Date and time until which this alert has been acknowledged. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if a MongoDB User previously acknowledged this alert.
-
To acknowledge this alert forever, set the parameter value to 100 years in the future.
-
To unacknowledge a previously acknowledged alert, set the parameter value to a date in the past.
Comment that a MongoDB Cloud user submitted when acknowledging the alert.
MongoDB Cloud username of the person who acknowledged the alert. The response returns this parameter if a MongoDB Cloud user previously acknowledged this alert.
Unique 24-hexadecimal digit string that identifies the alert configuration that sets this alert.
Human-readable label that identifies the cluster to which this alert applies. This resource returns this parameter for alerts of events impacting backups, replica sets, or sharded clusters.
Date and time when MongoDB Cloud created this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
2 nested properties
Amount of the metricName recorded at the time of the event. This value triggered the alert.
Element used to express the quantity in currentValue.number. This can be an element of time, storage capacity, and the like. This metric triggered the alert.
Incident that triggered this alert.
Unique 24-hexadecimal digit string that identifies the project that owns this alert.
Hostname and port of the host to which this alert applies. The resource returns this parameter for alerts of events impacting hosts or replica sets.
Unique 24-hexadecimal digit string that identifies this alert.
Date and time that any notifications were last sent for this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter if MongoDB Cloud has sent notifications for this alert.
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.
Human-readable label that identifies the metric against which MongoDB Cloud checks the alert.
Name of the replica set to which this alert applies. The response returns this parameter for alerts of events impacting backups, hosts, or replica sets.
Date and time that this alert changed to '"status" : "CLOSED"'. This parameter expresses its value in the ISO 8601 timestamp format in UTC. The resource returns this parameter once '"status" : "CLOSED"'.
State of this alert at the time you requested its details.
Category in which MongoDB Cloud classifies this alert.
Date and time when someone last updated this alert. This parameter expresses its value in the ISO 8601 timestamp format in UTC.
Comparison operator to apply when checking the current metric value.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
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.
Comparison operator to apply when checking the current metric value against matcher[n].value.
Value to match or exceed using the specified matchers.operator.
Human-readable label that identifies the metric against which MongoDB Cloud checks the configured metricThreshold.threshold.
MongoDB Cloud computes the current metric value as an average.
Comparison operator to apply when checking the current metric value.
Value of metric that, when exceeded, triggers an alert.
Element used to express the quantity. This can be an element of time, storage capacity, and the like.
Slack API token or Bot token that MongoDB Cloud needs to send alert notifications via Slack. The resource requires this parameter when '"notifications.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.
Name of the Slack channel to which MongoDB Cloud sends alert notifications. The resource requires this parameter when '"notifications.typeName" : "SLACK"'.
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.typeName" : "DATADOG"'.
Datadog region that indicates which API Uniform Resource Locator (URL) to use. The resource requires this parameter when '"notifications.typeName" : "DATADOG"'.
Number of minutes that MongoDB Cloud waits after detecting an alert condition before it sends out the first notification.
Email address to which MongoDB Cloud sends alert notifications. The resource requires this parameter when '"notifications.typeName" : "EMAIL"'. You don't need to set this value to send emails to individual or groups of MongoDB Cloud users including:
- specific MongoDB Cloud users ('"notifications.typeName" : "USER"')
- MongoDB Cloud users with specific project roles ('"notifications.typeName" : "GROUP"')
- MongoDB Cloud users with specific organization roles ('"notifications.typeName" : "ORG"')
- MongoDB Cloud teams ('"notifications.typeName" : "TEAM"')
To send emails to one MongoDB Cloud user or grouping of users, set the notifications.emailEnabled parameter.
Flag that indicates whether MongoDB Cloud should send email notifications. The resource requires this parameter when one of the following values have been set:
- '"notifications.typeName" : "ORG"'
- '"notifications.typeName" : "GROUP"'
- '"notifications.typeName" : "USER"'
Flowdock flow name to which MongoDB Cloud sends alert notifications. This name appears after the organization name in the Uniform Resource Locator (URL) path: 'www.flowdock.com/app/
Flowdock API token that MongoDB Cloud needs to send alert notifications to Flowdock. The resource requires this parameter when '"notifications.typeName" : "FLOWDOCK"'. 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.
Number of minutes to wait between successive notifications. MongoDB Cloud sends notifications until someone acknowledges the unacknowledged alert.
PagerDuty, VictorOps, and OpsGenie notifications don't return this element. Configure and manage the notification interval within each of those services.
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.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.
Mobile phone number to which MongoDB Cloud sends alert notifications. The resource requires this parameter when '"notifications.typeName" : "SMS"'.
HipChat API token that MongoDB Cloud needs to send alert notifications to HipChat. The resource requires this parameter when '"notifications.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.
API Key that MongoDB Cloud needs to send this notification via Opsgenie. The resource requires this parameter when '"notifications.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.
Opsgenie region that indicates which API Uniform Resource Locator (URL) to use.
Flowdock organization name to which MongoDB Cloud sends alert notifications. This name appears after 'www.flowdock.com/app/' in the Uniform Resource Locator (URL) path. The resource requires this parameter when '"notifications.typeName" : "FLOWDOCK"'.
List that contains the one or more organization or project roles that receive the configured alert. The resource requires this parameter when '"notifications.typeName" : "GROUP"' or '"notifications.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.
HipChat API room name to which MongoDB Cloud sends alert notifications. The resource requires this parameter when '"notifications.typeName" : "HIP_CHAT"'".
PagerDuty service key that MongoDB Cloud needs to send notifications via PagerDuty. The resource requires this parameter when '"notifications.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.
Degree of seriousness given to this notification.
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:
- '"notifications.typeName" : "ORG"'
- '"notifications.typeName" : "GROUP"'
- '"notifications.typeName" : "USER"'
Unique 24-hexadecimal digit string that identifies one MongoDB Cloud team. The resource requires this parameter when '"notifications.typeName" : "TEAM"'.
Name of the MongoDB Cloud team that receives this notification. The resource requires this parameter when '"notifications.typeName" : "TEAM"'.
Human-readable label that displays the alert notification type.
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.typeName" : "USER"'.
API key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when '"notifications.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.
Routing key that MongoDB Cloud needs to send alert notifications to Splunk On-Call. The resource requires this parameter when '"notifications.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.
An optional field for your webhook secret.
Your webhook URL.
Amount of the metricName recorded at the time of the event. This value triggered the alert.
Element used to express the quantity in currentValue.number. This can be an element of time, storage capacity, and the like. This metric triggered the alert.
Uniform Resource Locator (URL) that points another API resource to which this response has some relationship. This URL often begins with 'https://mms.mongodb.com'.
Uniform Resource Locator (URL) that defines the semantic relationship between this resource and another API resource. This URL often begins with 'https://mms.mongodb.com'.