1. Registry
  2. Packages
  3. Linode Provider
  4. API Docs
  5. MonitorAlertDefinition
Viewing docs for Linode v6.6.0
published on Tuesday, Sep 15, 2026 by Pulumi
linode logo linode logo
Viewing docs for Linode v6.6.0
published on Tuesday, Sep 15, 2026 by Pulumi

    Manages a Monitor Alert Definition. For more information, see the Linode APIv4 docs. (Note: v4beta only.)

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as linode from "@pulumi/linode";
    
    const test = new linode.MonitorAlertDefinition("test", {
        serviceType: "dbaas",
        description: "An alert definition for ansible test",
        label: "test-alert-definition",
        severity: 1,
        channelIds: [10000],
        groupBies: ["entity_id"],
        waitFor: true,
        triggerConditions: {
            criteriaCondition: "ALL",
            evaluationPeriodSeconds: 300,
            pollingIntervalSeconds: 300,
            triggerOccurrences: 1,
        },
        ruleCriteria: {
            rules: [{
                aggregateFunction: "avg",
                dimensionFilters: [{
                    dimensionLabel: "node_type",
                    operator: "eq",
                    value: "primary",
                }],
                metric: "memory_usage",
                operator: "gt",
                threshold: 90,
            }],
        },
    });
    
    import pulumi
    import pulumi_linode as linode
    
    test = linode.MonitorAlertDefinition("test",
        service_type="dbaas",
        description="An alert definition for ansible test",
        label="test-alert-definition",
        severity=1,
        channel_ids=[10000],
        group_bies=["entity_id"],
        wait_for=True,
        trigger_conditions={
            "criteria_condition": "ALL",
            "evaluation_period_seconds": 300,
            "polling_interval_seconds": 300,
            "trigger_occurrences": 1,
        },
        rule_criteria={
            "rules": [{
                "aggregate_function": "avg",
                "dimension_filters": [{
                    "dimension_label": "node_type",
                    "operator": "eq",
                    "value": "primary",
                }],
                "metric": "memory_usage",
                "operator": "gt",
                "threshold": float(90),
            }],
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-linode/sdk/v6/go/linode"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := linode.NewMonitorAlertDefinition(ctx, "test", &linode.MonitorAlertDefinitionArgs{
    			ServiceType: pulumi.String("dbaas"),
    			Description: pulumi.String("An alert definition for ansible test"),
    			Label:       pulumi.String("test-alert-definition"),
    			Severity:    pulumi.Int(1),
    			ChannelIds: pulumi.IntArray{
    				pulumi.Int(10000),
    			},
    			GroupBies: pulumi.StringArray{
    				pulumi.String("entity_id"),
    			},
    			WaitFor: pulumi.Bool(true),
    			TriggerConditions: &linode.MonitorAlertDefinitionTriggerConditionsArgs{
    				CriteriaCondition:       pulumi.String("ALL"),
    				EvaluationPeriodSeconds: pulumi.Int(300),
    				PollingIntervalSeconds:  pulumi.Int(300),
    				TriggerOccurrences:      pulumi.Int(1),
    			},
    			RuleCriteria: &linode.MonitorAlertDefinitionRuleCriteriaArgs{
    				Rules: linode.MonitorAlertDefinitionRuleCriteriaRuleArray{
    					&linode.MonitorAlertDefinitionRuleCriteriaRuleArgs{
    						AggregateFunction: pulumi.String("avg"),
    						DimensionFilters: linode.MonitorAlertDefinitionRuleCriteriaRuleDimensionFilterArray{
    							&linode.MonitorAlertDefinitionRuleCriteriaRuleDimensionFilterArgs{
    								DimensionLabel: pulumi.String("node_type"),
    								Operator:       pulumi.String("eq"),
    								Value:          pulumi.String("primary"),
    							},
    						},
    						Metric:    pulumi.String("memory_usage"),
    						Operator:  pulumi.String("gt"),
    						Threshold: pulumi.Float64(90),
    					},
    				},
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Linode = Pulumi.Linode;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Linode.MonitorAlertDefinition("test", new()
        {
            ServiceType = "dbaas",
            Description = "An alert definition for ansible test",
            Label = "test-alert-definition",
            Severity = 1,
            ChannelIds = new[]
            {
                10000,
            },
            GroupBies = new[]
            {
                "entity_id",
            },
            WaitFor = true,
            TriggerConditions = new Linode.Inputs.MonitorAlertDefinitionTriggerConditionsArgs
            {
                CriteriaCondition = "ALL",
                EvaluationPeriodSeconds = 300,
                PollingIntervalSeconds = 300,
                TriggerOccurrences = 1,
            },
            RuleCriteria = new Linode.Inputs.MonitorAlertDefinitionRuleCriteriaArgs
            {
                Rules = new[]
                {
                    new Linode.Inputs.MonitorAlertDefinitionRuleCriteriaRuleArgs
                    {
                        AggregateFunction = "avg",
                        DimensionFilters = new[]
                        {
                            new Linode.Inputs.MonitorAlertDefinitionRuleCriteriaRuleDimensionFilterArgs
                            {
                                DimensionLabel = "node_type",
                                Operator = "eq",
                                Value = "primary",
                            },
                        },
                        Metric = "memory_usage",
                        Operator = "gt",
                        Threshold = 90,
                    },
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.linode.MonitorAlertDefinition;
    import com.pulumi.linode.MonitorAlertDefinitionArgs;
    import com.pulumi.linode.inputs.MonitorAlertDefinitionTriggerConditionsArgs;
    import com.pulumi.linode.inputs.MonitorAlertDefinitionRuleCriteriaArgs;
    import com.pulumi.linode.inputs.MonitorAlertDefinitionRuleCriteriaRuleArgs;
    import com.pulumi.linode.inputs.MonitorAlertDefinitionRuleCriteriaRuleDimensionFilterArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var test = new MonitorAlertDefinition("test", MonitorAlertDefinitionArgs.builder()
                .serviceType("dbaas")
                .description("An alert definition for ansible test")
                .label("test-alert-definition")
                .severity(1)
                .channelIds(10000)
                .groupBies("entity_id")
                .waitFor(true)
                .triggerConditions(MonitorAlertDefinitionTriggerConditionsArgs.builder()
                    .criteriaCondition("ALL")
                    .evaluationPeriodSeconds(300)
                    .pollingIntervalSeconds(300)
                    .triggerOccurrences(1)
                    .build())
                .ruleCriteria(MonitorAlertDefinitionRuleCriteriaArgs.builder()
                    .rules(MonitorAlertDefinitionRuleCriteriaRuleArgs.builder()
                        .aggregateFunction("avg")
                        .dimensionFilters(MonitorAlertDefinitionRuleCriteriaRuleDimensionFilterArgs.builder()
                            .dimensionLabel("node_type")
                            .operator("eq")
                            .value("primary")
                            .build())
                        .metric("memory_usage")
                        .operator("gt")
                        .threshold(90.0)
                        .build())
                    .build())
                .build());
    
        }
    }
    
    resources:
      test:
        type: linode:MonitorAlertDefinition
        properties:
          serviceType: dbaas
          description: An alert definition for ansible test
          label: test-alert-definition
          severity: 1
          channelIds:
            - 10000
          groupBies:
            - entity_id
          waitFor: true
          triggerConditions:
            criteriaCondition: ALL
            evaluationPeriodSeconds: 300
            pollingIntervalSeconds: 300
            triggerOccurrences: '1'
          ruleCriteria:
            rules:
              - aggregateFunction: avg
                dimensionFilters:
                  - dimensionLabel: node_type
                    operator: eq
                    value: primary
                metric: memory_usage
                operator: gt
                threshold: 90
    
    pulumi {
      required_providers {
        linode = {
          source = "pulumi/linode"
        }
      }
    }
    
    resource "linode_monitoralertdefinition" "test" {
      service_type = "dbaas"
      description  = "An alert definition for ansible test"
      label        = "test-alert-definition"
      severity     = 1
      channel_ids  = [10000]
      group_bies   = ["entity_id"]
      wait_for     = true
      trigger_conditions = {
        criteria_condition        = "ALL"
        evaluation_period_seconds = 300
        polling_interval_seconds  = 300
        trigger_occurrences       = "1"
      }
      rule_criteria = {
        rules = [{
          "aggregateFunction" = "avg"
          "dimensionFilters" = [{
            "dimensionLabel" = "node_type"
            "operator"       = "eq"
            "value"          = "primary"
          }]
          "metric"    = "memory_usage"
          "operator"  = "gt"
          "threshold" = 90
        }]
      }
    }
    

    Create MonitorAlertDefinition Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new MonitorAlertDefinition(name: string, args: MonitorAlertDefinitionArgs, opts?: CustomResourceOptions);
    @overload
    def MonitorAlertDefinition(resource_name: str,
                               args: MonitorAlertDefinitionArgs,
                               opts: Optional[ResourceOptions] = None)
    
    @overload
    def MonitorAlertDefinition(resource_name: str,
                               opts: Optional[ResourceOptions] = None,
                               severity: Optional[int] = None,
                               label: Optional[str] = None,
                               rule_criteria: Optional[MonitorAlertDefinitionRuleCriteriaArgs] = None,
                               service_type: Optional[str] = None,
                               channel_ids: Optional[Sequence[int]] = None,
                               trigger_conditions: Optional[MonitorAlertDefinitionTriggerConditionsArgs] = None,
                               description: Optional[str] = None,
                               entity_ids: Optional[Sequence[str]] = None,
                               group_bies: Optional[Sequence[str]] = None,
                               regions: Optional[Sequence[str]] = None,
                               scope: Optional[str] = None,
                               status: Optional[str] = None,
                               wait_for: Optional[bool] = None)
    func NewMonitorAlertDefinition(ctx *Context, name string, args MonitorAlertDefinitionArgs, opts ...ResourceOption) (*MonitorAlertDefinition, error)
    public MonitorAlertDefinition(string name, MonitorAlertDefinitionArgs args, CustomResourceOptions? opts = null)
    public MonitorAlertDefinition(String name, MonitorAlertDefinitionArgs args)
    public MonitorAlertDefinition(String name, MonitorAlertDefinitionArgs args, CustomResourceOptions options)
    
    type: linode:MonitorAlertDefinition
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "linode_monitor_alert_definition" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args MonitorAlertDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args MonitorAlertDefinitionArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args MonitorAlertDefinitionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args MonitorAlertDefinitionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args MonitorAlertDefinitionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var monitorAlertDefinitionResource = new Linode.MonitorAlertDefinition("monitorAlertDefinitionResource", new()
    {
        Severity = 0,
        Label = "string",
        RuleCriteria = new Linode.Inputs.MonitorAlertDefinitionRuleCriteriaArgs
        {
            Rules = new[]
            {
                new Linode.Inputs.MonitorAlertDefinitionRuleCriteriaRuleArgs
                {
                    AggregateFunction = "string",
                    DimensionFilters = new[]
                    {
                        new Linode.Inputs.MonitorAlertDefinitionRuleCriteriaRuleDimensionFilterArgs
                        {
                            DimensionLabel = "string",
                            Label = "string",
                            Operator = "string",
                            Value = "string",
                        },
                    },
                    Label = "string",
                    Metric = "string",
                    Operator = "string",
                    Threshold = 0.0,
                    Unit = "string",
                },
            },
        },
        ServiceType = "string",
        ChannelIds = new[]
        {
            0,
        },
        TriggerConditions = new Linode.Inputs.MonitorAlertDefinitionTriggerConditionsArgs
        {
            CriteriaCondition = "string",
            EvaluationPeriodSeconds = 0,
            PollingIntervalSeconds = 0,
            TriggerOccurrences = 0,
        },
        Description = "string",
        EntityIds = new[]
        {
            "string",
        },
        GroupBies = new[]
        {
            "string",
        },
        Regions = new[]
        {
            "string",
        },
        Scope = "string",
        Status = "string",
        WaitFor = false,
    });
    
    example, err := linode.NewMonitorAlertDefinition(ctx, "monitorAlertDefinitionResource", &linode.MonitorAlertDefinitionArgs{
    	Severity: pulumi.Int(0),
    	Label:    pulumi.String("string"),
    	RuleCriteria: &linode.MonitorAlertDefinitionRuleCriteriaArgs{
    		Rules: linode.MonitorAlertDefinitionRuleCriteriaRuleArray{
    			&linode.MonitorAlertDefinitionRuleCriteriaRuleArgs{
    				AggregateFunction: pulumi.String("string"),
    				DimensionFilters: linode.MonitorAlertDefinitionRuleCriteriaRuleDimensionFilterArray{
    					&linode.MonitorAlertDefinitionRuleCriteriaRuleDimensionFilterArgs{
    						DimensionLabel: pulumi.String("string"),
    						Label:          pulumi.String("string"),
    						Operator:       pulumi.String("string"),
    						Value:          pulumi.String("string"),
    					},
    				},
    				Label:     pulumi.String("string"),
    				Metric:    pulumi.String("string"),
    				Operator:  pulumi.String("string"),
    				Threshold: pulumi.Float64(0),
    				Unit:      pulumi.String("string"),
    			},
    		},
    	},
    	ServiceType: pulumi.String("string"),
    	ChannelIds: pulumi.IntArray{
    		pulumi.Int(0),
    	},
    	TriggerConditions: &linode.MonitorAlertDefinitionTriggerConditionsArgs{
    		CriteriaCondition:       pulumi.String("string"),
    		EvaluationPeriodSeconds: pulumi.Int(0),
    		PollingIntervalSeconds:  pulumi.Int(0),
    		TriggerOccurrences:      pulumi.Int(0),
    	},
    	Description: pulumi.String("string"),
    	EntityIds: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	GroupBies: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Regions: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Scope:   pulumi.String("string"),
    	Status:  pulumi.String("string"),
    	WaitFor: pulumi.Bool(false),
    })
    
    resource "linode_monitor_alert_definition" "monitorAlertDefinitionResource" {
      lifecycle {
        create_before_destroy = true
      }
      severity = 0
      label    = "string"
      rule_criteria = {
        rules = [{
          aggregate_function = "string"
          dimension_filters = [{
            dimension_label = "string"
            label           = "string"
            operator        = "string"
            value           = "string"
          }]
          label     = "string"
          metric    = "string"
          operator  = "string"
          threshold = 0
          unit      = "string"
        }]
      }
      service_type = "string"
      channel_ids  = [0]
      trigger_conditions = {
        criteria_condition        = "string"
        evaluation_period_seconds = 0
        polling_interval_seconds  = 0
        trigger_occurrences       = 0
      }
      description = "string"
      entity_ids  = ["string"]
      group_bies  = ["string"]
      regions     = ["string"]
      scope       = "string"
      status      = "string"
      wait_for    = false
    }
    
    var monitorAlertDefinitionResource = new MonitorAlertDefinition("monitorAlertDefinitionResource", MonitorAlertDefinitionArgs.builder()
        .severity(0)
        .label("string")
        .ruleCriteria(MonitorAlertDefinitionRuleCriteriaArgs.builder()
            .rules(MonitorAlertDefinitionRuleCriteriaRuleArgs.builder()
                .aggregateFunction("string")
                .dimensionFilters(MonitorAlertDefinitionRuleCriteriaRuleDimensionFilterArgs.builder()
                    .dimensionLabel("string")
                    .label("string")
                    .operator("string")
                    .value("string")
                    .build())
                .label("string")
                .metric("string")
                .operator("string")
                .threshold(0.0)
                .unit("string")
                .build())
            .build())
        .serviceType("string")
        .channelIds(0)
        .triggerConditions(MonitorAlertDefinitionTriggerConditionsArgs.builder()
            .criteriaCondition("string")
            .evaluationPeriodSeconds(0)
            .pollingIntervalSeconds(0)
            .triggerOccurrences(0)
            .build())
        .description("string")
        .entityIds("string")
        .groupBies("string")
        .regions("string")
        .scope("string")
        .status("string")
        .waitFor(false)
        .build());
    
    monitor_alert_definition_resource = linode.MonitorAlertDefinition("monitorAlertDefinitionResource",
        severity=0,
        label="string",
        rule_criteria={
            "rules": [{
                "aggregate_function": "string",
                "dimension_filters": [{
                    "dimension_label": "string",
                    "label": "string",
                    "operator": "string",
                    "value": "string",
                }],
                "label": "string",
                "metric": "string",
                "operator": "string",
                "threshold": float(0),
                "unit": "string",
            }],
        },
        service_type="string",
        channel_ids=[0],
        trigger_conditions={
            "criteria_condition": "string",
            "evaluation_period_seconds": 0,
            "polling_interval_seconds": 0,
            "trigger_occurrences": 0,
        },
        description="string",
        entity_ids=["string"],
        group_bies=["string"],
        regions=["string"],
        scope="string",
        status="string",
        wait_for=False)
    
    const monitorAlertDefinitionResource = new linode.MonitorAlertDefinition("monitorAlertDefinitionResource", {
        severity: 0,
        label: "string",
        ruleCriteria: {
            rules: [{
                aggregateFunction: "string",
                dimensionFilters: [{
                    dimensionLabel: "string",
                    label: "string",
                    operator: "string",
                    value: "string",
                }],
                label: "string",
                metric: "string",
                operator: "string",
                threshold: 0,
                unit: "string",
            }],
        },
        serviceType: "string",
        channelIds: [0],
        triggerConditions: {
            criteriaCondition: "string",
            evaluationPeriodSeconds: 0,
            pollingIntervalSeconds: 0,
            triggerOccurrences: 0,
        },
        description: "string",
        entityIds: ["string"],
        groupBies: ["string"],
        regions: ["string"],
        scope: "string",
        status: "string",
        waitFor: false,
    });
    
    type: linode:MonitorAlertDefinition
    properties:
        channelIds:
            - 0
        description: string
        entityIds:
            - string
        groupBies:
            - string
        label: string
        regions:
            - string
        ruleCriteria:
            rules:
                - aggregateFunction: string
                  dimensionFilters:
                    - dimensionLabel: string
                      label: string
                      operator: string
                      value: string
                  label: string
                  metric: string
                  operator: string
                  threshold: 0
                  unit: string
        scope: string
        serviceType: string
        severity: 0
        status: string
        triggerConditions:
            criteriaCondition: string
            evaluationPeriodSeconds: 0
            pollingIntervalSeconds: 0
            triggerOccurrences: 0
        waitFor: false
    

    MonitorAlertDefinition Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The MonitorAlertDefinition resource accepts the following input properties:

    ChannelIds List<int>
    A list of channel IDs to associate with the alert definition.
    Label string
    The label for the alert definition.
    RuleCriteria MonitorAlertDefinitionRuleCriteria
    Details for the rules required to trigger the alert.
    ServiceType string
    The service type (e.g., dbaas).
    Severity int
    The severity level of the alert definition.

    • ruleCriteria - (Required, Nested Attribute) The criteria expression for the alert. Referenced directly (e.g. rule_criteria.rules).
    • triggerConditions - (Required, Nested Attribute) The conditions that need to be met to send a notification for the alert. Referenced directly (e.g. trigger_conditions.criteria_condition).
    TriggerConditions MonitorAlertDefinitionTriggerConditions
    The conditions that need to be met to send a notification for the alert.
    Description string
    A description for the alert definition.
    EntityIds List<string>
    A list of entity IDs to associate with the alert definition.
    GroupBies List<string>
    A set of dimension fields used to group alert events, such as entityId.
    Regions List<string>
    The regions the alert definition applies to. Only used for region-scoped alerts.
    Scope string
    The scope of the alert definition. Allowed values: account, entity, region. Defaults to entity.
    Status string
    The status of the alert definition.
    WaitFor bool
    Whether to wait for the alert definition to be ready before completing the resource creation.
    ChannelIds []int
    A list of channel IDs to associate with the alert definition.
    Label string
    The label for the alert definition.
    RuleCriteria MonitorAlertDefinitionRuleCriteriaArgs
    Details for the rules required to trigger the alert.
    ServiceType string
    The service type (e.g., dbaas).
    Severity int
    The severity level of the alert definition.

    • ruleCriteria - (Required, Nested Attribute) The criteria expression for the alert. Referenced directly (e.g. rule_criteria.rules).
    • triggerConditions - (Required, Nested Attribute) The conditions that need to be met to send a notification for the alert. Referenced directly (e.g. trigger_conditions.criteria_condition).
    TriggerConditions MonitorAlertDefinitionTriggerConditionsArgs
    The conditions that need to be met to send a notification for the alert.
    Description string
    A description for the alert definition.
    EntityIds []string
    A list of entity IDs to associate with the alert definition.
    GroupBies []string
    A set of dimension fields used to group alert events, such as entityId.
    Regions []string
    The regions the alert definition applies to. Only used for region-scoped alerts.
    Scope string
    The scope of the alert definition. Allowed values: account, entity, region. Defaults to entity.
    Status string
    The status of the alert definition.
    WaitFor bool
    Whether to wait for the alert definition to be ready before completing the resource creation.
    channel_ids list(number)
    A list of channel IDs to associate with the alert definition.
    label string
    The label for the alert definition.
    rule_criteria object
    Details for the rules required to trigger the alert.
    service_type string
    The service type (e.g., dbaas).
    severity number
    The severity level of the alert definition.

    • ruleCriteria - (Required, Nested Attribute) The criteria expression for the alert. Referenced directly (e.g. rule_criteria.rules).
    • triggerConditions - (Required, Nested Attribute) The conditions that need to be met to send a notification for the alert. Referenced directly (e.g. trigger_conditions.criteria_condition).
    trigger_conditions object
    The conditions that need to be met to send a notification for the alert.
    description string
    A description for the alert definition.
    entity_ids list(string)
    A list of entity IDs to associate with the alert definition.
    group_bies list(string)
    A set of dimension fields used to group alert events, such as entityId.
    regions list(string)
    The regions the alert definition applies to. Only used for region-scoped alerts.
    scope string
    The scope of the alert definition. Allowed values: account, entity, region. Defaults to entity.
    status string
    The status of the alert definition.
    wait_for bool
    Whether to wait for the alert definition to be ready before completing the resource creation.
    channelIds List<Integer>
    A list of channel IDs to associate with the alert definition.
    label String
    The label for the alert definition.
    ruleCriteria MonitorAlertDefinitionRuleCriteria
    Details for the rules required to trigger the alert.
    serviceType String
    The service type (e.g., dbaas).
    severity Integer
    The severity level of the alert definition.

    • ruleCriteria - (Required, Nested Attribute) The criteria expression for the alert. Referenced directly (e.g. rule_criteria.rules).
    • triggerConditions - (Required, Nested Attribute) The conditions that need to be met to send a notification for the alert. Referenced directly (e.g. trigger_conditions.criteria_condition).
    triggerConditions MonitorAlertDefinitionTriggerConditions
    The conditions that need to be met to send a notification for the alert.
    description String
    A description for the alert definition.
    entityIds List<String>
    A list of entity IDs to associate with the alert definition.
    groupBies List<String>
    A set of dimension fields used to group alert events, such as entityId.
    regions List<String>
    The regions the alert definition applies to. Only used for region-scoped alerts.
    scope String
    The scope of the alert definition. Allowed values: account, entity, region. Defaults to entity.
    status String
    The status of the alert definition.
    waitFor Boolean
    Whether to wait for the alert definition to be ready before completing the resource creation.
    channelIds number[]
    A list of channel IDs to associate with the alert definition.
    label string
    The label for the alert definition.
    ruleCriteria MonitorAlertDefinitionRuleCriteria
    Details for the rules required to trigger the alert.
    serviceType string
    The service type (e.g., dbaas).
    severity number
    The severity level of the alert definition.

    • ruleCriteria - (Required, Nested Attribute) The criteria expression for the alert. Referenced directly (e.g. rule_criteria.rules).
    • triggerConditions - (Required, Nested Attribute) The conditions that need to be met to send a notification for the alert. Referenced directly (e.g. trigger_conditions.criteria_condition).
    triggerConditions MonitorAlertDefinitionTriggerConditions
    The conditions that need to be met to send a notification for the alert.
    description string
    A description for the alert definition.
    entityIds string[]
    A list of entity IDs to associate with the alert definition.
    groupBies string[]
    A set of dimension fields used to group alert events, such as entityId.
    regions string[]
    The regions the alert definition applies to. Only used for region-scoped alerts.
    scope string
    The scope of the alert definition. Allowed values: account, entity, region. Defaults to entity.
    status string
    The status of the alert definition.
    waitFor boolean
    Whether to wait for the alert definition to be ready before completing the resource creation.
    channel_ids Sequence[int]
    A list of channel IDs to associate with the alert definition.
    label str
    The label for the alert definition.
    rule_criteria MonitorAlertDefinitionRuleCriteriaArgs
    Details for the rules required to trigger the alert.
    service_type str
    The service type (e.g., dbaas).
    severity int
    The severity level of the alert definition.

    • ruleCriteria - (Required, Nested Attribute) The criteria expression for the alert. Referenced directly (e.g. rule_criteria.rules).
    • triggerConditions - (Required, Nested Attribute) The conditions that need to be met to send a notification for the alert. Referenced directly (e.g. trigger_conditions.criteria_condition).
    trigger_conditions MonitorAlertDefinitionTriggerConditionsArgs
    The conditions that need to be met to send a notification for the alert.
    description str
    A description for the alert definition.
    entity_ids Sequence[str]
    A list of entity IDs to associate with the alert definition.
    group_bies Sequence[str]
    A set of dimension fields used to group alert events, such as entityId.
    regions Sequence[str]
    The regions the alert definition applies to. Only used for region-scoped alerts.
    scope str
    The scope of the alert definition. Allowed values: account, entity, region. Defaults to entity.
    status str
    The status of the alert definition.
    wait_for bool
    Whether to wait for the alert definition to be ready before completing the resource creation.
    channelIds List<Number>
    A list of channel IDs to associate with the alert definition.
    label String
    The label for the alert definition.
    ruleCriteria Property Map
    Details for the rules required to trigger the alert.
    serviceType String
    The service type (e.g., dbaas).
    severity Number
    The severity level of the alert definition.

    • ruleCriteria - (Required, Nested Attribute) The criteria expression for the alert. Referenced directly (e.g. rule_criteria.rules).
    • triggerConditions - (Required, Nested Attribute) The conditions that need to be met to send a notification for the alert. Referenced directly (e.g. trigger_conditions.criteria_condition).
    triggerConditions Property Map
    The conditions that need to be met to send a notification for the alert.
    description String
    A description for the alert definition.
    entityIds List<String>
    A list of entity IDs to associate with the alert definition.
    groupBies List<String>
    A set of dimension fields used to group alert events, such as entityId.
    regions List<String>
    The regions the alert definition applies to. Only used for region-scoped alerts.
    scope String
    The scope of the alert definition. Allowed values: account, entity, region. Defaults to entity.
    status String
    The status of the alert definition.
    waitFor Boolean
    Whether to wait for the alert definition to be ready before completing the resource creation.

    Outputs

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

    AlertChannels List<MonitorAlertDefinitionAlertChannel>
    The alert channels set up for use with this alert. Run the List alert channels operation to see all of the available channels.
    Class string
    "The plan type for the Managed Database cluster, either shared or dedicated. This only applies to a system alert for a serviceType of dbaas (Managed Databases). For user alerts for dbaas, this is returned as null.",

    • entities - (Nested Attribute) Entity metadata for the alert definition. Referenced directly (e.g. entities.count).
    • alertChannels - (Nested Attribute List) A list of alert channel objects associated with the alert definition.
    Created string
    The date and time the alert definition was created.
    CreatedBy string
    For a user alert definition, this is the user on your account that created it. For a system alert definition, this is returned as system.
    Entities MonitorAlertDefinitionEntities
    Entity metadata for the alert definition.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    The type of alert channel.
    Updated string
    The date and time the alert definition was last updated.
    UpdatedBy string
    For a user alert definition, this is the user on your account that last updated it. For a system alert definition, this is returned as system. If it hasn't been updated, this value is the same as created_by.
    AlertChannels []MonitorAlertDefinitionAlertChannel
    The alert channels set up for use with this alert. Run the List alert channels operation to see all of the available channels.
    Class string
    "The plan type for the Managed Database cluster, either shared or dedicated. This only applies to a system alert for a serviceType of dbaas (Managed Databases). For user alerts for dbaas, this is returned as null.",

    • entities - (Nested Attribute) Entity metadata for the alert definition. Referenced directly (e.g. entities.count).
    • alertChannels - (Nested Attribute List) A list of alert channel objects associated with the alert definition.
    Created string
    The date and time the alert definition was created.
    CreatedBy string
    For a user alert definition, this is the user on your account that created it. For a system alert definition, this is returned as system.
    Entities MonitorAlertDefinitionEntities
    Entity metadata for the alert definition.
    Id string
    The provider-assigned unique ID for this managed resource.
    Type string
    The type of alert channel.
    Updated string
    The date and time the alert definition was last updated.
    UpdatedBy string
    For a user alert definition, this is the user on your account that last updated it. For a system alert definition, this is returned as system. If it hasn't been updated, this value is the same as created_by.
    alert_channels list(object)
    The alert channels set up for use with this alert. Run the List alert channels operation to see all of the available channels.
    class string
    "The plan type for the Managed Database cluster, either shared or dedicated. This only applies to a system alert for a serviceType of dbaas (Managed Databases). For user alerts for dbaas, this is returned as null.",

    • entities - (Nested Attribute) Entity metadata for the alert definition. Referenced directly (e.g. entities.count).
    • alertChannels - (Nested Attribute List) A list of alert channel objects associated with the alert definition.
    created string
    The date and time the alert definition was created.
    created_by string
    For a user alert definition, this is the user on your account that created it. For a system alert definition, this is returned as system.
    entities object
    Entity metadata for the alert definition.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    The type of alert channel.
    updated string
    The date and time the alert definition was last updated.
    updated_by string
    For a user alert definition, this is the user on your account that last updated it. For a system alert definition, this is returned as system. If it hasn't been updated, this value is the same as created_by.
    alertChannels List<MonitorAlertDefinitionAlertChannel>
    The alert channels set up for use with this alert. Run the List alert channels operation to see all of the available channels.
    class_ String
    "The plan type for the Managed Database cluster, either shared or dedicated. This only applies to a system alert for a serviceType of dbaas (Managed Databases). For user alerts for dbaas, this is returned as null.",

    • entities - (Nested Attribute) Entity metadata for the alert definition. Referenced directly (e.g. entities.count).
    • alertChannels - (Nested Attribute List) A list of alert channel objects associated with the alert definition.
    created String
    The date and time the alert definition was created.
    createdBy String
    For a user alert definition, this is the user on your account that created it. For a system alert definition, this is returned as system.
    entities MonitorAlertDefinitionEntities
    Entity metadata for the alert definition.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    The type of alert channel.
    updated String
    The date and time the alert definition was last updated.
    updatedBy String
    For a user alert definition, this is the user on your account that last updated it. For a system alert definition, this is returned as system. If it hasn't been updated, this value is the same as created_by.
    alertChannels MonitorAlertDefinitionAlertChannel[]
    The alert channels set up for use with this alert. Run the List alert channels operation to see all of the available channels.
    class string
    "The plan type for the Managed Database cluster, either shared or dedicated. This only applies to a system alert for a serviceType of dbaas (Managed Databases). For user alerts for dbaas, this is returned as null.",

    • entities - (Nested Attribute) Entity metadata for the alert definition. Referenced directly (e.g. entities.count).
    • alertChannels - (Nested Attribute List) A list of alert channel objects associated with the alert definition.
    created string
    The date and time the alert definition was created.
    createdBy string
    For a user alert definition, this is the user on your account that created it. For a system alert definition, this is returned as system.
    entities MonitorAlertDefinitionEntities
    Entity metadata for the alert definition.
    id string
    The provider-assigned unique ID for this managed resource.
    type string
    The type of alert channel.
    updated string
    The date and time the alert definition was last updated.
    updatedBy string
    For a user alert definition, this is the user on your account that last updated it. For a system alert definition, this is returned as system. If it hasn't been updated, this value is the same as created_by.
    alert_channels Sequence[MonitorAlertDefinitionAlertChannel]
    The alert channels set up for use with this alert. Run the List alert channels operation to see all of the available channels.
    class_ str
    "The plan type for the Managed Database cluster, either shared or dedicated. This only applies to a system alert for a serviceType of dbaas (Managed Databases). For user alerts for dbaas, this is returned as null.",

    • entities - (Nested Attribute) Entity metadata for the alert definition. Referenced directly (e.g. entities.count).
    • alertChannels - (Nested Attribute List) A list of alert channel objects associated with the alert definition.
    created str
    The date and time the alert definition was created.
    created_by str
    For a user alert definition, this is the user on your account that created it. For a system alert definition, this is returned as system.
    entities MonitorAlertDefinitionEntities
    Entity metadata for the alert definition.
    id str
    The provider-assigned unique ID for this managed resource.
    type str
    The type of alert channel.
    updated str
    The date and time the alert definition was last updated.
    updated_by str
    For a user alert definition, this is the user on your account that last updated it. For a system alert definition, this is returned as system. If it hasn't been updated, this value is the same as created_by.
    alertChannels List<Property Map>
    The alert channels set up for use with this alert. Run the List alert channels operation to see all of the available channels.
    class String
    "The plan type for the Managed Database cluster, either shared or dedicated. This only applies to a system alert for a serviceType of dbaas (Managed Databases). For user alerts for dbaas, this is returned as null.",

    • entities - (Nested Attribute) Entity metadata for the alert definition. Referenced directly (e.g. entities.count).
    • alertChannels - (Nested Attribute List) A list of alert channel objects associated with the alert definition.
    created String
    The date and time the alert definition was created.
    createdBy String
    For a user alert definition, this is the user on your account that created it. For a system alert definition, this is returned as system.
    entities Property Map
    Entity metadata for the alert definition.
    id String
    The provider-assigned unique ID for this managed resource.
    type String
    The type of alert channel.
    updated String
    The date and time the alert definition was last updated.
    updatedBy String
    For a user alert definition, this is the user on your account that last updated it. For a system alert definition, this is returned as system. If it hasn't been updated, this value is the same as created_by.

    Look up Existing MonitorAlertDefinition Resource

    Get an existing MonitorAlertDefinition resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: MonitorAlertDefinitionState, opts?: CustomResourceOptions): MonitorAlertDefinition
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            alert_channels: Optional[Sequence[MonitorAlertDefinitionAlertChannelArgs]] = None,
            channel_ids: Optional[Sequence[int]] = None,
            class_: Optional[str] = None,
            created: Optional[str] = None,
            created_by: Optional[str] = None,
            description: Optional[str] = None,
            entities: Optional[MonitorAlertDefinitionEntitiesArgs] = None,
            entity_ids: Optional[Sequence[str]] = None,
            group_bies: Optional[Sequence[str]] = None,
            label: Optional[str] = None,
            regions: Optional[Sequence[str]] = None,
            rule_criteria: Optional[MonitorAlertDefinitionRuleCriteriaArgs] = None,
            scope: Optional[str] = None,
            service_type: Optional[str] = None,
            severity: Optional[int] = None,
            status: Optional[str] = None,
            trigger_conditions: Optional[MonitorAlertDefinitionTriggerConditionsArgs] = None,
            type: Optional[str] = None,
            updated: Optional[str] = None,
            updated_by: Optional[str] = None,
            wait_for: Optional[bool] = None) -> MonitorAlertDefinition
    func GetMonitorAlertDefinition(ctx *Context, name string, id IDInput, state *MonitorAlertDefinitionState, opts ...ResourceOption) (*MonitorAlertDefinition, error)
    public static MonitorAlertDefinition Get(string name, Input<string> id, MonitorAlertDefinitionState? state, CustomResourceOptions? opts = null)
    public static MonitorAlertDefinition get(String name, Output<String> id, MonitorAlertDefinitionState state, CustomResourceOptions options)
    resources:  _:    type: linode:MonitorAlertDefinition    get:      id: ${id}
    import {
      to = linode_monitor_alert_definition.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AlertChannels List<MonitorAlertDefinitionAlertChannel>
    The alert channels set up for use with this alert. Run the List alert channels operation to see all of the available channels.
    ChannelIds List<int>
    A list of channel IDs to associate with the alert definition.
    Class string
    "The plan type for the Managed Database cluster, either shared or dedicated. This only applies to a system alert for a serviceType of dbaas (Managed Databases). For user alerts for dbaas, this is returned as null.",

    • entities - (Nested Attribute) Entity metadata for the alert definition. Referenced directly (e.g. entities.count).
    • alertChannels - (Nested Attribute List) A list of alert channel objects associated with the alert definition.
    Created string
    The date and time the alert definition was created.
    CreatedBy string
    For a user alert definition, this is the user on your account that created it. For a system alert definition, this is returned as system.
    Description string
    A description for the alert definition.
    Entities MonitorAlertDefinitionEntities
    Entity metadata for the alert definition.
    EntityIds List<string>
    A list of entity IDs to associate with the alert definition.
    GroupBies List<string>
    A set of dimension fields used to group alert events, such as entityId.
    Label string
    The label for the alert definition.
    Regions List<string>
    The regions the alert definition applies to. Only used for region-scoped alerts.
    RuleCriteria MonitorAlertDefinitionRuleCriteria
    Details for the rules required to trigger the alert.
    Scope string
    The scope of the alert definition. Allowed values: account, entity, region. Defaults to entity.
    ServiceType string
    The service type (e.g., dbaas).
    Severity int
    The severity level of the alert definition.

    • ruleCriteria - (Required, Nested Attribute) The criteria expression for the alert. Referenced directly (e.g. rule_criteria.rules).
    • triggerConditions - (Required, Nested Attribute) The conditions that need to be met to send a notification for the alert. Referenced directly (e.g. trigger_conditions.criteria_condition).
    Status string
    The status of the alert definition.
    TriggerConditions MonitorAlertDefinitionTriggerConditions
    The conditions that need to be met to send a notification for the alert.
    Type string
    The type of alert channel.
    Updated string
    The date and time the alert definition was last updated.
    UpdatedBy string
    For a user alert definition, this is the user on your account that last updated it. For a system alert definition, this is returned as system. If it hasn't been updated, this value is the same as created_by.
    WaitFor bool
    Whether to wait for the alert definition to be ready before completing the resource creation.
    AlertChannels []MonitorAlertDefinitionAlertChannelArgs
    The alert channels set up for use with this alert. Run the List alert channels operation to see all of the available channels.
    ChannelIds []int
    A list of channel IDs to associate with the alert definition.
    Class string
    "The plan type for the Managed Database cluster, either shared or dedicated. This only applies to a system alert for a serviceType of dbaas (Managed Databases). For user alerts for dbaas, this is returned as null.",

    • entities - (Nested Attribute) Entity metadata for the alert definition. Referenced directly (e.g. entities.count).
    • alertChannels - (Nested Attribute List) A list of alert channel objects associated with the alert definition.
    Created string
    The date and time the alert definition was created.
    CreatedBy string
    For a user alert definition, this is the user on your account that created it. For a system alert definition, this is returned as system.
    Description string
    A description for the alert definition.
    Entities MonitorAlertDefinitionEntitiesArgs
    Entity metadata for the alert definition.
    EntityIds []string
    A list of entity IDs to associate with the alert definition.
    GroupBies []string
    A set of dimension fields used to group alert events, such as entityId.
    Label string
    The label for the alert definition.
    Regions []string
    The regions the alert definition applies to. Only used for region-scoped alerts.
    RuleCriteria MonitorAlertDefinitionRuleCriteriaArgs
    Details for the rules required to trigger the alert.
    Scope string
    The scope of the alert definition. Allowed values: account, entity, region. Defaults to entity.
    ServiceType string
    The service type (e.g., dbaas).
    Severity int
    The severity level of the alert definition.

    • ruleCriteria - (Required, Nested Attribute) The criteria expression for the alert. Referenced directly (e.g. rule_criteria.rules).
    • triggerConditions - (Required, Nested Attribute) The conditions that need to be met to send a notification for the alert. Referenced directly (e.g. trigger_conditions.criteria_condition).
    Status string
    The status of the alert definition.
    TriggerConditions MonitorAlertDefinitionTriggerConditionsArgs
    The conditions that need to be met to send a notification for the alert.
    Type string
    The type of alert channel.
    Updated string
    The date and time the alert definition was last updated.
    UpdatedBy string
    For a user alert definition, this is the user on your account that last updated it. For a system alert definition, this is returned as system. If it hasn't been updated, this value is the same as created_by.
    WaitFor bool
    Whether to wait for the alert definition to be ready before completing the resource creation.
    alert_channels list(object)
    The alert channels set up for use with this alert. Run the List alert channels operation to see all of the available channels.
    channel_ids list(number)
    A list of channel IDs to associate with the alert definition.
    class string
    "The plan type for the Managed Database cluster, either shared or dedicated. This only applies to a system alert for a serviceType of dbaas (Managed Databases). For user alerts for dbaas, this is returned as null.",

    • entities - (Nested Attribute) Entity metadata for the alert definition. Referenced directly (e.g. entities.count).
    • alertChannels - (Nested Attribute List) A list of alert channel objects associated with the alert definition.
    created string
    The date and time the alert definition was created.
    created_by string
    For a user alert definition, this is the user on your account that created it. For a system alert definition, this is returned as system.
    description string
    A description for the alert definition.
    entities object
    Entity metadata for the alert definition.
    entity_ids list(string)
    A list of entity IDs to associate with the alert definition.
    group_bies list(string)
    A set of dimension fields used to group alert events, such as entityId.
    label string
    The label for the alert definition.
    regions list(string)
    The regions the alert definition applies to. Only used for region-scoped alerts.
    rule_criteria object
    Details for the rules required to trigger the alert.
    scope string
    The scope of the alert definition. Allowed values: account, entity, region. Defaults to entity.
    service_type string
    The service type (e.g., dbaas).
    severity number
    The severity level of the alert definition.

    • ruleCriteria - (Required, Nested Attribute) The criteria expression for the alert. Referenced directly (e.g. rule_criteria.rules).
    • triggerConditions - (Required, Nested Attribute) The conditions that need to be met to send a notification for the alert. Referenced directly (e.g. trigger_conditions.criteria_condition).
    status string
    The status of the alert definition.
    trigger_conditions object
    The conditions that need to be met to send a notification for the alert.
    type string
    The type of alert channel.
    updated string
    The date and time the alert definition was last updated.
    updated_by string
    For a user alert definition, this is the user on your account that last updated it. For a system alert definition, this is returned as system. If it hasn't been updated, this value is the same as created_by.
    wait_for bool
    Whether to wait for the alert definition to be ready before completing the resource creation.
    alertChannels List<MonitorAlertDefinitionAlertChannel>
    The alert channels set up for use with this alert. Run the List alert channels operation to see all of the available channels.
    channelIds List<Integer>
    A list of channel IDs to associate with the alert definition.
    class_ String
    "The plan type for the Managed Database cluster, either shared or dedicated. This only applies to a system alert for a serviceType of dbaas (Managed Databases). For user alerts for dbaas, this is returned as null.",

    • entities - (Nested Attribute) Entity metadata for the alert definition. Referenced directly (e.g. entities.count).
    • alertChannels - (Nested Attribute List) A list of alert channel objects associated with the alert definition.
    created String
    The date and time the alert definition was created.
    createdBy String
    For a user alert definition, this is the user on your account that created it. For a system alert definition, this is returned as system.
    description String
    A description for the alert definition.
    entities MonitorAlertDefinitionEntities
    Entity metadata for the alert definition.
    entityIds List<String>
    A list of entity IDs to associate with the alert definition.
    groupBies List<String>
    A set of dimension fields used to group alert events, such as entityId.
    label String
    The label for the alert definition.
    regions List<String>
    The regions the alert definition applies to. Only used for region-scoped alerts.
    ruleCriteria MonitorAlertDefinitionRuleCriteria
    Details for the rules required to trigger the alert.
    scope String
    The scope of the alert definition. Allowed values: account, entity, region. Defaults to entity.
    serviceType String
    The service type (e.g., dbaas).
    severity Integer
    The severity level of the alert definition.

    • ruleCriteria - (Required, Nested Attribute) The criteria expression for the alert. Referenced directly (e.g. rule_criteria.rules).
    • triggerConditions - (Required, Nested Attribute) The conditions that need to be met to send a notification for the alert. Referenced directly (e.g. trigger_conditions.criteria_condition).
    status String
    The status of the alert definition.
    triggerConditions MonitorAlertDefinitionTriggerConditions
    The conditions that need to be met to send a notification for the alert.
    type String
    The type of alert channel.
    updated String
    The date and time the alert definition was last updated.
    updatedBy String
    For a user alert definition, this is the user on your account that last updated it. For a system alert definition, this is returned as system. If it hasn't been updated, this value is the same as created_by.
    waitFor Boolean
    Whether to wait for the alert definition to be ready before completing the resource creation.
    alertChannels MonitorAlertDefinitionAlertChannel[]
    The alert channels set up for use with this alert. Run the List alert channels operation to see all of the available channels.
    channelIds number[]
    A list of channel IDs to associate with the alert definition.
    class string
    "The plan type for the Managed Database cluster, either shared or dedicated. This only applies to a system alert for a serviceType of dbaas (Managed Databases). For user alerts for dbaas, this is returned as null.",

    • entities - (Nested Attribute) Entity metadata for the alert definition. Referenced directly (e.g. entities.count).
    • alertChannels - (Nested Attribute List) A list of alert channel objects associated with the alert definition.
    created string
    The date and time the alert definition was created.
    createdBy string
    For a user alert definition, this is the user on your account that created it. For a system alert definition, this is returned as system.
    description string
    A description for the alert definition.
    entities MonitorAlertDefinitionEntities
    Entity metadata for the alert definition.
    entityIds string[]
    A list of entity IDs to associate with the alert definition.
    groupBies string[]
    A set of dimension fields used to group alert events, such as entityId.
    label string
    The label for the alert definition.
    regions string[]
    The regions the alert definition applies to. Only used for region-scoped alerts.
    ruleCriteria MonitorAlertDefinitionRuleCriteria
    Details for the rules required to trigger the alert.
    scope string
    The scope of the alert definition. Allowed values: account, entity, region. Defaults to entity.
    serviceType string
    The service type (e.g., dbaas).
    severity number
    The severity level of the alert definition.

    • ruleCriteria - (Required, Nested Attribute) The criteria expression for the alert. Referenced directly (e.g. rule_criteria.rules).
    • triggerConditions - (Required, Nested Attribute) The conditions that need to be met to send a notification for the alert. Referenced directly (e.g. trigger_conditions.criteria_condition).
    status string
    The status of the alert definition.
    triggerConditions MonitorAlertDefinitionTriggerConditions
    The conditions that need to be met to send a notification for the alert.
    type string
    The type of alert channel.
    updated string
    The date and time the alert definition was last updated.
    updatedBy string
    For a user alert definition, this is the user on your account that last updated it. For a system alert definition, this is returned as system. If it hasn't been updated, this value is the same as created_by.
    waitFor boolean
    Whether to wait for the alert definition to be ready before completing the resource creation.
    alert_channels Sequence[MonitorAlertDefinitionAlertChannelArgs]
    The alert channels set up for use with this alert. Run the List alert channels operation to see all of the available channels.
    channel_ids Sequence[int]
    A list of channel IDs to associate with the alert definition.
    class_ str
    "The plan type for the Managed Database cluster, either shared or dedicated. This only applies to a system alert for a serviceType of dbaas (Managed Databases). For user alerts for dbaas, this is returned as null.",

    • entities - (Nested Attribute) Entity metadata for the alert definition. Referenced directly (e.g. entities.count).
    • alertChannels - (Nested Attribute List) A list of alert channel objects associated with the alert definition.
    created str
    The date and time the alert definition was created.
    created_by str
    For a user alert definition, this is the user on your account that created it. For a system alert definition, this is returned as system.
    description str
    A description for the alert definition.
    entities MonitorAlertDefinitionEntitiesArgs
    Entity metadata for the alert definition.
    entity_ids Sequence[str]
    A list of entity IDs to associate with the alert definition.
    group_bies Sequence[str]
    A set of dimension fields used to group alert events, such as entityId.
    label str
    The label for the alert definition.
    regions Sequence[str]
    The regions the alert definition applies to. Only used for region-scoped alerts.
    rule_criteria MonitorAlertDefinitionRuleCriteriaArgs
    Details for the rules required to trigger the alert.
    scope str
    The scope of the alert definition. Allowed values: account, entity, region. Defaults to entity.
    service_type str
    The service type (e.g., dbaas).
    severity int
    The severity level of the alert definition.

    • ruleCriteria - (Required, Nested Attribute) The criteria expression for the alert. Referenced directly (e.g. rule_criteria.rules).
    • triggerConditions - (Required, Nested Attribute) The conditions that need to be met to send a notification for the alert. Referenced directly (e.g. trigger_conditions.criteria_condition).
    status str
    The status of the alert definition.
    trigger_conditions MonitorAlertDefinitionTriggerConditionsArgs
    The conditions that need to be met to send a notification for the alert.
    type str
    The type of alert channel.
    updated str
    The date and time the alert definition was last updated.
    updated_by str
    For a user alert definition, this is the user on your account that last updated it. For a system alert definition, this is returned as system. If it hasn't been updated, this value is the same as created_by.
    wait_for bool
    Whether to wait for the alert definition to be ready before completing the resource creation.
    alertChannels List<Property Map>
    The alert channels set up for use with this alert. Run the List alert channels operation to see all of the available channels.
    channelIds List<Number>
    A list of channel IDs to associate with the alert definition.
    class String
    "The plan type for the Managed Database cluster, either shared or dedicated. This only applies to a system alert for a serviceType of dbaas (Managed Databases). For user alerts for dbaas, this is returned as null.",

    • entities - (Nested Attribute) Entity metadata for the alert definition. Referenced directly (e.g. entities.count).
    • alertChannels - (Nested Attribute List) A list of alert channel objects associated with the alert definition.
    created String
    The date and time the alert definition was created.
    createdBy String
    For a user alert definition, this is the user on your account that created it. For a system alert definition, this is returned as system.
    description String
    A description for the alert definition.
    entities Property Map
    Entity metadata for the alert definition.
    entityIds List<String>
    A list of entity IDs to associate with the alert definition.
    groupBies List<String>
    A set of dimension fields used to group alert events, such as entityId.
    label String
    The label for the alert definition.
    regions List<String>
    The regions the alert definition applies to. Only used for region-scoped alerts.
    ruleCriteria Property Map
    Details for the rules required to trigger the alert.
    scope String
    The scope of the alert definition. Allowed values: account, entity, region. Defaults to entity.
    serviceType String
    The service type (e.g., dbaas).
    severity Number
    The severity level of the alert definition.

    • ruleCriteria - (Required, Nested Attribute) The criteria expression for the alert. Referenced directly (e.g. rule_criteria.rules).
    • triggerConditions - (Required, Nested Attribute) The conditions that need to be met to send a notification for the alert. Referenced directly (e.g. trigger_conditions.criteria_condition).
    status String
    The status of the alert definition.
    triggerConditions Property Map
    The conditions that need to be met to send a notification for the alert.
    type String
    The type of alert channel.
    updated String
    The date and time the alert definition was last updated.
    updatedBy String
    For a user alert definition, this is the user on your account that last updated it. For a system alert definition, this is returned as system. If it hasn't been updated, this value is the same as created_by.
    waitFor Boolean
    Whether to wait for the alert definition to be ready before completing the resource creation.

    Supporting Types

    MonitorAlertDefinitionAlertChannel, MonitorAlertDefinitionAlertChannelArgs

    Id int
    The unique identifier assigned to the alert channel.
    Label string
    The label for the alert definition.
    Type string
    The type of alert channel.
    Url string
    The URL of the alert channel.
    Id int
    The unique identifier assigned to the alert channel.
    Label string
    The label for the alert definition.
    Type string
    The type of alert channel.
    Url string
    The URL of the alert channel.
    id number
    The unique identifier assigned to the alert channel.
    label string
    The label for the alert definition.
    type string
    The type of alert channel.
    url string
    The URL of the alert channel.
    id Integer
    The unique identifier assigned to the alert channel.
    label String
    The label for the alert definition.
    type String
    The type of alert channel.
    url String
    The URL of the alert channel.
    id number
    The unique identifier assigned to the alert channel.
    label string
    The label for the alert definition.
    type string
    The type of alert channel.
    url string
    The URL of the alert channel.
    id int
    The unique identifier assigned to the alert channel.
    label str
    The label for the alert definition.
    type str
    The type of alert channel.
    url str
    The URL of the alert channel.
    id Number
    The unique identifier assigned to the alert channel.
    label String
    The label for the alert definition.
    type String
    The type of alert channel.
    url String
    The URL of the alert channel.

    MonitorAlertDefinitionEntities, MonitorAlertDefinitionEntitiesArgs

    Count int
    The number of entities associated with the alert definition.
    HasMoreResources bool
    Whether there are additional entities associated with the alert.
    Url string
    The URL of the alert channel.
    Count int
    The number of entities associated with the alert definition.
    HasMoreResources bool
    Whether there are additional entities associated with the alert.
    Url string
    The URL of the alert channel.
    count number
    The number of entities associated with the alert definition.
    has_more_resources bool
    Whether there are additional entities associated with the alert.
    url string
    The URL of the alert channel.
    count Integer
    The number of entities associated with the alert definition.
    hasMoreResources Boolean
    Whether there are additional entities associated with the alert.
    url String
    The URL of the alert channel.
    count number
    The number of entities associated with the alert definition.
    hasMoreResources boolean
    Whether there are additional entities associated with the alert.
    url string
    The URL of the alert channel.
    count int
    The number of entities associated with the alert definition.
    has_more_resources bool
    Whether there are additional entities associated with the alert.
    url str
    The URL of the alert channel.
    count Number
    The number of entities associated with the alert definition.
    hasMoreResources Boolean
    Whether there are additional entities associated with the alert.
    url String
    The URL of the alert channel.

    MonitorAlertDefinitionRuleCriteria, MonitorAlertDefinitionRuleCriteriaArgs

    Rules List<MonitorAlertDefinitionRuleCriteriaRule>
    The individual rules that make up the alert definition.
    Rules []MonitorAlertDefinitionRuleCriteriaRule
    The individual rules that make up the alert definition.
    rules list(object)
    The individual rules that make up the alert definition.
    rules List<MonitorAlertDefinitionRuleCriteriaRule>
    The individual rules that make up the alert definition.
    rules MonitorAlertDefinitionRuleCriteriaRule[]
    The individual rules that make up the alert definition.
    rules Sequence[MonitorAlertDefinitionRuleCriteriaRule]
    The individual rules that make up the alert definition.
    rules List<Property Map>
    The individual rules that make up the alert definition.

    MonitorAlertDefinitionRuleCriteriaRule, MonitorAlertDefinitionRuleCriteriaRuleArgs

    AggregateFunction string
    The aggregate function to apply to the metric data.

    • dimensionFilters - (Optional, Nested Attribute List) A list of dimension filter objects to filter the metric data.
    DimensionFilters List<MonitorAlertDefinitionRuleCriteriaRuleDimensionFilter>
    Individual objects that define dimension filters for the rule.
    Label string
    The name of the individual rule. This is used for display purposes in Akamai Cloud Manager.
    Metric string
    The metric to query.
    Operator string
    The operator to apply to the metric. Allowed values: eq, gt, lt, gte, lte.
    Threshold double
    The predefined value or condition that triggers an alert when met or exceeded.
    Unit string
    The unit of the metric. This can be values like percent for percentage or GB for gigabyte.
    AggregateFunction string
    The aggregate function to apply to the metric data.

    • dimensionFilters - (Optional, Nested Attribute List) A list of dimension filter objects to filter the metric data.
    DimensionFilters []MonitorAlertDefinitionRuleCriteriaRuleDimensionFilter
    Individual objects that define dimension filters for the rule.
    Label string
    The name of the individual rule. This is used for display purposes in Akamai Cloud Manager.
    Metric string
    The metric to query.
    Operator string
    The operator to apply to the metric. Allowed values: eq, gt, lt, gte, lte.
    Threshold float64
    The predefined value or condition that triggers an alert when met or exceeded.
    Unit string
    The unit of the metric. This can be values like percent for percentage or GB for gigabyte.
    aggregate_function string
    The aggregate function to apply to the metric data.

    • dimensionFilters - (Optional, Nested Attribute List) A list of dimension filter objects to filter the metric data.
    dimension_filters list(object)
    Individual objects that define dimension filters for the rule.
    label string
    The name of the individual rule. This is used for display purposes in Akamai Cloud Manager.
    metric string
    The metric to query.
    operator string
    The operator to apply to the metric. Allowed values: eq, gt, lt, gte, lte.
    threshold number
    The predefined value or condition that triggers an alert when met or exceeded.
    unit string
    The unit of the metric. This can be values like percent for percentage or GB for gigabyte.
    aggregateFunction String
    The aggregate function to apply to the metric data.

    • dimensionFilters - (Optional, Nested Attribute List) A list of dimension filter objects to filter the metric data.
    dimensionFilters List<MonitorAlertDefinitionRuleCriteriaRuleDimensionFilter>
    Individual objects that define dimension filters for the rule.
    label String
    The name of the individual rule. This is used for display purposes in Akamai Cloud Manager.
    metric String
    The metric to query.
    operator String
    The operator to apply to the metric. Allowed values: eq, gt, lt, gte, lte.
    threshold Double
    The predefined value or condition that triggers an alert when met or exceeded.
    unit String
    The unit of the metric. This can be values like percent for percentage or GB for gigabyte.
    aggregateFunction string
    The aggregate function to apply to the metric data.

    • dimensionFilters - (Optional, Nested Attribute List) A list of dimension filter objects to filter the metric data.
    dimensionFilters MonitorAlertDefinitionRuleCriteriaRuleDimensionFilter[]
    Individual objects that define dimension filters for the rule.
    label string
    The name of the individual rule. This is used for display purposes in Akamai Cloud Manager.
    metric string
    The metric to query.
    operator string
    The operator to apply to the metric. Allowed values: eq, gt, lt, gte, lte.
    threshold number
    The predefined value or condition that triggers an alert when met or exceeded.
    unit string
    The unit of the metric. This can be values like percent for percentage or GB for gigabyte.
    aggregate_function str
    The aggregate function to apply to the metric data.

    • dimensionFilters - (Optional, Nested Attribute List) A list of dimension filter objects to filter the metric data.
    dimension_filters Sequence[MonitorAlertDefinitionRuleCriteriaRuleDimensionFilter]
    Individual objects that define dimension filters for the rule.
    label str
    The name of the individual rule. This is used for display purposes in Akamai Cloud Manager.
    metric str
    The metric to query.
    operator str
    The operator to apply to the metric. Allowed values: eq, gt, lt, gte, lte.
    threshold float
    The predefined value or condition that triggers an alert when met or exceeded.
    unit str
    The unit of the metric. This can be values like percent for percentage or GB for gigabyte.
    aggregateFunction String
    The aggregate function to apply to the metric data.

    • dimensionFilters - (Optional, Nested Attribute List) A list of dimension filter objects to filter the metric data.
    dimensionFilters List<Property Map>
    Individual objects that define dimension filters for the rule.
    label String
    The name of the individual rule. This is used for display purposes in Akamai Cloud Manager.
    metric String
    The metric to query.
    operator String
    The operator to apply to the metric. Allowed values: eq, gt, lt, gte, lte.
    threshold Number
    The predefined value or condition that triggers an alert when met or exceeded.
    unit String
    The unit of the metric. This can be values like percent for percentage or GB for gigabyte.

    MonitorAlertDefinitionRuleCriteriaRuleDimensionFilter, MonitorAlertDefinitionRuleCriteriaRuleDimensionFilterArgs

    DimensionLabel string
    The label of the dimension to filter on.
    Label string
    The name of the dimension filter. Used for display purposes.
    Operator string
    The operator to apply to the dimension. Allowed values: eq, neq, startswith, endswith.
    Value string
    The value to compare the dimensionLabel against.
    DimensionLabel string
    The label of the dimension to filter on.
    Label string
    The name of the dimension filter. Used for display purposes.
    Operator string
    The operator to apply to the dimension. Allowed values: eq, neq, startswith, endswith.
    Value string
    The value to compare the dimensionLabel against.
    dimension_label string
    The label of the dimension to filter on.
    label string
    The name of the dimension filter. Used for display purposes.
    operator string
    The operator to apply to the dimension. Allowed values: eq, neq, startswith, endswith.
    value string
    The value to compare the dimensionLabel against.
    dimensionLabel String
    The label of the dimension to filter on.
    label String
    The name of the dimension filter. Used for display purposes.
    operator String
    The operator to apply to the dimension. Allowed values: eq, neq, startswith, endswith.
    value String
    The value to compare the dimensionLabel against.
    dimensionLabel string
    The label of the dimension to filter on.
    label string
    The name of the dimension filter. Used for display purposes.
    operator string
    The operator to apply to the dimension. Allowed values: eq, neq, startswith, endswith.
    value string
    The value to compare the dimensionLabel against.
    dimension_label str
    The label of the dimension to filter on.
    label str
    The name of the dimension filter. Used for display purposes.
    operator str
    The operator to apply to the dimension. Allowed values: eq, neq, startswith, endswith.
    value str
    The value to compare the dimensionLabel against.
    dimensionLabel String
    The label of the dimension to filter on.
    label String
    The name of the dimension filter. Used for display purposes.
    operator String
    The operator to apply to the dimension. Allowed values: eq, neq, startswith, endswith.
    value String
    The value to compare the dimensionLabel against.

    MonitorAlertDefinitionTriggerConditions, MonitorAlertDefinitionTriggerConditionsArgs

    CriteriaCondition string
    The logical operation applied. Currently only 'ALL' allowed.
    EvaluationPeriodSeconds int
    Time period over which data is collected before evaluating the threshold.
    PollingIntervalSeconds int
    Frequency at which the metric data is polled.
    TriggerOccurrences int
    Number of times the condition must be met before triggering an alert.
    CriteriaCondition string
    The logical operation applied. Currently only 'ALL' allowed.
    EvaluationPeriodSeconds int
    Time period over which data is collected before evaluating the threshold.
    PollingIntervalSeconds int
    Frequency at which the metric data is polled.
    TriggerOccurrences int
    Number of times the condition must be met before triggering an alert.
    criteria_condition string
    The logical operation applied. Currently only 'ALL' allowed.
    evaluation_period_seconds number
    Time period over which data is collected before evaluating the threshold.
    polling_interval_seconds number
    Frequency at which the metric data is polled.
    trigger_occurrences number
    Number of times the condition must be met before triggering an alert.
    criteriaCondition String
    The logical operation applied. Currently only 'ALL' allowed.
    evaluationPeriodSeconds Integer
    Time period over which data is collected before evaluating the threshold.
    pollingIntervalSeconds Integer
    Frequency at which the metric data is polled.
    triggerOccurrences Integer
    Number of times the condition must be met before triggering an alert.
    criteriaCondition string
    The logical operation applied. Currently only 'ALL' allowed.
    evaluationPeriodSeconds number
    Time period over which data is collected before evaluating the threshold.
    pollingIntervalSeconds number
    Frequency at which the metric data is polled.
    triggerOccurrences number
    Number of times the condition must be met before triggering an alert.
    criteria_condition str
    The logical operation applied. Currently only 'ALL' allowed.
    evaluation_period_seconds int
    Time period over which data is collected before evaluating the threshold.
    polling_interval_seconds int
    Frequency at which the metric data is polled.
    trigger_occurrences int
    Number of times the condition must be met before triggering an alert.
    criteriaCondition String
    The logical operation applied. Currently only 'ALL' allowed.
    evaluationPeriodSeconds Number
    Time period over which data is collected before evaluating the threshold.
    pollingIntervalSeconds Number
    Frequency at which the metric data is polled.
    triggerOccurrences Number
    Number of times the condition must be met before triggering an alert.

    Import

    Monitor Alert Definitions can be imported using the id and service type, e.g. id,service_type, e.g.

    $ pulumi import linode:index/monitorAlertDefinition:MonitorAlertDefinition example 12345,dbaas
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Linode pulumi/pulumi-linode
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the linode Terraform Provider.
    linode logo linode logo
    Viewing docs for Linode v6.6.0
    published on Tuesday, Sep 15, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial