MongoDB Atlas v3.7.1, Mar 10 23

mongodbatlas.getAlertConfigurations

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:

ProjectId string

The unique ID for the project to get the alert configurations.

ListOptions List<GetAlertConfigurationsListOption>

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)

OutputTypes List<string>

List of requested string formatted output to be included on each individual result. Options are resource_hcl and resource_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.

ProjectId string

The unique ID for the project to get the alert configurations.

ListOptions []GetAlertConfigurationsListOption

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)

OutputTypes []string

projectId String

The unique ID for the project to get the alert configurations.

listOptions List<GetAlertConfigurationsListOption>

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)

outputTypes List<String>

projectId string

The unique ID for the project to get the alert configurations.

listOptions GetAlertConfigurationsListOption[]

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)

outputTypes string[]

project_id str

The unique ID for the project to get the alert configurations.

list_options Sequence[GetAlertConfigurationsListOption]

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]

projectId String

The unique ID for the project to get the alert configurations.

listOptions 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)

outputTypes List<String>

getAlertConfigurations Result

The following output properties are available:

Id string: The provider-assigned unique ID for this managed resource.
ProjectId string: The ID of the project where the alert configuration exists
Results List<GetAlertConfigurationsResult>: A list of alert configurations for the project_id, constrained by the list_options.
TotalCount int: Total count of results
ListOptions List<GetAlertConfigurationsListOption>
OutputTypes List<string>

Id string: The provider-assigned unique ID for this managed resource.
ProjectId string: The ID of the project where the alert configuration exists
Results []GetAlertConfigurationsResult: A list of alert configurations for the project_id, constrained by the list_options.
TotalCount int: Total count of results
ListOptions []GetAlertConfigurationsListOption
OutputTypes []string

id String: The provider-assigned unique ID for this managed resource.
projectId String: The ID of the project where the alert configuration exists
results List<GetAlertConfigurationsResult>: A list of alert configurations for the project_id, constrained by the list_options.
totalCount Integer: Total count of results
listOptions List<GetAlertConfigurationsListOption>
outputTypes List<String>

id string: The provider-assigned unique ID for this managed resource.
projectId string: The ID of the project where the alert configuration exists
results GetAlertConfigurationsResult[]: A list of alert configurations for the project_id, constrained by the list_options.
totalCount number: Total count of results
listOptions GetAlertConfigurationsListOption[]
outputTypes 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[GetAlertConfigurationsResult]: A list of alert configurations for the project_id, constrained by the list_options.
total_count int: Total count of results
list_options Sequence[GetAlertConfigurationsListOption]
output_types Sequence[str]

id String: The provider-assigned unique ID for this managed resource.
projectId 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.
totalCount Number: Total count of results
listOptions List<Property Map>
outputTypes List<String>

Supporting Types

GetAlertConfigurationsListOption

IncludeCount bool
ItemsPerPage int
PageNum int

IncludeCount bool
ItemsPerPage int
PageNum int

includeCount Boolean
itemsPerPage Integer
pageNum Integer

includeCount boolean
itemsPerPage number
pageNum number

include_count bool
items_per_page int
page_num int

includeCount Boolean
itemsPerPage Number
pageNum Number

GetAlertConfigurationsResult

AlertConfigurationId string: 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.
EventType string: The type of event that will trigger an alert.
Matchers List<GetAlertConfigurationsResultMatcher>: Rules to apply when matching an object against this alert configuration
MetricThreshold Dictionary<string, string>
MetricThresholdConfigs List<GetAlertConfigurationsResultMetricThresholdConfig>: The threshold that causes an alert to be triggered. Required if event_type_name : OUTSIDE_METRIC_THRESHOLD or OUTSIDE_SERVERLESS_METRIC_THRESHOLD
Notifications List<GetAlertConfigurationsResultNotification>
ProjectId string: The unique ID for the project to get the alert configurations.
Threshold Dictionary<string, string>
ThresholdConfigs List<GetAlertConfigurationsResultThresholdConfig>: Threshold that triggers an alert. Required if event_type_name is any value other than OUTSIDE_METRIC_THRESHOLD or OUTSIDE_SERVERLESS_METRIC_THRESHOLD.
Updated string: Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
Outputs List<GetAlertConfigurationsResultOutput>: Requested output string format for the alert configuration

AlertConfigurationId string: 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.
EventType string: The type of event that will trigger an alert.
Matchers []GetAlertConfigurationsResultMatcher: Rules to apply when matching an object against this alert configuration
MetricThreshold map[string]string
MetricThresholdConfigs []GetAlertConfigurationsResultMetricThresholdConfig: The threshold that causes an alert to be triggered. Required if event_type_name : OUTSIDE_METRIC_THRESHOLD or OUTSIDE_SERVERLESS_METRIC_THRESHOLD
Notifications []GetAlertConfigurationsResultNotification
ProjectId string: The unique ID for the project to get the alert configurations.
Threshold map[string]string
ThresholdConfigs []GetAlertConfigurationsResultThresholdConfig: Threshold that triggers an alert. Required if event_type_name is any value other than OUTSIDE_METRIC_THRESHOLD or OUTSIDE_SERVERLESS_METRIC_THRESHOLD.
Updated string: Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
Outputs []GetAlertConfigurationsResultOutputType: Requested output string format for the alert configuration

alertConfigurationId String: 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.
eventType String: The type of event that will trigger an alert.
matchers List<GetAlertConfigurationsResultMatcher>: Rules to apply when matching an object against this alert configuration
metricThreshold Map<String,String>
metricThresholdConfigs List<GetAlertConfigurationsResultMetricThresholdConfig>: The threshold that causes an alert to be triggered. Required if event_type_name : OUTSIDE_METRIC_THRESHOLD or OUTSIDE_SERVERLESS_METRIC_THRESHOLD
notifications List<GetAlertConfigurationsResultNotification>
projectId String: The unique ID for the project to get the alert configurations.
threshold Map<String,String>
thresholdConfigs List<GetAlertConfigurationsResultThresholdConfig>: Threshold that triggers an alert. Required if event_type_name is any value other than OUTSIDE_METRIC_THRESHOLD or OUTSIDE_SERVERLESS_METRIC_THRESHOLD.
updated String: Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
outputs List<GetAlertConfigurationsResultOutput>: Requested output string format for the alert configuration

alertConfigurationId string: 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.
eventType string: The type of event that will trigger an alert.
matchers GetAlertConfigurationsResultMatcher[]: Rules to apply when matching an object against this alert configuration
metricThreshold {[key: string]: string}
metricThresholdConfigs GetAlertConfigurationsResultMetricThresholdConfig[]: The threshold that causes an alert to be triggered. Required if event_type_name : OUTSIDE_METRIC_THRESHOLD or OUTSIDE_SERVERLESS_METRIC_THRESHOLD
notifications GetAlertConfigurationsResultNotification[]
projectId string: The unique ID for the project to get the alert configurations.
threshold {[key: string]: string}
thresholdConfigs GetAlertConfigurationsResultThresholdConfig[]: Threshold that triggers an alert. Required if event_type_name is any value other than OUTSIDE_METRIC_THRESHOLD or OUTSIDE_SERVERLESS_METRIC_THRESHOLD.
updated string: Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
outputs GetAlertConfigurationsResultOutput[]: Requested output string format for the alert configuration

alert_configuration_id str: 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[GetAlertConfigurationsResultMatcher]: Rules to apply when matching an object against this alert configuration
metric_threshold Mapping[str, str]
metric_threshold_configs Sequence[GetAlertConfigurationsResultMetricThresholdConfig]: The threshold that causes an alert to be triggered. Required if event_type_name : OUTSIDE_METRIC_THRESHOLD or OUTSIDE_SERVERLESS_METRIC_THRESHOLD
notifications Sequence[GetAlertConfigurationsResultNotification]
project_id str: The unique ID for the project to get the alert configurations.
threshold Mapping[str, str]
threshold_configs Sequence[GetAlertConfigurationsResultThresholdConfig]: Threshold that triggers an alert. Required if event_type_name is any value other than OUTSIDE_METRIC_THRESHOLD or OUTSIDE_SERVERLESS_METRIC_THRESHOLD.
updated str: Timestamp in ISO 8601 date and time format in UTC when this alert configuration was last updated.
outputs Sequence[GetAlertConfigurationsResultOutput]: Requested output string format for the alert configuration

alertConfigurationId String: 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.
eventType 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
metricThreshold Map<String>
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
notifications List<Property Map>
projectId String: The unique ID for the project to get the alert configurations.
threshold Map<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.
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