MongoDB Atlas v3.12.1, Nov 27 23

MongoDB Atlas v3.12.1 published on Monday, Nov 27, 2023 by Pulumi

mongodbatlas.getAlertConfiguration

Explore with Pulumi AI

MongoDB Atlas v3.12.1 published on Monday, Nov 27, 2023 by Pulumi

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:

AlertConfigurationId string

Unique identifier for the alert configuration.

ProjectId string

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

Outputs List<GetAlertConfigurationOutput>

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 as output.#.value, the following are the supported types:

AlertConfigurationId string

Unique identifier for the alert configuration.

ProjectId string

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

Outputs []GetAlertConfigurationOutput

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 as output.#.value, the following are the supported types:

alertConfigurationId String

Unique identifier for the alert configuration.

projectId String

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

outputs List<GetAlertConfigurationOutput>

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 as output.#.value, the following are the supported types:

alertConfigurationId string

Unique identifier for the alert configuration.

projectId string

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

outputs GetAlertConfigurationOutput[]

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 as output.#.value, the following are the supported types:

alert_configuration_id str

Unique identifier for the alert configuration.

project_id str

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

outputs Sequence[GetAlertConfigurationOutput]

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 as output.#.value, the following are the supported types:

alertConfigurationId String

Unique identifier for the alert configuration.

projectId 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 as output.#.value, the following are the supported types:

getAlertConfiguration Result

The following output properties are available:

AlertConfigurationId string
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.
EventType string: The type of event that will trigger an alert.
Id string
Matchers List<GetAlertConfigurationMatcher>: Rules to apply when matching an object against this alert configuration. See matchers.
MetricThresholdConfigs List<GetAlertConfigurationMetricThresholdConfig>: The threshold that causes an alert to be triggered. Required if event_type_name : OUTSIDE_METRIC_THRESHOLD or OUTSIDE_SERVERLESS_METRIC_THRESHOLD. See metric threshold config.
Notifications List<GetAlertConfigurationNotification>
ProjectId string
ThresholdConfigs List<GetAlertConfigurationThresholdConfig>: Threshold that triggers an alert. Required if event_type_name is any value other than OUTSIDE_METRIC_THRESHOLD or OUTSIDE_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<GetAlertConfigurationOutput>

AlertConfigurationId string
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.
EventType string: The type of event that will trigger an alert.
Id string
Matchers []GetAlertConfigurationMatcher: Rules to apply when matching an object against this alert configuration. See matchers.
MetricThresholdConfigs []GetAlertConfigurationMetricThresholdConfig: The threshold that causes an alert to be triggered. Required if event_type_name : OUTSIDE_METRIC_THRESHOLD or OUTSIDE_SERVERLESS_METRIC_THRESHOLD. See metric threshold config.
Notifications []GetAlertConfigurationNotification
ProjectId string
ThresholdConfigs []GetAlertConfigurationThresholdConfig: Threshold that triggers an alert. Required if event_type_name is any value other than OUTSIDE_METRIC_THRESHOLD or OUTSIDE_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 []GetAlertConfigurationOutput

alertConfigurationId String
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.
eventType String: The type of event that will trigger an alert.
id String
matchers List<GetAlertConfigurationMatcher>: Rules to apply when matching an object against this alert configuration. See matchers.
metricThresholdConfigs List<GetAlertConfigurationMetricThresholdConfig>: The threshold that causes an alert to be triggered. Required if event_type_name : OUTSIDE_METRIC_THRESHOLD or OUTSIDE_SERVERLESS_METRIC_THRESHOLD. See metric threshold config.
notifications List<GetAlertConfigurationNotification>
projectId String
thresholdConfigs List<GetAlertConfigurationThresholdConfig>: Threshold that triggers an alert. Required if event_type_name is any value other than OUTSIDE_METRIC_THRESHOLD or OUTSIDE_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<GetAlertConfigurationOutput>

alertConfigurationId string
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.
eventType string: The type of event that will trigger an alert.
id string
matchers GetAlertConfigurationMatcher[]: Rules to apply when matching an object against this alert configuration. See matchers.
metricThresholdConfigs GetAlertConfigurationMetricThresholdConfig[]: The threshold that causes an alert to be triggered. Required if event_type_name : OUTSIDE_METRIC_THRESHOLD or OUTSIDE_SERVERLESS_METRIC_THRESHOLD. See metric threshold config.
notifications GetAlertConfigurationNotification[]
projectId string
thresholdConfigs GetAlertConfigurationThresholdConfig[]: Threshold that triggers an alert. Required if event_type_name is any value other than OUTSIDE_METRIC_THRESHOLD or OUTSIDE_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 GetAlertConfigurationOutput[]

alert_configuration_id str
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[GetAlertConfigurationMatcher]: Rules to apply when matching an object against this alert configuration. See matchers.
metric_threshold_configs Sequence[GetAlertConfigurationMetricThresholdConfig]: The threshold that causes an alert to be triggered. Required if event_type_name : OUTSIDE_METRIC_THRESHOLD or OUTSIDE_SERVERLESS_METRIC_THRESHOLD. See metric threshold config.
notifications Sequence[GetAlertConfigurationNotification]
project_id str
threshold_configs Sequence[GetAlertConfigurationThresholdConfig]: Threshold that triggers an alert. Required if event_type_name is any value other than OUTSIDE_METRIC_THRESHOLD or OUTSIDE_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[GetAlertConfigurationOutput]

alertConfigurationId String
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.
eventType 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.
metricThresholdConfigs List<Property Map>: The threshold that causes an alert to be triggered. Required if event_type_name : OUTSIDE_METRIC_THRESHOLD or OUTSIDE_SERVERLESS_METRIC_THRESHOLD. See metric threshold config.
notifications List<Property Map>
projectId String
thresholdConfigs List<Property Map>: Threshold that triggers an alert. Required if event_type_name is any value other than OUTSIDE_METRIC_THRESHOLD or OUTSIDE_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

FieldName 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:

FieldName 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:

fieldName 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:

fieldName 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:

fieldName 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

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

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

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

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

metricName 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

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 email notifications should be sent. Atlas returns this value if type_name is set to ORG, GROUP, or USER.
IntervalMin int: Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.
MicrosoftTeamsWebhookUrl string: Microsoft Teams channel incoming webhook URL. Required for the MICROSOFT_TEAMS notifications type.
MobileNumber string: Mobile number to which alert notifications are sent. Required for the SMS notifications type.
NotifierId 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.
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.
Roles List<string>: Atlas role in current Project or Organization. Atlas returns this value if you set type_name to ORG or GROUP.
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 text notifications should be sent. Atlas returns this value if type_name is set to ORG, GROUP, or USER.
TeamId string: Unique identifier of a team.
TeamName string: Label for the team that receives this notification.
TypeName 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.
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.
WebhookSecret string: Authentication secret for the WEBHOOK notifications type.
WebhookUrl string: Target URL for the WEBHOOK notifications 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 email notifications should be sent. Atlas returns this value if type_name is set to ORG, GROUP, or USER.
IntervalMin int: Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.
MicrosoftTeamsWebhookUrl string: Microsoft Teams channel incoming webhook URL. Required for the MICROSOFT_TEAMS notifications type.
MobileNumber string: Mobile number to which alert notifications are sent. Required for the SMS notifications type.
NotifierId 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.
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.
Roles []string: Atlas role in current Project or Organization. Atlas returns this value if you set type_name to ORG or GROUP.
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 text notifications should be sent. Atlas returns this value if type_name is set to ORG, GROUP, or USER.
TeamId string: Unique identifier of a team.
TeamName string: Label for the team that receives this notification.
TypeName 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.
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.
WebhookSecret string: Authentication secret for the WEBHOOK notifications type.
WebhookUrl string: Target URL for the WEBHOOK notifications 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 Integer: 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 email notifications should be sent. Atlas returns this value if type_name is set to ORG, GROUP, or USER.
intervalMin Integer: Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.
microsoftTeamsWebhookUrl String: Microsoft Teams channel incoming webhook URL. Required for the MICROSOFT_TEAMS notifications type.
mobileNumber String: Mobile number to which alert notifications are sent. Required for the SMS notifications type.
notifierId 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.
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.
roles List<String>: Atlas role in current Project or Organization. Atlas returns this value if you set type_name to ORG or GROUP.
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 text notifications should be sent. Atlas returns this value if type_name is set to ORG, GROUP, or USER.
teamId String: Unique identifier of a team.
teamName String: Label for the team that receives this notification.
typeName 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.
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.
webhookSecret String: Authentication secret for the WEBHOOK notifications type.
webhookUrl String: Target URL for the WEBHOOK notifications 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 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 email notifications should be sent. Atlas returns this value if type_name is set to ORG, GROUP, or USER.
intervalMin number: Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.
microsoftTeamsWebhookUrl string: Microsoft Teams channel incoming webhook URL. Required for the MICROSOFT_TEAMS notifications type.
mobileNumber string: Mobile number to which alert notifications are sent. Required for the SMS notifications type.
notifierId 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.
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.
roles string[]: Atlas role in current Project or Organization. Atlas returns this value if you set type_name to ORG or GROUP.
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 text notifications should be sent. Atlas returns this value if type_name is set to ORG, GROUP, or USER.
teamId string: Unique identifier of a team.
teamName string: Label for the team that receives this notification.
typeName 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.
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.
webhookSecret string: Authentication secret for the WEBHOOK notifications type.
webhookUrl 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_key str: 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 to ORG, GROUP, or USER.
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_webhook_url str: 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_api_key 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.
ops_genie_region str: 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 to ORG or GROUP.
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 to ORG, GROUP, or USER.
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_api_key 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.
victor_ops_routing_key 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.
webhook_secret str: Authentication secret for the WEBHOOK notifications type.
webhook_url str: Target URL for the WEBHOOK notifications 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 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 email notifications should be sent. Atlas returns this value if type_name is set to ORG, GROUP, or USER.
intervalMin Number: Number of minutes to wait between successive notifications for unacknowledged alerts that are not resolved. The minimum value is 5.
microsoftTeamsWebhookUrl String: Microsoft Teams channel incoming webhook URL. Required for the MICROSOFT_TEAMS notifications type.
mobileNumber String: Mobile number to which alert notifications are sent. Required for the SMS notifications type.
notifierId 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.
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.
roles List<String>: Atlas role in current Project or Organization. Atlas returns this value if you set type_name to ORG or GROUP.
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 text notifications should be sent. Atlas returns this value if type_name is set to ORG, GROUP, or USER.
teamId String: Unique identifier of a team.
teamName String: Label for the team that receives this notification.
typeName 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.
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.
webhookSecret String: Authentication secret for the WEBHOOK notifications type.
webhookUrl String: Target URL for the WEBHOOK notifications type.

GetAlertConfigurationOutput

Type string
Value string: Value to test with the specified operator. If field_name is set to TYPE_NAME, you can match on the following values:
Label string

Type string
Value string: Value to test with the specified operator. If field_name is set to TYPE_NAME, you can match on the following values:
Label string

type String
value String: Value to test with the specified operator. If field_name is set to TYPE_NAME, you can match on the following values:
label String

type string
value string: Value to test with the specified operator. If field_name is set to TYPE_NAME, you can match on the following values:
label string

type str
value str: Value to test with the specified operator. If field_name is set to TYPE_NAME, you can match on the following values:
label str

type String
value String: Value to test with the specified operator. If field_name is set to TYPE_NAME, you can match on the following values:
label String

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.

MongoDB Atlas v3.12.1 published on Monday, Nov 27, 2023 by Pulumi

pulumi/pulumi-mongodbatlas

mongodbatlas.getAlertConfiguration

On this page

On this page

Using getAlertConfiguration

getAlertConfiguration Result

Supporting Types

GetAlertConfigurationMatcher

GetAlertConfigurationMetricThresholdConfig

GetAlertConfigurationNotification

GetAlertConfigurationOutput

GetAlertConfigurationThresholdConfig

Package Details

On this page

On this page