alert.ts

// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

import * as pulumi from "@pulumi/pulumi";
import * as utilities from "./utilities";

/**
 * Provides a Wavefront Alert resource.  This allows alerts to be created, updated, and deleted.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as wavefront from "@pulumi/wavefront";
 *
 * const foobar = new wavefront.Alert("foobar", {
 *     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",
 *     ],
 *     target: "test@example.com",
 * });
 * ```
 */
export class Alert extends pulumi.CustomResource {
    /**
     * Get an existing Alert resource's state with the given name, ID, and optional extra
     * properties used to qualify the lookup.
     *
     * @param name The _unique_ name of the resulting resource.
     * @param id The _unique_ provider ID of the resource to lookup.
     * @param state Any extra arguments used during the lookup.
     * @param opts Optional settings to control the behavior of the CustomResource.
     */
    public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AlertState, opts?: pulumi.CustomResourceOptions): Alert {
        return new Alert(name, <any>state, { ...opts, id: id });
    }

    /** @internal */
    public static readonly __pulumiType = 'wavefront:index/alert:Alert';

    /**
     * Returns true if the given object is an instance of Alert.  This is designed to work even
     * when multiple copies of the Pulumi SDK have been loaded into the same process.
     */
    public static isInstance(obj: any): obj is Alert {
        if (obj === undefined || obj === null) {
            return false;
        }
        return obj['__pulumiType'] === Alert.__pulumiType;
    }

    /**
     * User-supplied additional explanatory information for this alert.
     * Useful for linking runbooks, migrations...etc
     */
    public readonly additionalInformation!: pulumi.Output<string | undefined>;
    /**
     * The type of alert in Wavefront.  Either `CLASSIC` (default) 
     * or `THRESHOLD`
     */
    public readonly alertType!: pulumi.Output<string | undefined>;
    /**
     * A list of users or groups that can modify this resource.
     */
    public readonly canModifies!: pulumi.Output<string[]>;
    /**
     * A list of users or groups that can view this resource.
     */
    public readonly canViews!: pulumi.Output<string[] | undefined>;
    /**
     * A Wavefront query that is evaluated at regular intervals (default 1m).
     * The alert fires and notifications are triggered when data series matching this query evaluates
     * to a non-zero value for a set number of consecutive minutes.
     */
    public readonly condition!: pulumi.Output<string | undefined>;
    /**
     * a string->string map of `severity` to `condition` 
     * for which this alert will trigger.
     */
    public readonly conditions!: pulumi.Output<{[key: string]: string} | undefined>;
    /**
     * 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.
     */
    public readonly displayExpression!: pulumi.Output<string | undefined>;
    /**
     * The number of consecutive minutes that a series matching the condition query must 
     * evaluate to "true" (non-zero value) before the alert fires.
     */
    public readonly minutes!: pulumi.Output<number>;
    /**
     * The name of the alert as it is displayed in Wavefront.
     */
    public readonly name!: pulumi.Output<string>;
    /**
     * How often to re-trigger a continually failing alert. 
     * If absent or <= 0, no re-triggering occur.
     */
    public readonly notificationResendFrequencyMinutes!: pulumi.Output<number | undefined>;
    /**
     * 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 default sto
     * the same value as `minutes`.
     */
    public readonly resolveAfterMinutes!: pulumi.Output<number | undefined>;
    /**
     * - Severity of the alert, valid values are `INFO`, `SMOKE`, `WARN`, `SEVERE`.
     */
    public readonly severity!: pulumi.Output<string>;
    /**
     * A set of tags to assign to this resource.
     */
    public readonly tags!: pulumi.Output<string[]>;
    /**
     * A comma-separated list of the email address or integration endpoint 
     * (such as PagerDuty or web hook) to notify when the alert status changes.
     */
    public readonly target!: pulumi.Output<string | undefined>;
    /**
     * Targets for severity
     */
    public readonly thresholdTargets!: pulumi.Output<{[key: string]: string} | undefined>;

    /**
     * Create a Alert resource with the given unique name, arguments, and options.
     *
     * @param name The _unique_ name of the resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param opts A bag of options that control this resource's behavior.
     */
    constructor(name: string, args: AlertArgs, opts?: pulumi.CustomResourceOptions)
    constructor(name: string, argsOrState?: AlertArgs | AlertState, opts?: pulumi.CustomResourceOptions) {
        let inputs: pulumi.Inputs = {};
        if (opts && opts.id) {
            const state = argsOrState as AlertState | undefined;
            inputs["additionalInformation"] = state ? state.additionalInformation : undefined;
            inputs["alertType"] = state ? state.alertType : undefined;
            inputs["canModifies"] = state ? state.canModifies : undefined;
            inputs["canViews"] = state ? state.canViews : undefined;
            inputs["condition"] = state ? state.condition : undefined;
            inputs["conditions"] = state ? state.conditions : undefined;
            inputs["displayExpression"] = state ? state.displayExpression : undefined;
            inputs["minutes"] = state ? state.minutes : undefined;
            inputs["name"] = state ? state.name : undefined;
            inputs["notificationResendFrequencyMinutes"] = state ? state.notificationResendFrequencyMinutes : undefined;
            inputs["resolveAfterMinutes"] = state ? state.resolveAfterMinutes : undefined;
            inputs["severity"] = state ? state.severity : undefined;
            inputs["tags"] = state ? state.tags : undefined;
            inputs["target"] = state ? state.target : undefined;
            inputs["thresholdTargets"] = state ? state.thresholdTargets : undefined;
        } else {
            const args = argsOrState as AlertArgs | undefined;
            if (!args || args.minutes === undefined) {
                throw new Error("Missing required property 'minutes'");
            }
            if (!args || args.tags === undefined) {
                throw new Error("Missing required property 'tags'");
            }
            inputs["additionalInformation"] = args ? args.additionalInformation : undefined;
            inputs["alertType"] = args ? args.alertType : undefined;
            inputs["canModifies"] = args ? args.canModifies : undefined;
            inputs["canViews"] = args ? args.canViews : undefined;
            inputs["condition"] = args ? args.condition : undefined;
            inputs["conditions"] = args ? args.conditions : undefined;
            inputs["displayExpression"] = args ? args.displayExpression : undefined;
            inputs["minutes"] = args ? args.minutes : undefined;
            inputs["name"] = args ? args.name : undefined;
            inputs["notificationResendFrequencyMinutes"] = args ? args.notificationResendFrequencyMinutes : undefined;
            inputs["resolveAfterMinutes"] = args ? args.resolveAfterMinutes : undefined;
            inputs["severity"] = args ? args.severity : undefined;
            inputs["tags"] = args ? args.tags : undefined;
            inputs["target"] = args ? args.target : undefined;
            inputs["thresholdTargets"] = args ? args.thresholdTargets : undefined;
        }
        if (!opts) {
            opts = {}
        }

        if (!opts.version) {
            opts.version = utilities.getVersion();
        }
        super(Alert.__pulumiType, name, inputs, opts);
    }
}

/**
 * Input properties used for looking up and filtering Alert resources.
 */
export interface AlertState {
    /**
     * User-supplied additional explanatory information for this alert.
     * Useful for linking runbooks, migrations...etc
     */
    readonly additionalInformation?: pulumi.Input<string>;
    /**
     * The type of alert in Wavefront.  Either `CLASSIC` (default) 
     * or `THRESHOLD`
     */
    readonly alertType?: pulumi.Input<string>;
    /**
     * A list of users or groups that can modify this resource.
     */
    readonly canModifies?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * A list of users or groups that can view this resource.
     */
    readonly canViews?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * A Wavefront query that is evaluated at regular intervals (default 1m).
     * The alert fires and notifications are triggered when data series matching this query evaluates
     * to a non-zero value for a set number of consecutive minutes.
     */
    readonly condition?: pulumi.Input<string>;
    /**
     * a string->string map of `severity` to `condition` 
     * for which this alert will trigger.
     */
    readonly conditions?: pulumi.Input<{[key: string]: pulumi.Input<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.
     */
    readonly displayExpression?: pulumi.Input<string>;
    /**
     * The number of consecutive minutes that a series matching the condition query must 
     * evaluate to "true" (non-zero value) before the alert fires.
     */
    readonly minutes?: pulumi.Input<number>;
    /**
     * The name of the alert as it is displayed in Wavefront.
     */
    readonly name?: pulumi.Input<string>;
    /**
     * How often to re-trigger a continually failing alert. 
     * If absent or <= 0, no re-triggering occur.
     */
    readonly notificationResendFrequencyMinutes?: pulumi.Input<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 default sto
     * the same value as `minutes`.
     */
    readonly resolveAfterMinutes?: pulumi.Input<number>;
    /**
     * - Severity of the alert, valid values are `INFO`, `SMOKE`, `WARN`, `SEVERE`.
     */
    readonly severity?: pulumi.Input<string>;
    /**
     * A set of tags to assign to this resource.
     */
    readonly tags?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * A comma-separated list of the email address or integration endpoint 
     * (such as PagerDuty or web hook) to notify when the alert status changes.
     */
    readonly target?: pulumi.Input<string>;
    /**
     * Targets for severity
     */
    readonly thresholdTargets?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
}

/**
 * The set of arguments for constructing a Alert resource.
 */
export interface AlertArgs {
    /**
     * User-supplied additional explanatory information for this alert.
     * Useful for linking runbooks, migrations...etc
     */
    readonly additionalInformation?: pulumi.Input<string>;
    /**
     * The type of alert in Wavefront.  Either `CLASSIC` (default) 
     * or `THRESHOLD`
     */
    readonly alertType?: pulumi.Input<string>;
    /**
     * A list of users or groups that can modify this resource.
     */
    readonly canModifies?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * A list of users or groups that can view this resource.
     */
    readonly canViews?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * A Wavefront query that is evaluated at regular intervals (default 1m).
     * The alert fires and notifications are triggered when data series matching this query evaluates
     * to a non-zero value for a set number of consecutive minutes.
     */
    readonly condition?: pulumi.Input<string>;
    /**
     * a string->string map of `severity` to `condition` 
     * for which this alert will trigger.
     */
    readonly conditions?: pulumi.Input<{[key: string]: pulumi.Input<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.
     */
    readonly displayExpression?: pulumi.Input<string>;
    /**
     * The number of consecutive minutes that a series matching the condition query must 
     * evaluate to "true" (non-zero value) before the alert fires.
     */
    readonly minutes: pulumi.Input<number>;
    /**
     * The name of the alert as it is displayed in Wavefront.
     */
    readonly name?: pulumi.Input<string>;
    /**
     * How often to re-trigger a continually failing alert. 
     * If absent or <= 0, no re-triggering occur.
     */
    readonly notificationResendFrequencyMinutes?: pulumi.Input<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 default sto
     * the same value as `minutes`.
     */
    readonly resolveAfterMinutes?: pulumi.Input<number>;
    /**
     * - Severity of the alert, valid values are `INFO`, `SMOKE`, `WARN`, `SEVERE`.
     */
    readonly severity?: pulumi.Input<string>;
    /**
     * A set of tags to assign to this resource.
     */
    readonly tags: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * A comma-separated list of the email address or integration endpoint 
     * (such as PagerDuty or web hook) to notify when the alert status changes.
     */
    readonly target?: pulumi.Input<string>;
    /**
     * Targets for severity
     */
    readonly thresholdTargets?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;
}