1. Docs
  2. Reference
  3. API
  4. mongodbatlas
  5. AlertConfiguration

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>",
        });
    }

}

Coming soon!

import pulumi
import pulumi_mongodbatlas as mongodbatlas

test = mongodbatlas.AlertConfiguration("test",
    enabled=True,
    event_type="OUTSIDE_METRIC_THRESHOLD",
    matchers=[{
        "fieldName": "HOSTNAME_AND_PORT",
        "operator": "EQUALS",
        "value": "SECONDARY",
    }],
    metric_threshold={
        "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",
    }],
    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, opts=None, enabled=None, event_type=None, matchers=None, metric_threshold=None, notifications=None, project_id=None, __props__=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:

EventType string

The type of event that will trigger an alert. Alert type Possible values: * Host - OUTSIDE_METRIC_THRESHOLD - HOST_RESTARTED - HOST_UPGRADED - HOST_NOW_SECONDARY - HOST_NOW_PRIMARY * Replica set - NO_PRIMARY - TOO_MANY_ELECTIONS * Sharded cluster - CLUSTER_MONGOS_IS_MISSING - User - JOINED_GROUP - REMOVED_FROM_GROUP - USER_ROLES_CHANGED_AUDIT * Project - USERS_AWAITING_APPROVAL - USERS_WITHOUT_MULTI_FACTOR_AUTH - GROUP_CREATED * Team - JOINED_TEAM - REMOVED_FROM_TEAM * Organization - INVITED_TO_ORG - JOINED_ORG * Data Explorer - DATA_EXPLORER - DATA_EXPLORER_CRUD * Billing - CREDIT_CARD_ABOUT_TO_EXPIRE - CHARGE_SUCCEEDED - INVOICE_CLOSED

Notifications List<AlertConfigurationNotificationArgs>
ProjectId 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<AlertConfigurationMatcherArgs>
MetricThreshold AlertConfigurationMetricThresholdArgs
EventType string

The type of event that will trigger an alert. Alert type Possible values: * Host - OUTSIDE_METRIC_THRESHOLD - HOST_RESTARTED - HOST_UPGRADED - HOST_NOW_SECONDARY - HOST_NOW_PRIMARY * Replica set - NO_PRIMARY - TOO_MANY_ELECTIONS * Sharded cluster - CLUSTER_MONGOS_IS_MISSING - User - JOINED_GROUP - REMOVED_FROM_GROUP - USER_ROLES_CHANGED_AUDIT * Project - USERS_AWAITING_APPROVAL - USERS_WITHOUT_MULTI_FACTOR_AUTH - GROUP_CREATED * Team - JOINED_TEAM - REMOVED_FROM_TEAM * Organization - INVITED_TO_ORG - JOINED_ORG * Data Explorer - DATA_EXPLORER - DATA_EXPLORER_CRUD * Billing - CREDIT_CARD_ABOUT_TO_EXPIRE - CHARGE_SUCCEEDED - INVOICE_CLOSED

Notifications []AlertConfigurationNotification
ProjectId 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 []AlertConfigurationMatcher
MetricThreshold AlertConfigurationMetricThreshold
eventType string

The type of event that will trigger an alert. Alert type Possible values: * Host - OUTSIDE_METRIC_THRESHOLD - HOST_RESTARTED - HOST_UPGRADED - HOST_NOW_SECONDARY - HOST_NOW_PRIMARY * Replica set - NO_PRIMARY - TOO_MANY_ELECTIONS * Sharded cluster - CLUSTER_MONGOS_IS_MISSING - User - JOINED_GROUP - REMOVED_FROM_GROUP - USER_ROLES_CHANGED_AUDIT * Project - USERS_AWAITING_APPROVAL - USERS_WITHOUT_MULTI_FACTOR_AUTH - GROUP_CREATED * Team - JOINED_TEAM - REMOVED_FROM_TEAM * Organization - INVITED_TO_ORG - JOINED_ORG * Data Explorer - DATA_EXPLORER - DATA_EXPLORER_CRUD * Billing - CREDIT_CARD_ABOUT_TO_EXPIRE - CHARGE_SUCCEEDED - INVOICE_CLOSED

notifications AlertConfigurationNotification[]
projectId 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 AlertConfigurationMatcher[]
metricThreshold AlertConfigurationMetricThreshold
event_type str

The type of event that will trigger an alert. Alert type Possible values: * Host - OUTSIDE_METRIC_THRESHOLD - HOST_RESTARTED - HOST_UPGRADED - HOST_NOW_SECONDARY - HOST_NOW_PRIMARY * Replica set - NO_PRIMARY - TOO_MANY_ELECTIONS * Sharded cluster - CLUSTER_MONGOS_IS_MISSING - User - JOINED_GROUP - REMOVED_FROM_GROUP - USER_ROLES_CHANGED_AUDIT * Project - USERS_AWAITING_APPROVAL - USERS_WITHOUT_MULTI_FACTOR_AUTH - GROUP_CREATED * Team - JOINED_TEAM - REMOVED_FROM_TEAM * Organization - INVITED_TO_ORG - JOINED_ORG * Data Explorer - DATA_EXPLORER - DATA_EXPLORER_CRUD * Billing - CREDIT_CARD_ABOUT_TO_EXPIRE - CHARGE_SUCCEEDED - INVOICE_CLOSED

notifications List[AlertConfigurationNotification]
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 List[AlertConfigurationMatcher]
metric_threshold Dict[AlertConfigurationMetricThreshold]

Outputs

All input properties are implicitly available as output properties. Additionally, the AlertConfiguration resource produces the following output properties:

AlertConfigurationId string

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.

AlertConfigurationId string

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.

alertConfigurationId string

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_id str

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
static get(resource_name, id, opts=None, alert_configuration_id=None, created=None, enabled=None, event_type=None, matchers=None, metric_threshold=None, notifications=None, project_id=None, updated=None, __props__=None);
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:

AlertConfigurationId string

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.

EventType string

The type of event that will trigger an alert. Alert type Possible values: * Host - OUTSIDE_METRIC_THRESHOLD - HOST_RESTARTED - HOST_UPGRADED - HOST_NOW_SECONDARY - HOST_NOW_PRIMARY * Replica set - NO_PRIMARY - TOO_MANY_ELECTIONS * Sharded cluster - CLUSTER_MONGOS_IS_MISSING - User - JOINED_GROUP - REMOVED_FROM_GROUP - USER_ROLES_CHANGED_AUDIT * Project - USERS_AWAITING_APPROVAL - USERS_WITHOUT_MULTI_FACTOR_AUTH - GROUP_CREATED * Team - JOINED_TEAM - REMOVED_FROM_TEAM * Organization - INVITED_TO_ORG - JOINED_ORG * Data Explorer - DATA_EXPLORER - DATA_EXPLORER_CRUD * Billing - CREDIT_CARD_ABOUT_TO_EXPIRE - CHARGE_SUCCEEDED - INVOICE_CLOSED

Matchers List<AlertConfigurationMatcherArgs>
MetricThreshold AlertConfigurationMetricThresholdArgs
Notifications List<AlertConfigurationNotificationArgs>
ProjectId string

The ID of the project where the alert configuration will create.

Updated string

Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.

AlertConfigurationId string

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.

EventType string

The type of event that will trigger an alert. Alert type Possible values: * Host - OUTSIDE_METRIC_THRESHOLD - HOST_RESTARTED - HOST_UPGRADED - HOST_NOW_SECONDARY - HOST_NOW_PRIMARY * Replica set - NO_PRIMARY - TOO_MANY_ELECTIONS * Sharded cluster - CLUSTER_MONGOS_IS_MISSING - User - JOINED_GROUP - REMOVED_FROM_GROUP - USER_ROLES_CHANGED_AUDIT * Project - USERS_AWAITING_APPROVAL - USERS_WITHOUT_MULTI_FACTOR_AUTH - GROUP_CREATED * Team - JOINED_TEAM - REMOVED_FROM_TEAM * Organization - INVITED_TO_ORG - JOINED_ORG * Data Explorer - DATA_EXPLORER - DATA_EXPLORER_CRUD * Billing - CREDIT_CARD_ABOUT_TO_EXPIRE - CHARGE_SUCCEEDED - INVOICE_CLOSED

Matchers []AlertConfigurationMatcher
MetricThreshold AlertConfigurationMetricThreshold
Notifications []AlertConfigurationNotification
ProjectId string

The ID of the project where the alert configuration will create.

Updated string

Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.

alertConfigurationId string

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.

eventType string

The type of event that will trigger an alert. Alert type Possible values: * Host - OUTSIDE_METRIC_THRESHOLD - HOST_RESTARTED - HOST_UPGRADED - HOST_NOW_SECONDARY - HOST_NOW_PRIMARY * Replica set - NO_PRIMARY - TOO_MANY_ELECTIONS * Sharded cluster - CLUSTER_MONGOS_IS_MISSING - User - JOINED_GROUP - REMOVED_FROM_GROUP - USER_ROLES_CHANGED_AUDIT * Project - USERS_AWAITING_APPROVAL - USERS_WITHOUT_MULTI_FACTOR_AUTH - GROUP_CREATED * Team - JOINED_TEAM - REMOVED_FROM_TEAM * Organization - INVITED_TO_ORG - JOINED_ORG * Data Explorer - DATA_EXPLORER - DATA_EXPLORER_CRUD * Billing - CREDIT_CARD_ABOUT_TO_EXPIRE - CHARGE_SUCCEEDED - INVOICE_CLOSED

matchers AlertConfigurationMatcher[]
metricThreshold AlertConfigurationMetricThreshold
notifications AlertConfigurationNotification[]
projectId string

The ID of the project where the alert configuration will create.

updated string

Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.

alert_configuration_id str

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. Alert type Possible values: * Host - OUTSIDE_METRIC_THRESHOLD - HOST_RESTARTED - HOST_UPGRADED - HOST_NOW_SECONDARY - HOST_NOW_PRIMARY * Replica set - NO_PRIMARY - TOO_MANY_ELECTIONS * Sharded cluster - CLUSTER_MONGOS_IS_MISSING - User - JOINED_GROUP - REMOVED_FROM_GROUP - USER_ROLES_CHANGED_AUDIT * Project - USERS_AWAITING_APPROVAL - USERS_WITHOUT_MULTI_FACTOR_AUTH - GROUP_CREATED * Team - JOINED_TEAM - REMOVED_FROM_TEAM * Organization - INVITED_TO_ORG - JOINED_ORG * Data Explorer - DATA_EXPLORER - DATA_EXPLORER_CRUD * Billing - CREDIT_CARD_ABOUT_TO_EXPIRE - CHARGE_SUCCEEDED - INVOICE_CLOSED

matchers List[AlertConfigurationMatcher]
metric_threshold Dict[AlertConfigurationMetricThreshold]
notifications List[AlertConfigurationNotification]
project_id str

The ID of the project where the alert configuration will create.

updated str

Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.

Supporting Types

AlertConfigurationMatcher

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

FieldName string

Name of the field in the target object to match on. Host alerts support these fields: - TYPE_NAME - HOSTNAME - PORT - HOSTNAME_AND_PORT - REPLICA_SET_NAME Replica set alerts support these fields: - REPLICA_SET_NAME - SHARD_NAME - CLUSTER_NAME Sharded cluster alerts support these fields: - CLUSTER_NAME - SHARD_NAME

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

FieldName string

Name of the field in the target object to match on. Host alerts support these fields: - TYPE_NAME - HOSTNAME - PORT - HOSTNAME_AND_PORT - REPLICA_SET_NAME Replica set alerts support these fields: - REPLICA_SET_NAME - SHARD_NAME - CLUSTER_NAME Sharded cluster alerts support these fields: - CLUSTER_NAME - SHARD_NAME

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

fieldName string

Name of the field in the target object to match on. Host alerts support these fields: - TYPE_NAME - HOSTNAME - PORT - HOSTNAME_AND_PORT - REPLICA_SET_NAME Replica set alerts support these fields: - REPLICA_SET_NAME - SHARD_NAME - CLUSTER_NAME Sharded cluster alerts support these fields: - CLUSTER_NAME - SHARD_NAME

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

fieldName str

Name of the field in the target object to match on. Host alerts support these fields: - TYPE_NAME - HOSTNAME - PORT - HOSTNAME_AND_PORT - REPLICA_SET_NAME Replica set alerts support these fields: - REPLICA_SET_NAME - SHARD_NAME - CLUSTER_NAME Sharded cluster alerts support these fields: - CLUSTER_NAME - SHARD_NAME

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

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

MetricName string

Name of the metric to check.

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

MetricName string

Name of the metric to check.

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

metricName string

Name of the metric to check.

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.

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

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

ApiToken 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.

ChannelName string

Slack channel name. Required for the SLACK notifications type.

DatadogApiKey string

Datadog API Key. Found in the Datadog dashboard. Required for the DATADOG notifications type.

DatadogRegion string

Region that indicates which API URL to use. Accepted regions are: US, EU. The default Datadog region is US.

DelayMin int

Number of minutes to wait after an alert condition is detected before sending out the first notification.

EmailAddress string

Email address to which alert notifications are sent. Required for the EMAIL notifications type.

EmailEnabled bool

Flag indicating if email notifications should be sent. Configurable for ORG, GROUP, and USER notifications types.

FlowName string

Flowdock flow name in lower-case letters. Required for the FLOWDOCK notifications type

FlowdockApiToken string

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.

IntervalMin int

Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.

MobileNumber string

Mobile number to which alert notifications are sent. Required for the SMS notifications type.

OpsGenieApiKey string

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.

OpsGenieRegion string

Region that indicates which API URL to use. Accepted regions are: US ,EU. The default Opsgenie region is US.

OrgName 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>
ServiceKey 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.

SmsEnabled bool

Flag indicating if text message notifications should be sent. Configurable for ORG, GROUP, and USER notifications types.

TeamId string

Unique identifier of a team.

TypeName string

Type of alert notification. Accepted values are: - DATADOG - EMAIL - FLOWDOCK - GROUP (Project) - OPS_GENIE - ORG - PAGER_DUTY - SLACK - SMS - TEAM - USER - VICTOR_OPS - WEBHOOK

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.

VictorOpsApiKey string

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.

VictorOpsRoutingKey string

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.

ApiToken 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.

ChannelName string

Slack channel name. Required for the SLACK notifications type.

DatadogApiKey string

Datadog API Key. Found in the Datadog dashboard. Required for the DATADOG notifications type.

DatadogRegion string

Region that indicates which API URL to use. Accepted regions are: US, EU. The default Datadog region is US.

DelayMin int

Number of minutes to wait after an alert condition is detected before sending out the first notification.

EmailAddress string

Email address to which alert notifications are sent. Required for the EMAIL notifications type.

EmailEnabled bool

Flag indicating if email notifications should be sent. Configurable for ORG, GROUP, and USER notifications types.

FlowName string

Flowdock flow name in lower-case letters. Required for the FLOWDOCK notifications type

FlowdockApiToken string

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.

IntervalMin int

Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.

MobileNumber string

Mobile number to which alert notifications are sent. Required for the SMS notifications type.

OpsGenieApiKey string

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.

OpsGenieRegion string

Region that indicates which API URL to use. Accepted regions are: US ,EU. The default Opsgenie region is US.

OrgName 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
ServiceKey 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.

SmsEnabled bool

Flag indicating if text message notifications should be sent. Configurable for ORG, GROUP, and USER notifications types.

TeamId string

Unique identifier of a team.

TypeName string

Type of alert notification. Accepted values are: - DATADOG - EMAIL - FLOWDOCK - GROUP (Project) - OPS_GENIE - ORG - PAGER_DUTY - SLACK - SMS - TEAM - USER - VICTOR_OPS - WEBHOOK

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.

VictorOpsApiKey string

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.

VictorOpsRoutingKey string

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.

apiToken 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.

channelName string

Slack channel name. Required for the SLACK notifications type.

datadogApiKey string

Datadog API Key. Found in the Datadog dashboard. Required for the DATADOG notifications type.

datadogRegion string

Region that indicates which API URL to use. Accepted regions are: US, EU. The default Datadog region is US.

delayMin number

Number of minutes to wait after an alert condition is detected before sending out the first notification.

emailAddress string

Email address to which alert notifications are sent. Required for the EMAIL notifications type.

emailEnabled boolean

Flag indicating if email notifications should be sent. Configurable for ORG, GROUP, and USER notifications types.

flowName string

Flowdock flow name in lower-case letters. Required for the FLOWDOCK notifications type

flowdockApiToken string

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.

intervalMin number

Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.

mobileNumber string

Mobile number to which alert notifications are sent. Required for the SMS notifications type.

opsGenieApiKey string

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.

opsGenieRegion string

Region that indicates which API URL to use. Accepted regions are: US ,EU. The default Opsgenie region is US.

orgName 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[]
serviceKey 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.

smsEnabled boolean

Flag indicating if text message notifications should be sent. Configurable for ORG, GROUP, and USER notifications types.

teamId string

Unique identifier of a team.

typeName string

Type of alert notification. Accepted values are: - DATADOG - EMAIL - FLOWDOCK - GROUP (Project) - OPS_GENIE - ORG - PAGER_DUTY - SLACK - SMS - TEAM - USER - VICTOR_OPS - WEBHOOK

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.

victorOpsApiKey string

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.

victorOpsRoutingKey string

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.

apiToken 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.

channelName str

Slack channel name. Required for the SLACK notifications type.

datadogApiKey str

Datadog API Key. Found in the Datadog dashboard. Required for the DATADOG notifications type.

datadogRegion str

Region that indicates which API URL to use. Accepted regions are: US, EU. The default Datadog region is US.

delayMin float

Number of minutes to wait after an alert condition is detected before sending out the first notification.

emailAddress str

Email address to which alert notifications are sent. Required for the EMAIL notifications type.

emailEnabled bool

Flag indicating if email notifications should be sent. Configurable for ORG, GROUP, and USER notifications types.

flowName str

Flowdock flow name in lower-case letters. Required for the FLOWDOCK notifications type

flowdockApiToken str

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.

intervalMin float

Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.

mobileNumber str

Mobile number to which alert notifications are sent. Required for the SMS notifications type.

opsGenieApiKey str

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.

opsGenieRegion str

Region that indicates which API URL to use. Accepted regions are: US ,EU. The default Opsgenie region is US.

orgName 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 List[str]
serviceKey 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.

smsEnabled bool

Flag indicating if text message notifications should be sent. Configurable for ORG, GROUP, and USER notifications types.

team_id str

Unique identifier of a team.

typeName str

Type of alert notification. Accepted values are: - DATADOG - EMAIL - FLOWDOCK - GROUP (Project) - OPS_GENIE - ORG - PAGER_DUTY - SLACK - SMS - TEAM - USER - VICTOR_OPS - WEBHOOK

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.

victorOpsApiKey str

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.

victorOpsRoutingKey str

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.

Package Details

Repository
https://github.com/pulumi/pulumi-mongodbatlas
License
Apache-2.0
Notes
This Pulumi package is based on the mongodbatlas Terraform Provider.