mongodbatlas.getAlertConfiguration
Explore with Pulumi AI
mongodbatlas.AlertConfiguration
describes an Alert Configuration.
NOTE: Groups and projects are synonymous terms. You may find group_id in the official documentation.
Using getAlertConfiguration
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getAlertConfiguration(args: GetAlertConfigurationArgs, opts?: InvokeOptions): Promise<GetAlertConfigurationResult>
function getAlertConfigurationOutput(args: GetAlertConfigurationOutputArgs, opts?: InvokeOptions): Output<GetAlertConfigurationResult>
def get_alert_configuration(alert_configuration_id: Optional[str] = None,
outputs: Optional[Sequence[GetAlertConfigurationOutput]] = None,
project_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAlertConfigurationResult
def get_alert_configuration_output(alert_configuration_id: Optional[pulumi.Input[str]] = None,
outputs: Optional[pulumi.Input[Sequence[pulumi.Input[GetAlertConfigurationOutputArgs]]]] = None,
project_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAlertConfigurationResult]
func LookupAlertConfiguration(ctx *Context, args *LookupAlertConfigurationArgs, opts ...InvokeOption) (*LookupAlertConfigurationResult, error)
func LookupAlertConfigurationOutput(ctx *Context, args *LookupAlertConfigurationOutputArgs, opts ...InvokeOption) LookupAlertConfigurationResultOutput
> Note: This function is named LookupAlertConfiguration
in the Go SDK.
public static class GetAlertConfiguration
{
public static Task<GetAlertConfigurationResult> InvokeAsync(GetAlertConfigurationArgs args, InvokeOptions? opts = null)
public static Output<GetAlertConfigurationResult> Invoke(GetAlertConfigurationInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAlertConfigurationResult> getAlertConfiguration(GetAlertConfigurationArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: mongodbatlas:index/getAlertConfiguration:getAlertConfiguration
arguments:
# arguments dictionary
The following arguments are supported:
- Alert
Configuration stringId Unique identifier for the alert configuration.
- Project
Id string The ID of the project where the alert configuration will create.
- Outputs
List<Get
Alert Configuration Output> List of formatted output requested for this alert configuration
output.#.type
- (Required) If the output is requested, you must specify its type. The format is computed asoutput.#.value
, the following are the supported types:
- Alert
Configuration stringId Unique identifier for the alert configuration.
- Project
Id string The ID of the project where the alert configuration will create.
- Outputs
[]Get
Alert Configuration Output List of formatted output requested for this alert configuration
output.#.type
- (Required) If the output is requested, you must specify its type. The format is computed asoutput.#.value
, the following are the supported types:
- alert
Configuration StringId Unique identifier for the alert configuration.
- project
Id String The ID of the project where the alert configuration will create.
- outputs
List<Get
Alert Configuration Output> List of formatted output requested for this alert configuration
output.#.type
- (Required) If the output is requested, you must specify its type. The format is computed asoutput.#.value
, the following are the supported types:
- alert
Configuration stringId Unique identifier for the alert configuration.
- project
Id string The ID of the project where the alert configuration will create.
- outputs
Get
Alert Configuration Output[] List of formatted output requested for this alert configuration
output.#.type
- (Required) If the output is requested, you must specify its type. The format is computed asoutput.#.value
, the following are the supported types:
- alert_
configuration_ strid Unique identifier for the alert configuration.
- project_
id str The ID of the project where the alert configuration will create.
- outputs
Sequence[Get
Alert Configuration Output] List of formatted output requested for this alert configuration
output.#.type
- (Required) If the output is requested, you must specify its type. The format is computed asoutput.#.value
, the following are the supported types:
- alert
Configuration StringId Unique identifier for the alert configuration.
- project
Id String The ID of the project where the alert configuration will create.
- outputs List<Property Map>
List of formatted output requested for this alert configuration
output.#.type
- (Required) If the output is requested, you must specify its type. The format is computed asoutput.#.value
, the following are the supported types:
getAlertConfiguration Result
The following output properties are available:
- Alert
Configuration stringId - Created string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created.
- Enabled bool
If set to true, the alert configuration is enabled. If enabled is not exported it is set to false.
- Event
Type string The type of event that will trigger an alert.
- Id string
- Matchers
List<Get
Alert Configuration Matcher> Rules to apply when matching an object against this alert configuration. See matchers.
- Metric
Threshold List<GetConfigs Alert Configuration Metric Threshold Config> The threshold that causes an alert to be triggered. Required if
event_type_name
:OUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
. See metric threshold config.- Notifications
List<Get
Alert Configuration Notification> - Project
Id string - Threshold
Configs List<GetAlert Configuration Threshold Config> Threshold that triggers an alert. Required if
event_type_name
is any value other thanOUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
. See threshold config.- Updated string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
- Outputs
List<Get
Alert Configuration Output>
- Alert
Configuration stringId - Created string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created.
- Enabled bool
If set to true, the alert configuration is enabled. If enabled is not exported it is set to false.
- Event
Type string The type of event that will trigger an alert.
- Id string
- Matchers
[]Get
Alert Configuration Matcher Rules to apply when matching an object against this alert configuration. See matchers.
- Metric
Threshold []GetConfigs Alert Configuration Metric Threshold Config The threshold that causes an alert to be triggered. Required if
event_type_name
:OUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
. See metric threshold config.- Notifications
[]Get
Alert Configuration Notification - Project
Id string - Threshold
Configs []GetAlert Configuration Threshold Config Threshold that triggers an alert. Required if
event_type_name
is any value other thanOUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
. See threshold config.- Updated string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
- Outputs
[]Get
Alert Configuration Output
- alert
Configuration StringId - created String
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created.
- enabled Boolean
If set to true, the alert configuration is enabled. If enabled is not exported it is set to false.
- event
Type String The type of event that will trigger an alert.
- id String
- matchers
List<Get
Alert Configuration Matcher> Rules to apply when matching an object against this alert configuration. See matchers.
- metric
Threshold List<GetConfigs Alert Configuration Metric Threshold Config> The threshold that causes an alert to be triggered. Required if
event_type_name
:OUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
. See metric threshold config.- notifications
List<Get
Alert Configuration Notification> - project
Id String - threshold
Configs List<GetAlert Configuration Threshold Config> Threshold that triggers an alert. Required if
event_type_name
is any value other thanOUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
. See threshold config.- updated String
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
- outputs
List<Get
Alert Configuration Output>
- alert
Configuration stringId - created string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created.
- enabled boolean
If set to true, the alert configuration is enabled. If enabled is not exported it is set to false.
- event
Type string The type of event that will trigger an alert.
- id string
- matchers
Get
Alert Configuration Matcher[] Rules to apply when matching an object against this alert configuration. See matchers.
- metric
Threshold GetConfigs Alert Configuration Metric Threshold Config[] The threshold that causes an alert to be triggered. Required if
event_type_name
:OUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
. See metric threshold config.- notifications
Get
Alert Configuration Notification[] - project
Id string - threshold
Configs GetAlert Configuration Threshold Config[] Threshold that triggers an alert. Required if
event_type_name
is any value other thanOUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
. See threshold config.- updated string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
- outputs
Get
Alert Configuration Output[]
- alert_
configuration_ strid - created str
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created.
- enabled bool
If set to true, the alert configuration is enabled. If enabled is not exported it is set to false.
- event_
type str The type of event that will trigger an alert.
- id str
- matchers
Sequence[Get
Alert Configuration Matcher] Rules to apply when matching an object against this alert configuration. See matchers.
- metric_
threshold_ Sequence[Getconfigs Alert Configuration Metric Threshold Config] The threshold that causes an alert to be triggered. Required if
event_type_name
:OUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
. See metric threshold config.- notifications
Sequence[Get
Alert Configuration Notification] - project_
id str - threshold_
configs Sequence[GetAlert Configuration Threshold Config] Threshold that triggers an alert. Required if
event_type_name
is any value other thanOUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
. See threshold config.- updated str
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
- outputs
Sequence[Get
Alert Configuration Output]
- alert
Configuration StringId - created String
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was created.
- enabled Boolean
If set to true, the alert configuration is enabled. If enabled is not exported it is set to false.
- event
Type String The type of event that will trigger an alert.
- id String
- matchers List<Property Map>
Rules to apply when matching an object against this alert configuration. See matchers.
- metric
Threshold List<Property Map>Configs The threshold that causes an alert to be triggered. Required if
event_type_name
:OUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
. See metric threshold config.- notifications List<Property Map>
- project
Id String - threshold
Configs List<Property Map> Threshold that triggers an alert. Required if
event_type_name
is any value other thanOUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
. See threshold config.- updated String
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
- outputs List<Property Map>
Supporting Types
GetAlertConfigurationMatcher
- Field
Name string Name of the field in the target object to match on.
- Operator string
The operator to apply when checking the current metric value against the threshold value. Accepted values are:
- Value string
Value to test with the specified operator. If
field_name
is set to TYPE_NAME, you can match on the following values:
- Field
Name string Name of the field in the target object to match on.
- Operator string
The operator to apply when checking the current metric value against the threshold value. Accepted values are:
- Value string
Value to test with the specified operator. If
field_name
is set to TYPE_NAME, you can match on the following values:
- field
Name String Name of the field in the target object to match on.
- operator String
The operator to apply when checking the current metric value against the threshold value. Accepted values are:
- value String
Value to test with the specified operator. If
field_name
is set to TYPE_NAME, you can match on the following values:
- field
Name string Name of the field in the target object to match on.
- operator string
The operator to apply when checking the current metric value against the threshold value. Accepted values are:
- value string
Value to test with the specified operator. If
field_name
is set to TYPE_NAME, you can match on the following values:
- field_
name str Name of the field in the target object to match on.
- operator str
The operator to apply when checking the current metric value against the threshold value. Accepted values are:
- value str
Value to test with the specified operator. If
field_name
is set to TYPE_NAME, you can match on the following values:
- field
Name String Name of the field in the target object to match on.
- operator String
The operator to apply when checking the current metric value against the threshold value. Accepted values are:
- value String
Value to test with the specified operator. If
field_name
is set to TYPE_NAME, you can match on the following values:
GetAlertConfigurationMetricThresholdConfig
- Metric
Name string Name of the metric to check. The full list being quite large, please refer to atlas docs here for general metrics and here for serverless metrics
- Mode string
This must be set to AVERAGE. Atlas computes the current metric value as an average.
- Operator string
The operator to apply when checking the current metric value against the threshold value. Accepted values are:
- 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. Refer to the MongoDB API Alert Configuration documentation for a list of accepted values.
- Metric
Name string Name of the metric to check. The full list being quite large, please refer to atlas docs here for general metrics and here for serverless metrics
- Mode string
This must be set to AVERAGE. Atlas computes the current metric value as an average.
- Operator string
The operator to apply when checking the current metric value against the threshold value. Accepted values are:
- 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. Refer to the MongoDB API Alert Configuration documentation for a list of accepted values.
- metric
Name String Name of the metric to check. The full list being quite large, please refer to atlas docs here for general metrics and here for serverless metrics
- mode String
This must be set to AVERAGE. Atlas computes the current metric value as an average.
- operator String
The operator to apply when checking the current metric value against the threshold value. Accepted values are:
- 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. Refer to the MongoDB API Alert Configuration documentation for a list of accepted values.
- metric
Name string Name of the metric to check. The full list being quite large, please refer to atlas docs here for general metrics and here for serverless metrics
- mode string
This must be set to AVERAGE. Atlas computes the current metric value as an average.
- operator string
The operator to apply when checking the current metric value against the threshold value. Accepted values are:
- 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. Refer to the MongoDB API Alert Configuration documentation for a list of accepted values.
- metric_
name str Name of the metric to check. The full list being quite large, please refer to atlas docs here for general metrics and here for serverless metrics
- mode str
This must be set to AVERAGE. Atlas computes the current metric value as an average.
- operator str
The operator to apply when checking the current metric value against the threshold value. Accepted values are:
- 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. Refer to the MongoDB API Alert Configuration documentation for a list of accepted values.
- metric
Name String Name of the metric to check. The full list being quite large, please refer to atlas docs here for general metrics and here for serverless metrics
- mode String
This must be set to AVERAGE. Atlas computes the current metric value as an average.
- operator String
The operator to apply when checking the current metric value against the threshold value. Accepted values are:
- 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. Refer to the MongoDB API Alert Configuration documentation for a list of accepted values.
GetAlertConfigurationNotification
- 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 email notifications should be sent. Atlas returns this value if
type_name
is set toORG
,GROUP
, orUSER
.- Interval
Min int Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.
- Microsoft
Teams stringWebhook Url Microsoft Teams channel incoming webhook URL. Required for the
MICROSOFT_TEAMS
notifications type.- Mobile
Number string Mobile number to which alert notifications are sent. Required for the SMS notifications type.
- Notifier
Id string The notifier id is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
- 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.- Roles List<string>
Atlas role in current Project or Organization. Atlas returns this value if you set
type_name
toORG
orGROUP
.- 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 text notifications should be sent. Atlas returns this value if
type_name
is set toORG
,GROUP
, orUSER
.- Team
Id string Unique identifier of a team.
- Team
Name string Label for the team that receives this notification.
- Type
Name string Type of alert notification. Accepted values are:
- 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.- Webhook
Secret string Authentication secret for the
WEBHOOK
notifications type.- Webhook
Url string Target URL for the
WEBHOOK
notifications type.
- 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 email notifications should be sent. Atlas returns this value if
type_name
is set toORG
,GROUP
, orUSER
.- Interval
Min int Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.
- Microsoft
Teams stringWebhook Url Microsoft Teams channel incoming webhook URL. Required for the
MICROSOFT_TEAMS
notifications type.- Mobile
Number string Mobile number to which alert notifications are sent. Required for the SMS notifications type.
- Notifier
Id string The notifier id is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
- 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.- Roles []string
Atlas role in current Project or Organization. Atlas returns this value if you set
type_name
toORG
orGROUP
.- 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 text notifications should be sent. Atlas returns this value if
type_name
is set toORG
,GROUP
, orUSER
.- Team
Id string Unique identifier of a team.
- Team
Name string Label for the team that receives this notification.
- Type
Name string Type of alert notification. Accepted values are:
- 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.- Webhook
Secret string Authentication secret for the
WEBHOOK
notifications type.- Webhook
Url string Target URL for the
WEBHOOK
notifications type.
- 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 Integer 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 email notifications should be sent. Atlas returns this value if
type_name
is set toORG
,GROUP
, orUSER
.- interval
Min Integer Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.
- microsoft
Teams StringWebhook Url Microsoft Teams channel incoming webhook URL. Required for the
MICROSOFT_TEAMS
notifications type.- mobile
Number String Mobile number to which alert notifications are sent. Required for the SMS notifications type.
- notifier
Id String The notifier id is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
- 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.- roles List<String>
Atlas role in current Project or Organization. Atlas returns this value if you set
type_name
toORG
orGROUP
.- 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 text notifications should be sent. Atlas returns this value if
type_name
is set toORG
,GROUP
, orUSER
.- team
Id String Unique identifier of a team.
- team
Name String Label for the team that receives this notification.
- type
Name String Type of alert notification. Accepted values are:
- 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.- webhook
Secret String Authentication secret for the
WEBHOOK
notifications type.- webhook
Url String Target URL for the
WEBHOOK
notifications type.
- 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 email notifications should be sent. Atlas returns this value if
type_name
is set toORG
,GROUP
, orUSER
.- interval
Min number Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.
- microsoft
Teams stringWebhook Url Microsoft Teams channel incoming webhook URL. Required for the
MICROSOFT_TEAMS
notifications type.- mobile
Number string Mobile number to which alert notifications are sent. Required for the SMS notifications type.
- notifier
Id string The notifier id is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
- 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.- roles string[]
Atlas role in current Project or Organization. Atlas returns this value if you set
type_name
toORG
orGROUP
.- 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 text notifications should be sent. Atlas returns this value if
type_name
is set toORG
,GROUP
, orUSER
.- team
Id string Unique identifier of a team.
- team
Name string Label for the team that receives this notification.
- type
Name string Type of alert notification. Accepted values are:
- 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.- webhook
Secret string Authentication secret for the
WEBHOOK
notifications type.- webhook
Url string Target URL for the
WEBHOOK
notifications type.
- 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 email notifications should be sent. Atlas returns this value if
type_name
is set toORG
,GROUP
, orUSER
.- interval_
min int Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.
- microsoft_
teams_ strwebhook_ url Microsoft Teams channel incoming webhook URL. Required for the
MICROSOFT_TEAMS
notifications type.- mobile_
number str Mobile number to which alert notifications are sent. Required for the SMS notifications type.
- notifier_
id str The notifier id is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
- 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.- roles Sequence[str]
Atlas role in current Project or Organization. Atlas returns this value if you set
type_name
toORG
orGROUP
.- 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 text notifications should be sent. Atlas returns this value if
type_name
is set toORG
,GROUP
, orUSER
.- team_
id str Unique identifier of a team.
- team_
name str Label for the team that receives this notification.
- type_
name str Type of alert notification. Accepted values are:
- 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.- webhook_
secret str Authentication secret for the
WEBHOOK
notifications type.- webhook_
url str Target URL for the
WEBHOOK
notifications type.
- 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 email notifications should be sent. Atlas returns this value if
type_name
is set toORG
,GROUP
, orUSER
.- interval
Min Number Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.
- microsoft
Teams StringWebhook Url Microsoft Teams channel incoming webhook URL. Required for the
MICROSOFT_TEAMS
notifications type.- mobile
Number String Mobile number to which alert notifications are sent. Required for the SMS notifications type.
- notifier
Id String The notifier id is a system-generated unique identifier assigned to each notification method. This is needed when updating third-party notifications without requiring explicit authentication credentials.
- 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.- roles List<String>
Atlas role in current Project or Organization. Atlas returns this value if you set
type_name
toORG
orGROUP
.- 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 text notifications should be sent. Atlas returns this value if
type_name
is set toORG
,GROUP
, orUSER
.- team
Id String Unique identifier of a team.
- team
Name String Label for the team that receives this notification.
- type
Name String Type of alert notification. Accepted values are:
- 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.- webhook
Secret String Authentication secret for the
WEBHOOK
notifications type.- webhook
Url String Target URL for the
WEBHOOK
notifications type.
GetAlertConfigurationOutput
GetAlertConfigurationThresholdConfig
- Operator string
The operator to apply when checking the current metric value against the threshold value. Accepted values are:
- 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. Refer to the MongoDB API Alert Configuration documentation for a list of accepted values.
- Operator string
The operator to apply when checking the current metric value against the threshold value. Accepted values are:
- 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. Refer to the MongoDB API Alert Configuration documentation for a list of accepted values.
- operator String
The operator to apply when checking the current metric value against the threshold value. Accepted values are:
- 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. Refer to the MongoDB API Alert Configuration documentation for a list of accepted values.
- operator string
The operator to apply when checking the current metric value against the threshold value. Accepted values are:
- 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. Refer to the MongoDB API Alert Configuration documentation for a list of accepted values.
- operator str
The operator to apply when checking the current metric value against the threshold value. Accepted values are:
- 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. Refer to the MongoDB API Alert Configuration documentation for a list of accepted values.
- operator String
The operator to apply when checking the current metric value against the threshold value. Accepted values are:
- 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. Refer to the MongoDB API Alert Configuration documentation for a list of accepted values.
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
mongodbatlas
Terraform Provider.