mongodbatlas.getAlertConfigurations
Explore with Pulumi AI
Using getAlertConfigurations
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 getAlertConfigurations(args: GetAlertConfigurationsArgs, opts?: InvokeOptions): Promise<GetAlertConfigurationsResult>
function getAlertConfigurationsOutput(args: GetAlertConfigurationsOutputArgs, opts?: InvokeOptions): Output<GetAlertConfigurationsResult>
def get_alert_configurations(list_options: Optional[Sequence[GetAlertConfigurationsListOption]] = None,
output_types: Optional[Sequence[str]] = None,
project_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetAlertConfigurationsResult
def get_alert_configurations_output(list_options: Optional[pulumi.Input[Sequence[pulumi.Input[GetAlertConfigurationsListOptionArgs]]]] = None,
output_types: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
project_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetAlertConfigurationsResult]
func LookupAlertConfigurations(ctx *Context, args *LookupAlertConfigurationsArgs, opts ...InvokeOption) (*LookupAlertConfigurationsResult, error)
func LookupAlertConfigurationsOutput(ctx *Context, args *LookupAlertConfigurationsOutputArgs, opts ...InvokeOption) LookupAlertConfigurationsResultOutput
> Note: This function is named LookupAlertConfigurations
in the Go SDK.
public static class GetAlertConfigurations
{
public static Task<GetAlertConfigurationsResult> InvokeAsync(GetAlertConfigurationsArgs args, InvokeOptions? opts = null)
public static Output<GetAlertConfigurationsResult> Invoke(GetAlertConfigurationsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAlertConfigurationsResult> getAlertConfigurations(GetAlertConfigurationsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: mongodbatlas:index/getAlertConfigurations:getAlertConfigurations
arguments:
# arguments dictionary
The following arguments are supported:
- Project
Id string The unique ID for the project to get the alert configurations.
- List
Options List<GetAlert Configurations List Option> Arguments that dictate how many and which results are returned by the data source
list_options.page_num
- Which page of results to retrieve (default to first page)list_options.items_per_page
- How many alerts to retrieve per page (default 100)list_options.include_count
- Whether to include total count of results in the response (default false)
- Output
Types List<string> List of requested string formatted output to be included on each individual result. Options are
resource_hcl
andresource_import
. Available to make it easy to gather resource statements for existing alert configurations, and corresponding import statements to import said resource state into the statefile.
- Project
Id string The unique ID for the project to get the alert configurations.
- List
Options []GetAlert Configurations List Option Arguments that dictate how many and which results are returned by the data source
list_options.page_num
- Which page of results to retrieve (default to first page)list_options.items_per_page
- How many alerts to retrieve per page (default 100)list_options.include_count
- Whether to include total count of results in the response (default false)
- Output
Types []string List of requested string formatted output to be included on each individual result. Options are
resource_hcl
andresource_import
. Available to make it easy to gather resource statements for existing alert configurations, and corresponding import statements to import said resource state into the statefile.
- project
Id String The unique ID for the project to get the alert configurations.
- list
Options List<GetAlert Configurations List Option> Arguments that dictate how many and which results are returned by the data source
list_options.page_num
- Which page of results to retrieve (default to first page)list_options.items_per_page
- How many alerts to retrieve per page (default 100)list_options.include_count
- Whether to include total count of results in the response (default false)
- output
Types List<String> List of requested string formatted output to be included on each individual result. Options are
resource_hcl
andresource_import
. Available to make it easy to gather resource statements for existing alert configurations, and corresponding import statements to import said resource state into the statefile.
- project
Id string The unique ID for the project to get the alert configurations.
- list
Options GetAlert Configurations List Option[] Arguments that dictate how many and which results are returned by the data source
list_options.page_num
- Which page of results to retrieve (default to first page)list_options.items_per_page
- How many alerts to retrieve per page (default 100)list_options.include_count
- Whether to include total count of results in the response (default false)
- output
Types string[] List of requested string formatted output to be included on each individual result. Options are
resource_hcl
andresource_import
. Available to make it easy to gather resource statements for existing alert configurations, and corresponding import statements to import said resource state into the statefile.
- project_
id str The unique ID for the project to get the alert configurations.
- list_
options Sequence[GetAlert Configurations List Option] Arguments that dictate how many and which results are returned by the data source
list_options.page_num
- Which page of results to retrieve (default to first page)list_options.items_per_page
- How many alerts to retrieve per page (default 100)list_options.include_count
- Whether to include total count of results in the response (default false)
- output_
types Sequence[str] List of requested string formatted output to be included on each individual result. Options are
resource_hcl
andresource_import
. Available to make it easy to gather resource statements for existing alert configurations, and corresponding import statements to import said resource state into the statefile.
- project
Id String The unique ID for the project to get the alert configurations.
- list
Options List<Property Map> Arguments that dictate how many and which results are returned by the data source
list_options.page_num
- Which page of results to retrieve (default to first page)list_options.items_per_page
- How many alerts to retrieve per page (default 100)list_options.include_count
- Whether to include total count of results in the response (default false)
- output
Types List<String> List of requested string formatted output to be included on each individual result. Options are
resource_hcl
andresource_import
. Available to make it easy to gather resource statements for existing alert configurations, and corresponding import statements to import said resource state into the statefile.
getAlertConfigurations Result
The following output properties are available:
- Id string
The provider-assigned unique ID for this managed resource.
- Project
Id string The ID of the project where the alert configuration exists
- Results
List<Get
Alert Configurations Result> A list of alert configurations for the project_id, constrained by the
list_options
.- Total
Count int Total count of results
- List
Options List<GetAlert Configurations List Option> - Output
Types List<string>
- Id string
The provider-assigned unique ID for this managed resource.
- Project
Id string The ID of the project where the alert configuration exists
- Results
[]Get
Alert Configurations Result A list of alert configurations for the project_id, constrained by the
list_options
.- Total
Count int Total count of results
- List
Options []GetAlert Configurations List Option - Output
Types []string
- id String
The provider-assigned unique ID for this managed resource.
- project
Id String The ID of the project where the alert configuration exists
- results
List<Get
Alert Configurations Result> A list of alert configurations for the project_id, constrained by the
list_options
.- total
Count Integer Total count of results
- list
Options List<GetAlert Configurations List Option> - output
Types List<String>
- id string
The provider-assigned unique ID for this managed resource.
- project
Id string The ID of the project where the alert configuration exists
- results
Get
Alert Configurations Result[] A list of alert configurations for the project_id, constrained by the
list_options
.- total
Count number Total count of results
- list
Options GetAlert Configurations List Option[] - output
Types string[]
- id str
The provider-assigned unique ID for this managed resource.
- project_
id str The ID of the project where the alert configuration exists
- results
Sequence[Get
Alert Configurations Result] A list of alert configurations for the project_id, constrained by the
list_options
.- total_
count int Total count of results
- list_
options Sequence[GetAlert Configurations List Option] - output_
types Sequence[str]
- id String
The provider-assigned unique ID for this managed resource.
- project
Id String The ID of the project where the alert configuration exists
- results List<Property Map>
A list of alert configurations for the project_id, constrained by the
list_options
.- total
Count Number Total count of results
- list
Options List<Property Map> - output
Types List<String>
Supporting Types
GetAlertConfigurationsListOption
- Include
Count bool - Items
Per intPage - Page
Num int
- Include
Count bool - Items
Per intPage - Page
Num int
- include
Count Boolean - items
Per IntegerPage - page
Num Integer
- include
Count boolean - items
Per numberPage - page
Num number
- include_
count bool - items_
per_ intpage - page_
num int
- include
Count Boolean - items
Per NumberPage - page
Num Number
GetAlertConfigurationsResult
- Alert
Configuration stringId The ID of the alert configuration
- 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.
- Matchers
List<Get
Alert Configurations Result Matcher> Rules to apply when matching an object against this alert configuration
- Metric
Threshold Dictionary<string, string> - Metric
Threshold List<GetConfigs Alert Configurations Result Metric Threshold Config> The threshold that causes an alert to be triggered. Required if
event_type_name
:OUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
- Notifications
List<Get
Alert Configurations Result Notification> - Project
Id string The unique ID for the project to get the alert configurations.
- Threshold Dictionary<string, string>
- Threshold
Configs List<GetAlert Configurations Result Threshold Config> Threshold that triggers an alert. Required if
event_type_name
is any value other thanOUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
.- Updated string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
- Outputs
List<Get
Alert Configurations Result Output> Requested output string format for the alert configuration
- Alert
Configuration stringId The ID of the alert configuration
- 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.
- Matchers
[]Get
Alert Configurations Result Matcher Rules to apply when matching an object against this alert configuration
- Metric
Threshold map[string]string - Metric
Threshold []GetConfigs Alert Configurations Result Metric Threshold Config The threshold that causes an alert to be triggered. Required if
event_type_name
:OUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
- Notifications
[]Get
Alert Configurations Result Notification - Project
Id string The unique ID for the project to get the alert configurations.
- Threshold map[string]string
- Threshold
Configs []GetAlert Configurations Result Threshold Config Threshold that triggers an alert. Required if
event_type_name
is any value other thanOUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
.- Updated string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
- Outputs
[]Get
Alert Configurations Result Output Type Requested output string format for the alert configuration
- alert
Configuration StringId The ID of the alert configuration
- 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.
- matchers
List<Get
Alert Configurations Result Matcher> Rules to apply when matching an object against this alert configuration
- metric
Threshold Map<String,String> - metric
Threshold List<GetConfigs Alert Configurations Result Metric Threshold Config> The threshold that causes an alert to be triggered. Required if
event_type_name
:OUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
- notifications
List<Get
Alert Configurations Result Notification> - project
Id String The unique ID for the project to get the alert configurations.
- threshold Map<String,String>
- threshold
Configs List<GetAlert Configurations Result Threshold Config> Threshold that triggers an alert. Required if
event_type_name
is any value other thanOUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
.- updated String
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
- outputs
List<Get
Alert Configurations Result Output> Requested output string format for the alert configuration
- alert
Configuration stringId The ID of the alert configuration
- 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.
- matchers
Get
Alert Configurations Result Matcher[] Rules to apply when matching an object against this alert configuration
- metric
Threshold {[key: string]: string} - metric
Threshold GetConfigs Alert Configurations Result Metric Threshold Config[] The threshold that causes an alert to be triggered. Required if
event_type_name
:OUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
- notifications
Get
Alert Configurations Result Notification[] - project
Id string The unique ID for the project to get the alert configurations.
- threshold {[key: string]: string}
- threshold
Configs GetAlert Configurations Result Threshold Config[] Threshold that triggers an alert. Required if
event_type_name
is any value other thanOUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
.- updated string
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
- outputs
Get
Alert Configurations Result Output[] Requested output string format for the alert configuration
- alert_
configuration_ strid The ID of the alert configuration
- 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.
- matchers
Sequence[Get
Alert Configurations Result Matcher] Rules to apply when matching an object against this alert configuration
- metric_
threshold Mapping[str, str] - metric_
threshold_ Sequence[Getconfigs Alert Configurations Result Metric Threshold Config] The threshold that causes an alert to be triggered. Required if
event_type_name
:OUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
- notifications
Sequence[Get
Alert Configurations Result Notification] - project_
id str The unique ID for the project to get the alert configurations.
- threshold Mapping[str, str]
- threshold_
configs Sequence[GetAlert Configurations Result Threshold Config] Threshold that triggers an alert. Required if
event_type_name
is any value other thanOUTSIDE_METRIC_THRESHOLD
orOUTSIDE_SERVERLESS_METRIC_THRESHOLD
.- updated str
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
- outputs
Sequence[Get
Alert Configurations Result Output] Requested output string format for the alert configuration
- alert
Configuration StringId The ID of the alert configuration
- 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.
- matchers List<Property Map>
Rules to apply when matching an object against this alert configuration
- metric
Threshold Map<String> - 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
- notifications List<Property Map>
- project
Id String The unique ID for the project to get the alert configurations.
- threshold Map<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
.- updated String
Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
- outputs List<Property Map>
Requested output string format for the alert configuration
GetAlertConfigurationsResultMatcher
- field_
name str - operator str
- value str
GetAlertConfigurationsResultMetricThresholdConfig
- Metric
Name string - Mode string
- Operator string
- Threshold double
- Units string
- Metric
Name string - Mode string
- Operator string
- Threshold float64
- Units string
- metric
Name String - mode String
- operator String
- threshold Double
- units String
- metric
Name string - mode string
- operator string
- threshold number
- units string
- metric_
name str - mode str
- operator str
- threshold float
- units str
- metric
Name String - mode String
- operator String
- threshold Number
- units String
GetAlertConfigurationsResultNotification
- Api
Token string - Channel
Name string - Datadog
Api stringKey - Datadog
Region string - Delay
Min int - Email
Address string - Email
Enabled bool - Interval
Min int - Mobile
Number string - Ops
Genie stringApi Key - Ops
Genie stringRegion - Service
Key string - Sms
Enabled bool - Team
Id string - Team
Name string - Type
Name string - Username string
- Victor
Ops stringApi Key - Victor
Ops stringRouting Key - Microsoft
Teams stringWebhook Url - Roles List<string>
- Webhook
Secret string - Webhook
Url string
- Api
Token string - Channel
Name string - Datadog
Api stringKey - Datadog
Region string - Delay
Min int - Email
Address string - Email
Enabled bool - Interval
Min int - Mobile
Number string - Ops
Genie stringApi Key - Ops
Genie stringRegion - Service
Key string - Sms
Enabled bool - Team
Id string - Team
Name string - Type
Name string - Username string
- Victor
Ops stringApi Key - Victor
Ops stringRouting Key - Microsoft
Teams stringWebhook Url - Roles []string
- Webhook
Secret string - Webhook
Url string
- api
Token String - channel
Name String - datadog
Api StringKey - datadog
Region String - delay
Min Integer - email
Address String - email
Enabled Boolean - interval
Min Integer - mobile
Number String - ops
Genie StringApi Key - ops
Genie StringRegion - service
Key String - sms
Enabled Boolean - team
Id String - team
Name String - type
Name String - username String
- victor
Ops StringApi Key - victor
Ops StringRouting Key - microsoft
Teams StringWebhook Url - roles List<String>
- webhook
Secret String - webhook
Url String
- api
Token string - channel
Name string - datadog
Api stringKey - datadog
Region string - delay
Min number - email
Address string - email
Enabled boolean - interval
Min number - mobile
Number string - ops
Genie stringApi Key - ops
Genie stringRegion - service
Key string - sms
Enabled boolean - team
Id string - team
Name string - type
Name string - username string
- victor
Ops stringApi Key - victor
Ops stringRouting Key - microsoft
Teams stringWebhook Url - roles string[]
- webhook
Secret string - webhook
Url string
- api_
token str - channel_
name str - datadog_
api_ strkey - datadog_
region str - delay_
min int - email_
address str - email_
enabled bool - interval_
min int - mobile_
number str - ops_
genie_ strapi_ key - ops_
genie_ strregion - service_
key str - sms_
enabled bool - team_
id str - team_
name str - type_
name str - username str
- victor_
ops_ strapi_ key - victor_
ops_ strrouting_ key - microsoft_
teams_ strwebhook_ url - roles Sequence[str]
- webhook_
secret str - webhook_
url str
- api
Token String - channel
Name String - datadog
Api StringKey - datadog
Region String - delay
Min Number - email
Address String - email
Enabled Boolean - interval
Min Number - mobile
Number String - ops
Genie StringApi Key - ops
Genie StringRegion - service
Key String - sms
Enabled Boolean - team
Id String - team
Name String - type
Name String - username String
- victor
Ops StringApi Key - victor
Ops StringRouting Key - microsoft
Teams StringWebhook Url - roles List<String>
- webhook
Secret String - webhook
Url String
GetAlertConfigurationsResultOutput
GetAlertConfigurationsResultThresholdConfig
Package Details
- Repository
- MongoDB Atlas pulumi/pulumi-mongodbatlas
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
mongodbatlas
Terraform Provider.