@pulumi/signalfx
Version:
A Pulumi package for creating and managing SignalFx resources.
142 lines (141 loc) • 6.26 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
* Provides a Splunk Observability Cloud resource for managing alert muting rules. See [Mute Notifications](https://docs.splunk.com/Observability/alerts-detectors-notifications/mute-notifications.html) for more information.
*
* Splunk Observability Cloud currently allows linking an alert muting rule with only one detector ID. Specifying multiple detector IDs makes the muting rule obsolete.
*
* > **WARNING** Splunk Observability Cloud does not allow the start time of a **currently active** muting rule to be modified. Attempting to modify a currently active rule destroys the existing rule and creates a new rule. This might result in the emission of notifications.
*
* ## Example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as signalfx from "@pulumi/signalfx";
*
* const roolMooterOne = new signalfx.AlertMutingRule("rool_mooter_one", {
* description: "mooted it NEW",
* startTime: 1573063243,
* stopTime: 0,
* detectors: [someDetectorId],
* filters: [{
* property: "foo",
* propertyValue: "bar",
* }],
* recurrence: {
* unit: "d",
* value: 2,
* },
* });
* ```
*/
export declare class AlertMutingRule extends pulumi.CustomResource {
/**
* Get an existing AlertMutingRule 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.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AlertMutingRuleState, opts?: pulumi.CustomResourceOptions): AlertMutingRule;
/**
* Returns true if the given object is an instance of AlertMutingRule. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is AlertMutingRule;
/**
* The description for this muting rule
*/
readonly description: pulumi.Output<string>;
/**
* A convenience attribute that associated this muting rule with specific detector IDs. Currently, only one ID is supported.
*/
readonly detectors: pulumi.Output<string[] | undefined>;
readonly effectiveStartTime: pulumi.Output<number>;
/**
* Filters for this rule. See [Creating muting rules from scratch](https://docs.splunk.com/Observability/alerts-detectors-notifications/mute-notifications.html#rule-from-scratch) for more information.
*/
readonly filters: pulumi.Output<outputs.AlertMutingRuleFilter[] | undefined>;
/**
* Defines the recurrence of the muting rule. Allows setting a recurring muting rule based on specified days or weeks.
*/
readonly recurrence: pulumi.Output<outputs.AlertMutingRuleRecurrence | undefined>;
/**
* Starting time of an alert muting rule as a Unit time stamp in seconds.
*/
readonly startTime: pulumi.Output<number>;
/**
* Stop time of an alert muting rule as a Unix time stamp in seconds.
*/
readonly stopTime: pulumi.Output<number | undefined>;
/**
* Create a AlertMutingRule 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: AlertMutingRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AlertMutingRule resources.
*/
export interface AlertMutingRuleState {
/**
* The description for this muting rule
*/
description?: pulumi.Input<string>;
/**
* A convenience attribute that associated this muting rule with specific detector IDs. Currently, only one ID is supported.
*/
detectors?: pulumi.Input<pulumi.Input<string>[]>;
effectiveStartTime?: pulumi.Input<number>;
/**
* Filters for this rule. See [Creating muting rules from scratch](https://docs.splunk.com/Observability/alerts-detectors-notifications/mute-notifications.html#rule-from-scratch) for more information.
*/
filters?: pulumi.Input<pulumi.Input<inputs.AlertMutingRuleFilter>[]>;
/**
* Defines the recurrence of the muting rule. Allows setting a recurring muting rule based on specified days or weeks.
*/
recurrence?: pulumi.Input<inputs.AlertMutingRuleRecurrence>;
/**
* Starting time of an alert muting rule as a Unit time stamp in seconds.
*/
startTime?: pulumi.Input<number>;
/**
* Stop time of an alert muting rule as a Unix time stamp in seconds.
*/
stopTime?: pulumi.Input<number>;
}
/**
* The set of arguments for constructing a AlertMutingRule resource.
*/
export interface AlertMutingRuleArgs {
/**
* The description for this muting rule
*/
description: pulumi.Input<string>;
/**
* A convenience attribute that associated this muting rule with specific detector IDs. Currently, only one ID is supported.
*/
detectors?: pulumi.Input<pulumi.Input<string>[]>;
/**
* Filters for this rule. See [Creating muting rules from scratch](https://docs.splunk.com/Observability/alerts-detectors-notifications/mute-notifications.html#rule-from-scratch) for more information.
*/
filters?: pulumi.Input<pulumi.Input<inputs.AlertMutingRuleFilter>[]>;
/**
* Defines the recurrence of the muting rule. Allows setting a recurring muting rule based on specified days or weeks.
*/
recurrence?: pulumi.Input<inputs.AlertMutingRuleRecurrence>;
/**
* Starting time of an alert muting rule as a Unit time stamp in seconds.
*/
startTime: pulumi.Input<number>;
/**
* Stop time of an alert muting rule as a Unix time stamp in seconds.
*/
stopTime?: pulumi.Input<number>;
}