Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Wavefront Provider
  3. API Docs
  4. Alert
Wavefront v3.1.6 published on Thursday, Oct 31, 2024 by Pulumi
pulumi/pulumi-wavefront

wavefront.Alert

Explore with Pulumi AI

wavefront logo
Wavefront v3.1.6 published on Thursday, Oct 31, 2024 by Pulumi
pulumi/pulumi-wavefront

    Provides a Wavefront Alert resource. This allows alerts to be created, updated, and deleted.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as wavefront from "@pulumi/wavefront";

const foobar = new wavefront.Alert("foobar", {
    name: "Test Alert",
    target: "test@example.com,target:alert-target-id",
    condition: "100-ts(\"cpu.usage_idle\", environment=preprod and cpu=cpu-total ) > 80",
    displayExpression: "100-ts(\"cpu.usage_idle\", environment=preprod and cpu=cpu-total )",
    minutes: 5,
    resolveAfterMinutes: 5,
    severity: "WARN",
    tags: [
        "terraform",
        "test",
    ],
});

    import pulumi
import pulumi_wavefront as wavefront

foobar = wavefront.Alert("foobar",
    name="Test Alert",
    target="test@example.com,target:alert-target-id",
    condition="100-ts(\"cpu.usage_idle\", environment=preprod and cpu=cpu-total ) > 80",
    display_expression="100-ts(\"cpu.usage_idle\", environment=preprod and cpu=cpu-total )",
    minutes=5,
    resolve_after_minutes=5,
    severity="WARN",
    tags=[
        "terraform",
        "test",
    ])

    package main

import (
	"github.com/pulumi/pulumi-wavefront/sdk/v3/go/wavefront"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := wavefront.NewAlert(ctx, "foobar", &wavefront.AlertArgs{
			Name:                pulumi.String("Test Alert"),
			Target:              pulumi.String("test@example.com,target:alert-target-id"),
			Condition:           pulumi.String("100-ts(\"cpu.usage_idle\", environment=preprod and cpu=cpu-total ) > 80"),
			DisplayExpression:   pulumi.String("100-ts(\"cpu.usage_idle\", environment=preprod and cpu=cpu-total )"),
			Minutes:             pulumi.Int(5),
			ResolveAfterMinutes: pulumi.Int(5),
			Severity:            pulumi.String("WARN"),
			Tags: pulumi.StringArray{
				pulumi.String("terraform"),
				pulumi.String("test"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Wavefront = Pulumi.Wavefront;

return await Deployment.RunAsync(() => 
{
    var foobar = new Wavefront.Alert("foobar", new()
    {
        Name = "Test Alert",
        Target = "test@example.com,target:alert-target-id",
        Condition = "100-ts(\"cpu.usage_idle\", environment=preprod and cpu=cpu-total ) > 80",
        DisplayExpression = "100-ts(\"cpu.usage_idle\", environment=preprod and cpu=cpu-total )",
        Minutes = 5,
        ResolveAfterMinutes = 5,
        Severity = "WARN",
        Tags = new[]
        {
            "terraform",
            "test",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.wavefront.Alert;
import com.pulumi.wavefront.AlertArgs;
import java.util.List;
import java.util.ArrayList;
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 foobar = new Alert("foobar", AlertArgs.builder()
            .name("Test Alert")
            .target("test@example.com,target:alert-target-id")
            .condition("100-ts(\"cpu.usage_idle\", environment=preprod and cpu=cpu-total ) > 80")
            .displayExpression("100-ts(\"cpu.usage_idle\", environment=preprod and cpu=cpu-total )")
            .minutes(5)
            .resolveAfterMinutes(5)
            .severity("WARN")
            .tags(            
                "terraform",
                "test")
            .build());

    }
}

    resources:
  foobar:
    type: wavefront:Alert
    properties:
      name: Test Alert
      target: test@example.com,target:alert-target-id
      condition: 100-ts("cpu.usage_idle", environment=preprod and cpu=cpu-total ) > 80
      displayExpression: 100-ts("cpu.usage_idle", environment=preprod and cpu=cpu-total )
      minutes: 5
      resolveAfterMinutes: 5
      severity: WARN
      tags:
        - terraform
        - test

    Create Alert Resource

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

    Constructor syntax

    new Alert(name: string, args: AlertArgs, opts?: CustomResourceOptions);
    @overload
def Alert(resource_name: str,
          args: AlertArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def Alert(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          minutes: Optional[int] = None,
          tags: Optional[Sequence[str]] = None,
          can_views: Optional[Sequence[str]] = None,
          name: Optional[str] = None,
          additional_information: Optional[str] = None,
          condition: Optional[str] = None,
          conditions: Optional[Mapping[str, str]] = None,
          display_expression: Optional[str] = None,
          alert_type: Optional[str] = None,
          can_modifies: Optional[Sequence[str]] = None,
          notification_resend_frequency_minutes: Optional[int] = None,
          process_rate_minutes: Optional[int] = None,
          resolve_after_minutes: Optional[int] = None,
          runbook_links: Optional[Sequence[str]] = None,
          severity: Optional[str] = None,
          alert_triage_dashboards: Optional[Sequence[AlertAlertTriageDashboardArgs]] = None,
          target: Optional[str] = None,
          threshold_targets: Optional[Mapping[str, str]] = None)
    func NewAlert(ctx *Context, name string, args AlertArgs, opts ...ResourceOption) (*Alert, error)
    public Alert(string name, AlertArgs args, CustomResourceOptions? opts = null)
    public Alert(String name, AlertArgs args)
public Alert(String name, AlertArgs args, CustomResourceOptions options)

    type: wavefront:Alert
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args AlertArgs
    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 AlertArgs
    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 AlertArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AlertArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AlertArgs
    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 alertResource = new Wavefront.Alert("alertResource", new()
{
    Minutes = 0,
    Tags = new[]
    {
        "string",
    },
    CanViews = new[]
    {
        "string",
    },
    Name = "string",
    AdditionalInformation = "string",
    Condition = "string",
    Conditions = 
    {
        { "string", "string" },
    },
    DisplayExpression = "string",
    AlertType = "string",
    CanModifies = new[]
    {
        "string",
    },
    NotificationResendFrequencyMinutes = 0,
    ProcessRateMinutes = 0,
    ResolveAfterMinutes = 0,
    RunbookLinks = new[]
    {
        "string",
    },
    Severity = "string",
    AlertTriageDashboards = new[]
    {
        new Wavefront.Inputs.AlertAlertTriageDashboardArgs
        {
            DashboardId = "string",
            Description = "string",
            Parameters = new Wavefront.Inputs.AlertAlertTriageDashboardParametersArgs
            {
                Constants = 
                {
                    { "string", "string" },
                },
            },
        },
    },
    Target = "string",
    ThresholdTargets = 
    {
        { "string", "string" },
    },
});

    example, err := wavefront.NewAlert(ctx, "alertResource", &wavefront.AlertArgs{
	Minutes: pulumi.Int(0),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	CanViews: pulumi.StringArray{
		pulumi.String("string"),
	},
	Name:                  pulumi.String("string"),
	AdditionalInformation: pulumi.String("string"),
	Condition:             pulumi.String("string"),
	Conditions: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	DisplayExpression: pulumi.String("string"),
	AlertType:         pulumi.String("string"),
	CanModifies: pulumi.StringArray{
		pulumi.String("string"),
	},
	NotificationResendFrequencyMinutes: pulumi.Int(0),
	ProcessRateMinutes:                 pulumi.Int(0),
	ResolveAfterMinutes:                pulumi.Int(0),
	RunbookLinks: pulumi.StringArray{
		pulumi.String("string"),
	},
	Severity: pulumi.String("string"),
	AlertTriageDashboards: wavefront.AlertAlertTriageDashboardArray{
		&wavefront.AlertAlertTriageDashboardArgs{
			DashboardId: pulumi.String("string"),
			Description: pulumi.String("string"),
			Parameters: &wavefront.AlertAlertTriageDashboardParametersArgs{
				Constants: pulumi.StringMap{
					"string": pulumi.String("string"),
				},
			},
		},
	},
	Target: pulumi.String("string"),
	ThresholdTargets: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var alertResource = new Alert("alertResource", AlertArgs.builder()
    .minutes(0)
    .tags("string")
    .canViews("string")
    .name("string")
    .additionalInformation("string")
    .condition("string")
    .conditions(Map.of("string", "string"))
    .displayExpression("string")
    .alertType("string")
    .canModifies("string")
    .notificationResendFrequencyMinutes(0)
    .processRateMinutes(0)
    .resolveAfterMinutes(0)
    .runbookLinks("string")
    .severity("string")
    .alertTriageDashboards(AlertAlertTriageDashboardArgs.builder()
        .dashboardId("string")
        .description("string")
        .parameters(AlertAlertTriageDashboardParametersArgs.builder()
            .constants(Map.of("string", "string"))
            .build())
        .build())
    .target("string")
    .thresholdTargets(Map.of("string", "string"))
    .build());

    alert_resource = wavefront.Alert("alertResource",
    minutes=0,
    tags=["string"],
    can_views=["string"],
    name="string",
    additional_information="string",
    condition="string",
    conditions={
        "string": "string",
    },
    display_expression="string",
    alert_type="string",
    can_modifies=["string"],
    notification_resend_frequency_minutes=0,
    process_rate_minutes=0,
    resolve_after_minutes=0,
    runbook_links=["string"],
    severity="string",
    alert_triage_dashboards=[{
        "dashboard_id": "string",
        "description": "string",
        "parameters": {
            "constants": {
                "string": "string",
            },
        },
    }],
    target="string",
    threshold_targets={
        "string": "string",
    })

    const alertResource = new wavefront.Alert("alertResource", {
    minutes: 0,
    tags: ["string"],
    canViews: ["string"],
    name: "string",
    additionalInformation: "string",
    condition: "string",
    conditions: {
        string: "string",
    },
    displayExpression: "string",
    alertType: "string",
    canModifies: ["string"],
    notificationResendFrequencyMinutes: 0,
    processRateMinutes: 0,
    resolveAfterMinutes: 0,
    runbookLinks: ["string"],
    severity: "string",
    alertTriageDashboards: [{
        dashboardId: "string",
        description: "string",
        parameters: {
            constants: {
                string: "string",
            },
        },
    }],
    target: "string",
    thresholdTargets: {
        string: "string",
    },
});

    type: wavefront:Alert
properties:
    additionalInformation: string
    alertTriageDashboards:
        - dashboardId: string
          description: string
          parameters:
            constants:
                string: string
    alertType: string
    canModifies:
        - string
    canViews:
        - string
    condition: string
    conditions:
        string: string
    displayExpression: string
    minutes: 0
    name: string
    notificationResendFrequencyMinutes: 0
    processRateMinutes: 0
    resolveAfterMinutes: 0
    runbookLinks:
        - string
    severity: string
    tags:
        - string
    target: string
    thresholdTargets:
        string: string

    Alert 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 Alert resource accepts the following input properties:

    Minutes int
    The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires.
    Tags List<string>
    A set of tags to assign to this resource.
    AdditionalInformation string
    User-supplied additional explanatory information for this alert. Useful for linking runbooks, migrations, etc.
    AlertTriageDashboards List<AlertAlertTriageDashboard>
    A set of user-supplied dashboard and parameters to create dashboard links for triaging alerts.
    AlertType string
    The type of alert in Wavefront. Either CLASSIC (default) or THRESHOLD.
    CanModifies List<string>
    A list of valid users or groups that can modify this resource on a tenant.
    CanViews List<string>
    A list of valid users or groups that can view this resource on a tenant. Default is Empty list.
    Condition string
    A Wavefront query that is evaluated at regular intervals (default is 1 minute). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes.
    Conditions Dictionary<string, string>
    a string->string map of severity to condition for which this alert will trigger.
    DisplayExpression string
    A second query whose results are displayed in the alert user interface instead of the condition query. This field is often used to display a version of the condition query with Boolean operators removed so that numerical values are plotted.
    Name string
    The name of the alert as it is displayed in Wavefront.
    NotificationResendFrequencyMinutes int
    How often to re-trigger a continually failing alert. If absent or <= 0, no re-triggering occurs.
    ProcessRateMinutes int
    The specified query is executed every process_rate_minutes minutes. Default value is 5 minutes.
    ResolveAfterMinutes int
    The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves. When unset, this defaults to the same value as minutes.
    RunbookLinks List<string>
    A list of user-supplied runbook links for this alert.
    Severity string
    Severity of the alert, valid values are INFO, SMOKE, WARN, SEVERE.
    Target string
    A comma-separated list of the email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list. Alert target format: ({email}|pd:{pd_key}|target:{alert-target-id}).
    ThresholdTargets Dictionary<string, string>
    A string to string map of Targets for severity.
    Minutes int
    The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires.
    Tags []string
    A set of tags to assign to this resource.
    AdditionalInformation string
    User-supplied additional explanatory information for this alert. Useful for linking runbooks, migrations, etc.
    AlertTriageDashboards []AlertAlertTriageDashboardArgs
    A set of user-supplied dashboard and parameters to create dashboard links for triaging alerts.
    AlertType string
    The type of alert in Wavefront. Either CLASSIC (default) or THRESHOLD.
    CanModifies []string
    A list of valid users or groups that can modify this resource on a tenant.
    CanViews []string
    A list of valid users or groups that can view this resource on a tenant. Default is Empty list.
    Condition string
    A Wavefront query that is evaluated at regular intervals (default is 1 minute). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes.
    Conditions map[string]string
    a string->string map of severity to condition for which this alert will trigger.
    DisplayExpression string
    A second query whose results are displayed in the alert user interface instead of the condition query. This field is often used to display a version of the condition query with Boolean operators removed so that numerical values are plotted.
    Name string
    The name of the alert as it is displayed in Wavefront.
    NotificationResendFrequencyMinutes int
    How often to re-trigger a continually failing alert. If absent or <= 0, no re-triggering occurs.
    ProcessRateMinutes int
    The specified query is executed every process_rate_minutes minutes. Default value is 5 minutes.
    ResolveAfterMinutes int
    The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves. When unset, this defaults to the same value as minutes.
    RunbookLinks []string
    A list of user-supplied runbook links for this alert.
    Severity string
    Severity of the alert, valid values are INFO, SMOKE, WARN, SEVERE.
    Target string
    A comma-separated list of the email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list. Alert target format: ({email}|pd:{pd_key}|target:{alert-target-id}).
    ThresholdTargets map[string]string
    A string to string map of Targets for severity.
    minutes Integer
    The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires.
    tags List<String>
    A set of tags to assign to this resource.
    additionalInformation String
    User-supplied additional explanatory information for this alert. Useful for linking runbooks, migrations, etc.
    alertTriageDashboards List<AlertAlertTriageDashboard>
    A set of user-supplied dashboard and parameters to create dashboard links for triaging alerts.
    alertType String
    The type of alert in Wavefront. Either CLASSIC (default) or THRESHOLD.
    canModifies List<String>
    A list of valid users or groups that can modify this resource on a tenant.
    canViews List<String>
    A list of valid users or groups that can view this resource on a tenant. Default is Empty list.
    condition String
    A Wavefront query that is evaluated at regular intervals (default is 1 minute). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes.
    conditions Map<String,String>
    a string->string map of severity to condition for which this alert will trigger.
    displayExpression String
    A second query whose results are displayed in the alert user interface instead of the condition query. This field is often used to display a version of the condition query with Boolean operators removed so that numerical values are plotted.
    name String
    The name of the alert as it is displayed in Wavefront.
    notificationResendFrequencyMinutes Integer
    How often to re-trigger a continually failing alert. If absent or <= 0, no re-triggering occurs.
    processRateMinutes Integer
    The specified query is executed every process_rate_minutes minutes. Default value is 5 minutes.
    resolveAfterMinutes Integer
    The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves. When unset, this defaults to the same value as minutes.
    runbookLinks List<String>
    A list of user-supplied runbook links for this alert.
    severity String
    Severity of the alert, valid values are INFO, SMOKE, WARN, SEVERE.
    target String
    A comma-separated list of the email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list. Alert target format: ({email}|pd:{pd_key}|target:{alert-target-id}).
    thresholdTargets Map<String,String>
    A string to string map of Targets for severity.
    minutes number
    The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires.
    tags string[]
    A set of tags to assign to this resource.
    additionalInformation string
    User-supplied additional explanatory information for this alert. Useful for linking runbooks, migrations, etc.
    alertTriageDashboards AlertAlertTriageDashboard[]
    A set of user-supplied dashboard and parameters to create dashboard links for triaging alerts.
    alertType string
    The type of alert in Wavefront. Either CLASSIC (default) or THRESHOLD.
    canModifies string[]
    A list of valid users or groups that can modify this resource on a tenant.
    canViews string[]
    A list of valid users or groups that can view this resource on a tenant. Default is Empty list.
    condition string
    A Wavefront query that is evaluated at regular intervals (default is 1 minute). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes.
    conditions {[key: string]: string}
    a string->string map of severity to condition for which this alert will trigger.
    displayExpression string
    A second query whose results are displayed in the alert user interface instead of the condition query. This field is often used to display a version of the condition query with Boolean operators removed so that numerical values are plotted.
    name string
    The name of the alert as it is displayed in Wavefront.
    notificationResendFrequencyMinutes number
    How often to re-trigger a continually failing alert. If absent or <= 0, no re-triggering occurs.
    processRateMinutes number
    The specified query is executed every process_rate_minutes minutes. Default value is 5 minutes.
    resolveAfterMinutes number
    The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves. When unset, this defaults to the same value as minutes.
    runbookLinks string[]
    A list of user-supplied runbook links for this alert.
    severity string
    Severity of the alert, valid values are INFO, SMOKE, WARN, SEVERE.
    target string
    A comma-separated list of the email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list. Alert target format: ({email}|pd:{pd_key}|target:{alert-target-id}).
    thresholdTargets {[key: string]: string}
    A string to string map of Targets for severity.
    minutes int
    The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires.
    tags Sequence[str]
    A set of tags to assign to this resource.
    additional_information str
    User-supplied additional explanatory information for this alert. Useful for linking runbooks, migrations, etc.
    alert_triage_dashboards Sequence[AlertAlertTriageDashboardArgs]
    A set of user-supplied dashboard and parameters to create dashboard links for triaging alerts.
    alert_type str
    The type of alert in Wavefront. Either CLASSIC (default) or THRESHOLD.
    can_modifies Sequence[str]
    A list of valid users or groups that can modify this resource on a tenant.
    can_views Sequence[str]
    A list of valid users or groups that can view this resource on a tenant. Default is Empty list.
    condition str
    A Wavefront query that is evaluated at regular intervals (default is 1 minute). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes.
    conditions Mapping[str, str]
    a string->string map of severity to condition for which this alert will trigger.
    display_expression str
    A second query whose results are displayed in the alert user interface instead of the condition query. This field is often used to display a version of the condition query with Boolean operators removed so that numerical values are plotted.
    name str
    The name of the alert as it is displayed in Wavefront.
    notification_resend_frequency_minutes int
    How often to re-trigger a continually failing alert. If absent or <= 0, no re-triggering occurs.
    process_rate_minutes int
    The specified query is executed every process_rate_minutes minutes. Default value is 5 minutes.
    resolve_after_minutes int
    The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves. When unset, this defaults to the same value as minutes.
    runbook_links Sequence[str]
    A list of user-supplied runbook links for this alert.
    severity str
    Severity of the alert, valid values are INFO, SMOKE, WARN, SEVERE.
    target str
    A comma-separated list of the email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list. Alert target format: ({email}|pd:{pd_key}|target:{alert-target-id}).
    threshold_targets Mapping[str, str]
    A string to string map of Targets for severity.
    minutes Number
    The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires.
    tags List<String>
    A set of tags to assign to this resource.
    additionalInformation String
    User-supplied additional explanatory information for this alert. Useful for linking runbooks, migrations, etc.
    alertTriageDashboards List<Property Map>
    A set of user-supplied dashboard and parameters to create dashboard links for triaging alerts.
    alertType String
    The type of alert in Wavefront. Either CLASSIC (default) or THRESHOLD.
    canModifies List<String>
    A list of valid users or groups that can modify this resource on a tenant.
    canViews List<String>
    A list of valid users or groups that can view this resource on a tenant. Default is Empty list.
    condition String
    A Wavefront query that is evaluated at regular intervals (default is 1 minute). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes.
    conditions Map<String>
    a string->string map of severity to condition for which this alert will trigger.
    displayExpression String
    A second query whose results are displayed in the alert user interface instead of the condition query. This field is often used to display a version of the condition query with Boolean operators removed so that numerical values are plotted.
    name String
    The name of the alert as it is displayed in Wavefront.
    notificationResendFrequencyMinutes Number
    How often to re-trigger a continually failing alert. If absent or <= 0, no re-triggering occurs.
    processRateMinutes Number
    The specified query is executed every process_rate_minutes minutes. Default value is 5 minutes.
    resolveAfterMinutes Number
    The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves. When unset, this defaults to the same value as minutes.
    runbookLinks List<String>
    A list of user-supplied runbook links for this alert.
    severity String
    Severity of the alert, valid values are INFO, SMOKE, WARN, SEVERE.
    target String
    A comma-separated list of the email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list. Alert target format: ({email}|pd:{pd_key}|target:{alert-target-id}).
    thresholdTargets Map<String>
    A string to string map of Targets for severity.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Alert Resource

    Get an existing Alert 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?: AlertState, opts?: CustomResourceOptions): Alert
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        additional_information: Optional[str] = None,
        alert_triage_dashboards: Optional[Sequence[AlertAlertTriageDashboardArgs]] = None,
        alert_type: Optional[str] = None,
        can_modifies: Optional[Sequence[str]] = None,
        can_views: Optional[Sequence[str]] = None,
        condition: Optional[str] = None,
        conditions: Optional[Mapping[str, str]] = None,
        display_expression: Optional[str] = None,
        minutes: Optional[int] = None,
        name: Optional[str] = None,
        notification_resend_frequency_minutes: Optional[int] = None,
        process_rate_minutes: Optional[int] = None,
        resolve_after_minutes: Optional[int] = None,
        runbook_links: Optional[Sequence[str]] = None,
        severity: Optional[str] = None,
        tags: Optional[Sequence[str]] = None,
        target: Optional[str] = None,
        threshold_targets: Optional[Mapping[str, str]] = None) -> Alert
    func GetAlert(ctx *Context, name string, id IDInput, state *AlertState, opts ...ResourceOption) (*Alert, error)
    public static Alert Get(string name, Input<string> id, AlertState? state, CustomResourceOptions? opts = null)
    public static Alert get(String name, Output<String> id, AlertState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AdditionalInformation string
    User-supplied additional explanatory information for this alert. Useful for linking runbooks, migrations, etc.
    AlertTriageDashboards List<AlertAlertTriageDashboard>
    A set of user-supplied dashboard and parameters to create dashboard links for triaging alerts.
    AlertType string
    The type of alert in Wavefront. Either CLASSIC (default) or THRESHOLD.
    CanModifies List<string>
    A list of valid users or groups that can modify this resource on a tenant.
    CanViews List<string>
    A list of valid users or groups that can view this resource on a tenant. Default is Empty list.
    Condition string
    A Wavefront query that is evaluated at regular intervals (default is 1 minute). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes.
    Conditions Dictionary<string, string>
    a string->string map of severity to condition for which this alert will trigger.
    DisplayExpression string
    A second query whose results are displayed in the alert user interface instead of the condition query. This field is often used to display a version of the condition query with Boolean operators removed so that numerical values are plotted.
    Minutes int
    The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires.
    Name string
    The name of the alert as it is displayed in Wavefront.
    NotificationResendFrequencyMinutes int
    How often to re-trigger a continually failing alert. If absent or <= 0, no re-triggering occurs.
    ProcessRateMinutes int
    The specified query is executed every process_rate_minutes minutes. Default value is 5 minutes.
    ResolveAfterMinutes int
    The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves. When unset, this defaults to the same value as minutes.
    RunbookLinks List<string>
    A list of user-supplied runbook links for this alert.
    Severity string
    Severity of the alert, valid values are INFO, SMOKE, WARN, SEVERE.
    Tags List<string>
    A set of tags to assign to this resource.
    Target string
    A comma-separated list of the email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list. Alert target format: ({email}|pd:{pd_key}|target:{alert-target-id}).
    ThresholdTargets Dictionary<string, string>
    A string to string map of Targets for severity.
    AdditionalInformation string
    User-supplied additional explanatory information for this alert. Useful for linking runbooks, migrations, etc.
    AlertTriageDashboards []AlertAlertTriageDashboardArgs
    A set of user-supplied dashboard and parameters to create dashboard links for triaging alerts.
    AlertType string
    The type of alert in Wavefront. Either CLASSIC (default) or THRESHOLD.
    CanModifies []string
    A list of valid users or groups that can modify this resource on a tenant.
    CanViews []string
    A list of valid users or groups that can view this resource on a tenant. Default is Empty list.
    Condition string
    A Wavefront query that is evaluated at regular intervals (default is 1 minute). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes.
    Conditions map[string]string
    a string->string map of severity to condition for which this alert will trigger.
    DisplayExpression string
    A second query whose results are displayed in the alert user interface instead of the condition query. This field is often used to display a version of the condition query with Boolean operators removed so that numerical values are plotted.
    Minutes int
    The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires.
    Name string
    The name of the alert as it is displayed in Wavefront.
    NotificationResendFrequencyMinutes int
    How often to re-trigger a continually failing alert. If absent or <= 0, no re-triggering occurs.
    ProcessRateMinutes int
    The specified query is executed every process_rate_minutes minutes. Default value is 5 minutes.
    ResolveAfterMinutes int
    The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves. When unset, this defaults to the same value as minutes.
    RunbookLinks []string
    A list of user-supplied runbook links for this alert.
    Severity string
    Severity of the alert, valid values are INFO, SMOKE, WARN, SEVERE.
    Tags []string
    A set of tags to assign to this resource.
    Target string
    A comma-separated list of the email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list. Alert target format: ({email}|pd:{pd_key}|target:{alert-target-id}).
    ThresholdTargets map[string]string
    A string to string map of Targets for severity.
    additionalInformation String
    User-supplied additional explanatory information for this alert. Useful for linking runbooks, migrations, etc.
    alertTriageDashboards List<AlertAlertTriageDashboard>
    A set of user-supplied dashboard and parameters to create dashboard links for triaging alerts.
    alertType String
    The type of alert in Wavefront. Either CLASSIC (default) or THRESHOLD.
    canModifies List<String>
    A list of valid users or groups that can modify this resource on a tenant.
    canViews List<String>
    A list of valid users or groups that can view this resource on a tenant. Default is Empty list.
    condition String
    A Wavefront query that is evaluated at regular intervals (default is 1 minute). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes.
    conditions Map<String,String>
    a string->string map of severity to condition for which this alert will trigger.
    displayExpression String
    A second query whose results are displayed in the alert user interface instead of the condition query. This field is often used to display a version of the condition query with Boolean operators removed so that numerical values are plotted.
    minutes Integer
    The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires.
    name String
    The name of the alert as it is displayed in Wavefront.
    notificationResendFrequencyMinutes Integer
    How often to re-trigger a continually failing alert. If absent or <= 0, no re-triggering occurs.
    processRateMinutes Integer
    The specified query is executed every process_rate_minutes minutes. Default value is 5 minutes.
    resolveAfterMinutes Integer
    The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves. When unset, this defaults to the same value as minutes.
    runbookLinks List<String>
    A list of user-supplied runbook links for this alert.
    severity String
    Severity of the alert, valid values are INFO, SMOKE, WARN, SEVERE.
    tags List<String>
    A set of tags to assign to this resource.
    target String
    A comma-separated list of the email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list. Alert target format: ({email}|pd:{pd_key}|target:{alert-target-id}).
    thresholdTargets Map<String,String>
    A string to string map of Targets for severity.
    additionalInformation string
    User-supplied additional explanatory information for this alert. Useful for linking runbooks, migrations, etc.
    alertTriageDashboards AlertAlertTriageDashboard[]
    A set of user-supplied dashboard and parameters to create dashboard links for triaging alerts.
    alertType string
    The type of alert in Wavefront. Either CLASSIC (default) or THRESHOLD.
    canModifies string[]
    A list of valid users or groups that can modify this resource on a tenant.
    canViews string[]
    A list of valid users or groups that can view this resource on a tenant. Default is Empty list.
    condition string
    A Wavefront query that is evaluated at regular intervals (default is 1 minute). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes.
    conditions {[key: string]: string}
    a string->string map of severity to condition for which this alert will trigger.
    displayExpression string
    A second query whose results are displayed in the alert user interface instead of the condition query. This field is often used to display a version of the condition query with Boolean operators removed so that numerical values are plotted.
    minutes number
    The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires.
    name string
    The name of the alert as it is displayed in Wavefront.
    notificationResendFrequencyMinutes number
    How often to re-trigger a continually failing alert. If absent or <= 0, no re-triggering occurs.
    processRateMinutes number
    The specified query is executed every process_rate_minutes minutes. Default value is 5 minutes.
    resolveAfterMinutes number
    The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves. When unset, this defaults to the same value as minutes.
    runbookLinks string[]
    A list of user-supplied runbook links for this alert.
    severity string
    Severity of the alert, valid values are INFO, SMOKE, WARN, SEVERE.
    tags string[]
    A set of tags to assign to this resource.
    target string
    A comma-separated list of the email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list. Alert target format: ({email}|pd:{pd_key}|target:{alert-target-id}).
    thresholdTargets {[key: string]: string}
    A string to string map of Targets for severity.
    additional_information str
    User-supplied additional explanatory information for this alert. Useful for linking runbooks, migrations, etc.
    alert_triage_dashboards Sequence[AlertAlertTriageDashboardArgs]
    A set of user-supplied dashboard and parameters to create dashboard links for triaging alerts.
    alert_type str
    The type of alert in Wavefront. Either CLASSIC (default) or THRESHOLD.
    can_modifies Sequence[str]
    A list of valid users or groups that can modify this resource on a tenant.
    can_views Sequence[str]
    A list of valid users or groups that can view this resource on a tenant. Default is Empty list.
    condition str
    A Wavefront query that is evaluated at regular intervals (default is 1 minute). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes.
    conditions Mapping[str, str]
    a string->string map of severity to condition for which this alert will trigger.
    display_expression str
    A second query whose results are displayed in the alert user interface instead of the condition query. This field is often used to display a version of the condition query with Boolean operators removed so that numerical values are plotted.
    minutes int
    The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires.
    name str
    The name of the alert as it is displayed in Wavefront.
    notification_resend_frequency_minutes int
    How often to re-trigger a continually failing alert. If absent or <= 0, no re-triggering occurs.
    process_rate_minutes int
    The specified query is executed every process_rate_minutes minutes. Default value is 5 minutes.
    resolve_after_minutes int
    The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves. When unset, this defaults to the same value as minutes.
    runbook_links Sequence[str]
    A list of user-supplied runbook links for this alert.
    severity str
    Severity of the alert, valid values are INFO, SMOKE, WARN, SEVERE.
    tags Sequence[str]
    A set of tags to assign to this resource.
    target str
    A comma-separated list of the email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list. Alert target format: ({email}|pd:{pd_key}|target:{alert-target-id}).
    threshold_targets Mapping[str, str]
    A string to string map of Targets for severity.
    additionalInformation String
    User-supplied additional explanatory information for this alert. Useful for linking runbooks, migrations, etc.
    alertTriageDashboards List<Property Map>
    A set of user-supplied dashboard and parameters to create dashboard links for triaging alerts.
    alertType String
    The type of alert in Wavefront. Either CLASSIC (default) or THRESHOLD.
    canModifies List<String>
    A list of valid users or groups that can modify this resource on a tenant.
    canViews List<String>
    A list of valid users or groups that can view this resource on a tenant. Default is Empty list.
    condition String
    A Wavefront query that is evaluated at regular intervals (default is 1 minute). The alert fires and notifications are triggered when a data series matching this query evaluates to a non-zero value for a set number of consecutive minutes.
    conditions Map<String>
    a string->string map of severity to condition for which this alert will trigger.
    displayExpression String
    A second query whose results are displayed in the alert user interface instead of the condition query. This field is often used to display a version of the condition query with Boolean operators removed so that numerical values are plotted.
    minutes Number
    The number of consecutive minutes that a series matching the condition query must evaluate to "true" (non-zero value) before the alert fires.
    name String
    The name of the alert as it is displayed in Wavefront.
    notificationResendFrequencyMinutes Number
    How often to re-trigger a continually failing alert. If absent or <= 0, no re-triggering occurs.
    processRateMinutes Number
    The specified query is executed every process_rate_minutes minutes. Default value is 5 minutes.
    resolveAfterMinutes Number
    The number of consecutive minutes that a firing series matching the condition query must evaluate to "false" (zero value) before the alert resolves. When unset, this defaults to the same value as minutes.
    runbookLinks List<String>
    A list of user-supplied runbook links for this alert.
    severity String
    Severity of the alert, valid values are INFO, SMOKE, WARN, SEVERE.
    tags List<String>
    A set of tags to assign to this resource.
    target String
    A comma-separated list of the email address or integration endpoint (such as PagerDuty or webhook) to notify when the alert status changes. Multiple target types can be in the list. Alert target format: ({email}|pd:{pd_key}|target:{alert-target-id}).
    thresholdTargets Map<String>
    A string to string map of Targets for severity.

    Supporting Types

    AlertAlertTriageDashboard, AlertAlertTriageDashboardArgs

    DashboardId string
    Dashboard ID
    Description string
    Dashboard Description
    Parameters AlertAlertTriageDashboardParameters
    DashboardId string
    Dashboard ID
    Description string
    Dashboard Description
    Parameters AlertAlertTriageDashboardParameters
    dashboardId String
    Dashboard ID
    description String
    Dashboard Description
    parameters AlertAlertTriageDashboardParameters
    dashboardId string
    Dashboard ID
    description string
    Dashboard Description
    parameters AlertAlertTriageDashboardParameters
    dashboardId String
    Dashboard ID
    description String
    Dashboard Description
    parameters Property Map

    AlertAlertTriageDashboardParameters, AlertAlertTriageDashboardParametersArgs

    Constants Dictionary<string, string>
    Constants map[string]string
    constants Map<String,String>
    constants {[key: string]: string}
    constants Mapping[str, str]
    constants Map<String>

    Import

    Alerts can be imported using the id, e.g.

    $ pulumi import wavefront:index/alert:Alert alert_target 1479868728473

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

    Package Details

    Repository
    Wavefront pulumi/pulumi-wavefront
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the wavefront Terraform Provider.
    wavefront logo
    Wavefront v3.1.6 published on Thursday, Oct 31, 2024 by Pulumi
    pulumi/pulumi-wavefront