AlertConfiguration
mongodbatlas.AlertConfiguration
provides an Alert Configuration resource to define the conditions that trigger an alert and the methods of notification within a MongoDB Atlas project.
NOTE: Groups and projects are synonymous terms. You may find
groupId
in the official documentation.
Example Usage
using Pulumi;
using Mongodbatlas = Pulumi.Mongodbatlas;
class MyStack : Stack
{
public MyStack()
{
var test = new Mongodbatlas.AlertConfiguration("test", new Mongodbatlas.AlertConfigurationArgs
{
Enabled = true,
EventType = "OUTSIDE_METRIC_THRESHOLD",
Matchers =
{
new Mongodbatlas.Inputs.AlertConfigurationMatcherArgs
{
FieldName = "HOSTNAME_AND_PORT",
Operator = "EQUALS",
Value = "SECONDARY",
},
},
MetricThreshold = new Mongodbatlas.Inputs.AlertConfigurationMetricThresholdArgs
{
Metric_name = "ASSERT_REGULAR",
Mode = "AVERAGE",
Operator = "LESS_THAN",
Threshold = 99,
Units = "RAW",
},
Notifications =
{
new Mongodbatlas.Inputs.AlertConfigurationNotificationArgs
{
DelayMin = 0,
EmailEnabled = true,
IntervalMin = 5,
Roles =
{
"GROUP_CHARTS_ADMIN",
"GROUP_CLUSTER_MANAGER",
},
SmsEnabled = false,
TypeName = "GROUP",
},
},
ProjectId = "<PROJECT-ID>",
});
}
}
package main
import (
"github.com/pulumi/pulumi-mongodbatlas/sdk/go/mongodbatlas"
"github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := mongodbatlas.NewAlertConfiguration(ctx, "test", &mongodbatlas.AlertConfigurationArgs{
Enabled: pulumi.Bool(true),
EventType: pulumi.String("OUTSIDE_METRIC_THRESHOLD"),
Matchers: mongodbatlas.AlertConfigurationMatcherArray{
&mongodbatlas.AlertConfigurationMatcherArgs{
FieldName: pulumi.String("HOSTNAME_AND_PORT"),
Operator: pulumi.String("EQUALS"),
Value: pulumi.String("SECONDARY"),
},
},
MetricThreshold: &mongodbatlas.AlertConfigurationMetricThresholdArgs{
Metric_name: pulumi.String("ASSERT_REGULAR"),
Mode: pulumi.String("AVERAGE"),
Operator: pulumi.String("LESS_THAN"),
Threshold: pulumi.Float64(99),
Units: pulumi.String("RAW"),
},
Notifications: mongodbatlas.AlertConfigurationNotificationArray{
&mongodbatlas.AlertConfigurationNotificationArgs{
DelayMin: pulumi.Int(0),
EmailEnabled: pulumi.Bool(true),
IntervalMin: pulumi.Int(5),
Roles: pulumi.StringArray{
pulumi.String("GROUP_CHARTS_ADMIN"),
pulumi.String("GROUP_CLUSTER_MANAGER"),
},
SmsEnabled: pulumi.Bool(false),
TypeName: pulumi.String("GROUP"),
},
},
ProjectId: pulumi.String("<PROJECT-ID>"),
})
if err != nil {
return err
}
return nil
})
}
import pulumi
import pulumi_mongodbatlas as mongodbatlas
test = mongodbatlas.AlertConfiguration("test",
enabled=True,
event_type="OUTSIDE_METRIC_THRESHOLD",
matchers=[mongodbatlas.AlertConfigurationMatcherArgs(
field_name="HOSTNAME_AND_PORT",
operator="EQUALS",
value="SECONDARY",
)],
metric_threshold=mongodbatlas.AlertConfigurationMetricThresholdArgs(
metric_name="ASSERT_REGULAR",
mode="AVERAGE",
operator="LESS_THAN",
threshold=99,
units="RAW",
),
notifications=[mongodbatlas.AlertConfigurationNotificationArgs(
delay_min=0,
email_enabled=True,
interval_min=5,
roles=[
"GROUP_CHARTS_ADMIN",
"GROUP_CLUSTER_MANAGER",
],
sms_enabled=False,
type_name="GROUP",
)],
project_id="<PROJECT-ID>")
import * as pulumi from "@pulumi/pulumi";
import * as mongodbatlas from "@pulumi/mongodbatlas";
const test = new mongodbatlas.AlertConfiguration("test", {
enabled: true,
eventType: "OUTSIDE_METRIC_THRESHOLD",
matchers: [{
fieldName: "HOSTNAME_AND_PORT",
operator: "EQUALS",
value: "SECONDARY",
}],
metricThreshold: {
metric_name: "ASSERT_REGULAR",
mode: "AVERAGE",
operator: "LESS_THAN",
threshold: 99,
units: "RAW",
},
notifications: [{
delayMin: 0,
emailEnabled: true,
intervalMin: 5,
roles: [
"GROUP_CHARTS_ADMIN",
"GROUP_CLUSTER_MANAGER",
],
smsEnabled: false,
typeName: "GROUP",
}],
projectId: "<PROJECT-ID>",
});
Create a AlertConfiguration Resource
new AlertConfiguration(name: string, args: AlertConfigurationArgs, opts?: CustomResourceOptions);
def AlertConfiguration(resource_name: str, opts: Optional[ResourceOptions] = None, enabled: Optional[bool] = None, event_type: Optional[str] = None, matchers: Optional[Sequence[AlertConfigurationMatcherArgs]] = None, metric_threshold: Optional[AlertConfigurationMetricThresholdArgs] = None, notifications: Optional[Sequence[AlertConfigurationNotificationArgs]] = None, project_id: Optional[str] = None, threshold: Optional[AlertConfigurationThresholdArgs] = None)
func NewAlertConfiguration(ctx *Context, name string, args AlertConfigurationArgs, opts ...ResourceOption) (*AlertConfiguration, error)
public AlertConfiguration(string name, AlertConfigurationArgs args, CustomResourceOptions? opts = null)
- name string
- The unique name of the resource.
- args AlertConfigurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AlertConfigurationArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AlertConfigurationArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
AlertConfiguration Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The AlertConfiguration resource accepts the following input properties:
- Event
Type string The type of event that will trigger an alert.
- Notifications
List<Alert
Configuration Notification Args> - Project
Id string The ID of the project where the alert configuration will create.
- Enabled bool
It is not required, but If the attribute is omitted, by default will be false, and the configuration would be disabled. You must set true to enable the configuration.
- Matchers
List<Alert
Configuration Matcher Args> - Metric
Threshold AlertConfiguration Metric Threshold Args - Threshold
Alert
Configuration Threshold Args Threshold value outside of which an alert will be triggered.
- Event
Type string The type of event that will trigger an alert.
- Notifications
[]Alert
Configuration Notification - Project
Id string The ID of the project where the alert configuration will create.
- Enabled bool
It is not required, but If the attribute is omitted, by default will be false, and the configuration would be disabled. You must set true to enable the configuration.
- Matchers
[]Alert
Configuration Matcher - Metric
Threshold AlertConfiguration Metric Threshold - Threshold
Alert
Configuration Threshold Threshold value outside of which an alert will be triggered.
- event
Type string The type of event that will trigger an alert.
- notifications
Alert
Configuration Notification[] - project
Id string The ID of the project where the alert configuration will create.
- enabled boolean
It is not required, but If the attribute is omitted, by default will be false, and the configuration would be disabled. You must set true to enable the configuration.
- matchers
Alert
Configuration Matcher[] - metric
Threshold AlertConfiguration Metric Threshold - threshold
Alert
Configuration Threshold Threshold value outside of which an alert will be triggered.
- event_
type str The type of event that will trigger an alert.
- notifications
Sequence[Alert
Configuration Notification Args] - project_
id str The ID of the project where the alert configuration will create.
- enabled bool
It is not required, but If the attribute is omitted, by default will be false, and the configuration would be disabled. You must set true to enable the configuration.
- matchers
Sequence[Alert
Configuration Matcher Args] - metric_
threshold AlertConfiguration Metric Threshold Args - threshold
Alert
Configuration Threshold Args Threshold value outside of which an alert will be triggered.
Outputs
All input properties are implicitly available as output properties. Additionally, the AlertConfiguration resource produces the following output properties:
- Alert
Configuration stringId Unique identifier for the alert configuration.
- Created string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Updated string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
- Alert
Configuration stringId Unique identifier for the alert configuration.
- Created string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Updated string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
- alert
Configuration stringId Unique identifier for the alert configuration.
- created string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created.
- id string
- The provider-assigned unique ID for this managed resource.
- updated string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
- alert_
configuration_ strid Unique identifier for the alert configuration.
- created str
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created.
- id str
- The provider-assigned unique ID for this managed resource.
- updated str
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
Look up an Existing AlertConfiguration Resource
Get an existing AlertConfiguration resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AlertConfigurationState, opts?: CustomResourceOptions): AlertConfiguration
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, alert_configuration_id: Optional[str] = None, created: Optional[str] = None, enabled: Optional[bool] = None, event_type: Optional[str] = None, matchers: Optional[Sequence[AlertConfigurationMatcherArgs]] = None, metric_threshold: Optional[AlertConfigurationMetricThresholdArgs] = None, notifications: Optional[Sequence[AlertConfigurationNotificationArgs]] = None, project_id: Optional[str] = None, threshold: Optional[AlertConfigurationThresholdArgs] = None, updated: Optional[str] = None) -> AlertConfiguration
func GetAlertConfiguration(ctx *Context, name string, id IDInput, state *AlertConfigurationState, opts ...ResourceOption) (*AlertConfiguration, error)
public static AlertConfiguration Get(string name, Input<string> id, AlertConfigurationState? state, CustomResourceOptions? opts = null)
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
The following state arguments are supported:
- Alert
Configuration stringId Unique identifier for the alert configuration.
- Created string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created.
- Enabled bool
It is not required, but If the attribute is omitted, by default will be false, and the configuration would be disabled. You must set true to enable the configuration.
- Event
Type string The type of event that will trigger an alert.
- Matchers
List<Alert
Configuration Matcher Args> - Metric
Threshold AlertConfiguration Metric Threshold Args - Notifications
List<Alert
Configuration Notification Args> - Project
Id string The ID of the project where the alert configuration will create.
- Threshold
Alert
Configuration Threshold Args Threshold value outside of which an alert will be triggered.
- Updated string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
- Alert
Configuration stringId Unique identifier for the alert configuration.
- Created string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created.
- Enabled bool
It is not required, but If the attribute is omitted, by default will be false, and the configuration would be disabled. You must set true to enable the configuration.
- Event
Type string The type of event that will trigger an alert.
- Matchers
[]Alert
Configuration Matcher - Metric
Threshold AlertConfiguration Metric Threshold - Notifications
[]Alert
Configuration Notification - Project
Id string The ID of the project where the alert configuration will create.
- Threshold
Alert
Configuration Threshold Threshold value outside of which an alert will be triggered.
- Updated string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
- alert
Configuration stringId Unique identifier for the alert configuration.
- created string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created.
- enabled boolean
It is not required, but If the attribute is omitted, by default will be false, and the configuration would be disabled. You must set true to enable the configuration.
- event
Type string The type of event that will trigger an alert.
- matchers
Alert
Configuration Matcher[] - metric
Threshold AlertConfiguration Metric Threshold - notifications
Alert
Configuration Notification[] - project
Id string The ID of the project where the alert configuration will create.
- threshold
Alert
Configuration Threshold Threshold value outside of which an alert will be triggered.
- updated string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
- alert_
configuration_ strid Unique identifier for the alert configuration.
- created str
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created.
- enabled bool
It is not required, but If the attribute is omitted, by default will be false, and the configuration would be disabled. You must set true to enable the configuration.
- event_
type str The type of event that will trigger an alert.
- matchers
Sequence[Alert
Configuration Matcher Args] - metric_
threshold AlertConfiguration Metric Threshold Args - notifications
Sequence[Alert
Configuration Notification Args] - project_
id str The ID of the project where the alert configuration will create.
- threshold
Alert
Configuration Threshold Args Threshold value outside of which an alert will be triggered.
- updated str
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
Supporting Types
AlertConfigurationMatcher
- Field
Name string Name of the field in the target object to match on.
- Operator string
Operator to apply when checking the current metric value against the threshold value. Accepted values are: -
GREATER_THAN
-LESS_THAN
- Value string
Value to test with the specified operator. If
field_name
is set to TYPE_NAME, you can match on the following values: -PRIMARY
-SECONDARY
-STANDALONE
-CONFIG
-MONGOS
- Field
Name string Name of the field in the target object to match on.
- Operator string
Operator to apply when checking the current metric value against the threshold value. Accepted values are: -
GREATER_THAN
-LESS_THAN
- Value string
Value to test with the specified operator. If
field_name
is set to TYPE_NAME, you can match on the following values: -PRIMARY
-SECONDARY
-STANDALONE
-CONFIG
-MONGOS
- field
Name string Name of the field in the target object to match on.
- operator string
Operator to apply when checking the current metric value against the threshold value. Accepted values are: -
GREATER_THAN
-LESS_THAN
- value string
Value to test with the specified operator. If
field_name
is set to TYPE_NAME, you can match on the following values: -PRIMARY
-SECONDARY
-STANDALONE
-CONFIG
-MONGOS
- field_
name str Name of the field in the target object to match on.
- operator str
Operator to apply when checking the current metric value against the threshold value. Accepted values are: -
GREATER_THAN
-LESS_THAN
- value str
Value to test with the specified operator. If
field_name
is set to TYPE_NAME, you can match on the following values: -PRIMARY
-SECONDARY
-STANDALONE
-CONFIG
-MONGOS
AlertConfigurationMetricThreshold
- Metric
Name string Name of the metric to check. The full list of current options is available here
- Mode string
This must be set to AVERAGE. Atlas computes the current metric value as an average.
- Operator string
Operator to apply when checking the current metric value against the threshold value. Accepted values are: -
GREATER_THAN
-LESS_THAN
- Threshold double
Threshold value outside of which an alert will be triggered.
- Units string
The units for the threshold value. Depends on the type of metric. Accepted values are: -
RAW
-BITS
-BYTES
-KILOBITS
-KILOBYTES
-MEGABITS
-MEGABYTES
-GIGABITS
-GIGABYTES
-TERABYTES
-PETABYTES
-MILLISECONDS
-SECONDS
-MINUTES
-HOURS
-DAYS
- Metric
Name string Name of the metric to check. The full list of current options is available here
- Mode string
This must be set to AVERAGE. Atlas computes the current metric value as an average.
- Operator string
Operator to apply when checking the current metric value against the threshold value. Accepted values are: -
GREATER_THAN
-LESS_THAN
- Threshold float64
Threshold value outside of which an alert will be triggered.
- Units string
The units for the threshold value. Depends on the type of metric. Accepted values are: -
RAW
-BITS
-BYTES
-KILOBITS
-KILOBYTES
-MEGABITS
-MEGABYTES
-GIGABITS
-GIGABYTES
-TERABYTES
-PETABYTES
-MILLISECONDS
-SECONDS
-MINUTES
-HOURS
-DAYS
- metric
Name string Name of the metric to check. The full list of current options is available here
- mode string
This must be set to AVERAGE. Atlas computes the current metric value as an average.
- operator string
Operator to apply when checking the current metric value against the threshold value. Accepted values are: -
GREATER_THAN
-LESS_THAN
- threshold number
Threshold value outside of which an alert will be triggered.
- units string
The units for the threshold value. Depends on the type of metric. Accepted values are: -
RAW
-BITS
-BYTES
-KILOBITS
-KILOBYTES
-MEGABITS
-MEGABYTES
-GIGABITS
-GIGABYTES
-TERABYTES
-PETABYTES
-MILLISECONDS
-SECONDS
-MINUTES
-HOURS
-DAYS
- metric_
name str Name of the metric to check. The full list of current options is available here
- mode str
This must be set to AVERAGE. Atlas computes the current metric value as an average.
- operator str
Operator to apply when checking the current metric value against the threshold value. Accepted values are: -
GREATER_THAN
-LESS_THAN
- threshold float
Threshold value outside of which an alert will be triggered.
- units str
The units for the threshold value. Depends on the type of metric. Accepted values are: -
RAW
-BITS
-BYTES
-KILOBITS
-KILOBYTES
-MEGABITS
-MEGABYTES
-GIGABITS
-GIGABYTES
-TERABYTES
-PETABYTES
-MILLISECONDS
-SECONDS
-MINUTES
-HOURS
-DAYS
AlertConfigurationNotification
- Api
Token string Slack API token. Required for the SLACK notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.
- Channel
Name string Slack channel name. Required for the SLACK notifications type.
- Datadog
Api stringKey Datadog API Key. Found in the Datadog dashboard. Required for the DATADOG notifications type.
- Datadog
Region string Region that indicates which API URL to use. Accepted regions are:
US
,EU
. The default Datadog region is US.- Delay
Min int Number of minutes to wait after an alert condition is detected before sending out the first notification.
- Email
Address string Email address to which alert notifications are sent. Required for the EMAIL notifications type.
- Email
Enabled bool Flag indicating if email notifications should be sent. Configurable for
ORG
,GROUP
, andUSER
notifications types.- Flow
Name string Flowdock flow name in lower-case letters. Required for the
FLOWDOCK
notifications type- Flowdock
Api stringToken The Flowdock personal API token. Required for the
FLOWDOCK
notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.- Interval
Min int Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.
- Mobile
Number string Mobile number to which alert notifications are sent. Required for the SMS notifications type.
- Ops
Genie stringApi Key Opsgenie API Key. Required for the
OPS_GENIE
notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.- Ops
Genie stringRegion Region that indicates which API URL to use. Accepted regions are:
US
,EU
. The default Opsgenie region is US.- Org
Name string Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the URL string. Required for the FLOWDOCK notifications type.
- Roles List<string>
- Service
Key string PagerDuty service key. Required for the PAGER_DUTY notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
- Sms
Enabled bool Flag indicating if text message notifications should be sent. Configurable for
ORG
,GROUP
, andUSER
notifications types.- Team
Id string Unique identifier of a team.
- Type
Name string Type of alert notification. Accepted values are: -
DATADOG
-EMAIL
-FLOWDOCK
- Username string
Name of the Atlas user to which to send notifications. Only a user in the project that owns the alert configuration is allowed here. Required for the
USER
notifications type.- Victor
Ops stringApi Key VictorOps API key. Required for the
VICTOR_OPS
notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.- Victor
Ops stringRouting Key VictorOps routing key. Optional for the
VICTOR_OPS
notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
- Api
Token string Slack API token. Required for the SLACK notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.
- Channel
Name string Slack channel name. Required for the SLACK notifications type.
- Datadog
Api stringKey Datadog API Key. Found in the Datadog dashboard. Required for the DATADOG notifications type.
- Datadog
Region string Region that indicates which API URL to use. Accepted regions are:
US
,EU
. The default Datadog region is US.- Delay
Min int Number of minutes to wait after an alert condition is detected before sending out the first notification.
- Email
Address string Email address to which alert notifications are sent. Required for the EMAIL notifications type.
- Email
Enabled bool Flag indicating if email notifications should be sent. Configurable for
ORG
,GROUP
, andUSER
notifications types.- Flow
Name string Flowdock flow name in lower-case letters. Required for the
FLOWDOCK
notifications type- Flowdock
Api stringToken The Flowdock personal API token. Required for the
FLOWDOCK
notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.- Interval
Min int Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.
- Mobile
Number string Mobile number to which alert notifications are sent. Required for the SMS notifications type.
- Ops
Genie stringApi Key Opsgenie API Key. Required for the
OPS_GENIE
notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.- Ops
Genie stringRegion Region that indicates which API URL to use. Accepted regions are:
US
,EU
. The default Opsgenie region is US.- Org
Name string Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the URL string. Required for the FLOWDOCK notifications type.
- Roles []string
- Service
Key string PagerDuty service key. Required for the PAGER_DUTY notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
- Sms
Enabled bool Flag indicating if text message notifications should be sent. Configurable for
ORG
,GROUP
, andUSER
notifications types.- Team
Id string Unique identifier of a team.
- Type
Name string Type of alert notification. Accepted values are: -
DATADOG
-EMAIL
-FLOWDOCK
- Username string
Name of the Atlas user to which to send notifications. Only a user in the project that owns the alert configuration is allowed here. Required for the
USER
notifications type.- Victor
Ops stringApi Key VictorOps API key. Required for the
VICTOR_OPS
notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.- Victor
Ops stringRouting Key VictorOps routing key. Optional for the
VICTOR_OPS
notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
- api
Token string Slack API token. Required for the SLACK notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.
- channel
Name string Slack channel name. Required for the SLACK notifications type.
- datadog
Api stringKey Datadog API Key. Found in the Datadog dashboard. Required for the DATADOG notifications type.
- datadog
Region string Region that indicates which API URL to use. Accepted regions are:
US
,EU
. The default Datadog region is US.- delay
Min number Number of minutes to wait after an alert condition is detected before sending out the first notification.
- email
Address string Email address to which alert notifications are sent. Required for the EMAIL notifications type.
- email
Enabled boolean Flag indicating if email notifications should be sent. Configurable for
ORG
,GROUP
, andUSER
notifications types.- flow
Name string Flowdock flow name in lower-case letters. Required for the
FLOWDOCK
notifications type- flowdock
Api stringToken The Flowdock personal API token. Required for the
FLOWDOCK
notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.- interval
Min number Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.
- mobile
Number string Mobile number to which alert notifications are sent. Required for the SMS notifications type.
- ops
Genie stringApi Key Opsgenie API Key. Required for the
OPS_GENIE
notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.- ops
Genie stringRegion Region that indicates which API URL to use. Accepted regions are:
US
,EU
. The default Opsgenie region is US.- org
Name string Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the URL string. Required for the FLOWDOCK notifications type.
- roles string[]
- service
Key string PagerDuty service key. Required for the PAGER_DUTY notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
- sms
Enabled boolean Flag indicating if text message notifications should be sent. Configurable for
ORG
,GROUP
, andUSER
notifications types.- team
Id string Unique identifier of a team.
- type
Name string Type of alert notification. Accepted values are: -
DATADOG
-EMAIL
-FLOWDOCK
- username string
Name of the Atlas user to which to send notifications. Only a user in the project that owns the alert configuration is allowed here. Required for the
USER
notifications type.- victor
Ops stringApi Key VictorOps API key. Required for the
VICTOR_OPS
notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.- victor
Ops stringRouting Key VictorOps routing key. Optional for the
VICTOR_OPS
notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
- api_
token str Slack API token. Required for the SLACK notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.
- channel_
name str Slack channel name. Required for the SLACK notifications type.
- datadog_
api_ strkey Datadog API Key. Found in the Datadog dashboard. Required for the DATADOG notifications type.
- datadog_
region str Region that indicates which API URL to use. Accepted regions are:
US
,EU
. The default Datadog region is US.- delay_
min int Number of minutes to wait after an alert condition is detected before sending out the first notification.
- email_
address str Email address to which alert notifications are sent. Required for the EMAIL notifications type.
- email_
enabled bool Flag indicating if email notifications should be sent. Configurable for
ORG
,GROUP
, andUSER
notifications types.- flow_
name str Flowdock flow name in lower-case letters. Required for the
FLOWDOCK
notifications type- flowdock_
api_ strtoken The Flowdock personal API token. Required for the
FLOWDOCK
notifications type. If the token later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.- interval_
min int Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.
- mobile_
number str Mobile number to which alert notifications are sent. Required for the SMS notifications type.
- ops_
genie_ strapi_ key Opsgenie API Key. Required for the
OPS_GENIE
notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the token.- ops_
genie_ strregion Region that indicates which API URL to use. Accepted regions are:
US
,EU
. The default Opsgenie region is US.- org_
name str Flowdock organization name in lower-case letters. This is the name that appears after www.flowdock.com/app/ in the URL string. Required for the FLOWDOCK notifications type.
- roles Sequence[str]
- service_
key str PagerDuty service key. Required for the PAGER_DUTY notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
- sms_
enabled bool Flag indicating if text message notifications should be sent. Configurable for
ORG
,GROUP
, andUSER
notifications types.- team_
id str Unique identifier of a team.
- type_
name str Type of alert notification. Accepted values are: -
DATADOG
-EMAIL
-FLOWDOCK
- username str
Name of the Atlas user to which to send notifications. Only a user in the project that owns the alert configuration is allowed here. Required for the
USER
notifications type.- victor_
ops_ strapi_ key VictorOps API key. Required for the
VICTOR_OPS
notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.- victor_
ops_ strrouting_ key VictorOps routing key. Optional for the
VICTOR_OPS
notifications type. If the key later becomes invalid, Atlas sends an email to the project owner and eventually removes the key.
AlertConfigurationThreshold
- Operator string
Operator to apply when checking the current metric value against the threshold value. Accepted values are: -
GREATER_THAN
-LESS_THAN
- Threshold double
Threshold value outside of which an alert will be triggered.
- Units string
The units for the threshold value. Depends on the type of metric. Accepted values are: -
RAW
-BITS
-BYTES
-KILOBITS
-KILOBYTES
-MEGABITS
-MEGABYTES
-GIGABITS
-GIGABYTES
-TERABYTES
-PETABYTES
-MILLISECONDS
-SECONDS
-MINUTES
-HOURS
-DAYS
- Operator string
Operator to apply when checking the current metric value against the threshold value. Accepted values are: -
GREATER_THAN
-LESS_THAN
- Threshold float64
Threshold value outside of which an alert will be triggered.
- Units string
The units for the threshold value. Depends on the type of metric. Accepted values are: -
RAW
-BITS
-BYTES
-KILOBITS
-KILOBYTES
-MEGABITS
-MEGABYTES
-GIGABITS
-GIGABYTES
-TERABYTES
-PETABYTES
-MILLISECONDS
-SECONDS
-MINUTES
-HOURS
-DAYS
- operator string
Operator to apply when checking the current metric value against the threshold value. Accepted values are: -
GREATER_THAN
-LESS_THAN
- threshold number
Threshold value outside of which an alert will be triggered.
- units string
The units for the threshold value. Depends on the type of metric. Accepted values are: -
RAW
-BITS
-BYTES
-KILOBITS
-KILOBYTES
-MEGABITS
-MEGABYTES
-GIGABITS
-GIGABYTES
-TERABYTES
-PETABYTES
-MILLISECONDS
-SECONDS
-MINUTES
-HOURS
-DAYS
- operator str
Operator to apply when checking the current metric value against the threshold value. Accepted values are: -
GREATER_THAN
-LESS_THAN
- threshold float
Threshold value outside of which an alert will be triggered.
- units str
The units for the threshold value. Depends on the type of metric. Accepted values are: -
RAW
-BITS
-BYTES
-KILOBITS
-KILOBYTES
-MEGABITS
-MEGABYTES
-GIGABITS
-GIGABYTES
-TERABYTES
-PETABYTES
-MILLISECONDS
-SECONDS
-MINUTES
-HOURS
-DAYS
Import
Alert Configuration can be imported using the project_id-alert_configuration_id
, e.g.
$ pulumi import mongodbatlas:index/alertConfiguration:AlertConfiguration test 5d0f1f74cf09a29120e123cd-5d0f1f74cf09a29120e1fscg
For more information seeMongoDB Atlas API Reference.
Package Details
- Repository
- https://github.com/pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
mongodbatlas
Terraform Provider.