@pulumiverse/grafana
Version:
A Pulumi package for creating and managing grafana.
126 lines (125 loc) • 4.45 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../../types/input";
import * as outputs from "../../types/output";
/**
* Manages Grafana Recording Rules.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as grafana from "@pulumiverse/grafana";
*
* const recordingruleFolder = new grafana.oss.Folder("recordingrule_folder", {title: "Alert Rule Folder"});
* const example = new grafana.alerting.v0alpha1.RecordingRule("example", {
* metadata: {
* uid: "example-recording-rule",
* folderUid: recordingruleFolder.uid,
* },
* spec: {
* title: "Example Recording Rule",
* trigger: {
* interval: "1m",
* },
* paused: true,
* expressions: {
* A: JSON.stringify({
* model: {
* editorMode: "code",
* expr: "count(up{})",
* instant: true,
* intervalMs: 1000,
* legendFormat: "__auto",
* maxDataPoints: 43200,
* range: false,
* refId: "A",
* },
* datasource_uid: "ds_uid",
* relative_time_range: {
* from: "600s",
* to: "0s",
* },
* query_type: "",
* source: true,
* }),
* },
* targetDatasourceUid: "target_ds_uid",
* metric: "tf-metric",
* labels: {
* foo: "bar",
* },
* },
* });
* ```
*/
export declare class RecordingRule extends pulumi.CustomResource {
/**
* Get an existing RecordingRule 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?: RecordingRuleState, opts?: pulumi.CustomResourceOptions): RecordingRule;
/**
* Returns true if the given object is an instance of RecordingRule. 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 RecordingRule;
/**
* The metadata of the resource.
*/
readonly metadata: pulumi.Output<outputs.alerting.v0alpha1.RecordingRuleMetadata | undefined>;
/**
* Options for applying the resource.
*/
readonly options: pulumi.Output<outputs.alerting.v0alpha1.RecordingRuleOptions | undefined>;
/**
* The spec of the resource.
*/
readonly spec: pulumi.Output<outputs.alerting.v0alpha1.RecordingRuleSpec | undefined>;
/**
* Create a RecordingRule 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?: RecordingRuleArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RecordingRule resources.
*/
export interface RecordingRuleState {
/**
* The metadata of the resource.
*/
metadata?: pulumi.Input<inputs.alerting.v0alpha1.RecordingRuleMetadata>;
/**
* Options for applying the resource.
*/
options?: pulumi.Input<inputs.alerting.v0alpha1.RecordingRuleOptions>;
/**
* The spec of the resource.
*/
spec?: pulumi.Input<inputs.alerting.v0alpha1.RecordingRuleSpec>;
}
/**
* The set of arguments for constructing a RecordingRule resource.
*/
export interface RecordingRuleArgs {
/**
* The metadata of the resource.
*/
metadata?: pulumi.Input<inputs.alerting.v0alpha1.RecordingRuleMetadata>;
/**
* Options for applying the resource.
*/
options?: pulumi.Input<inputs.alerting.v0alpha1.RecordingRuleOptions>;
/**
* The spec of the resource.
*/
spec?: pulumi.Input<inputs.alerting.v0alpha1.RecordingRuleSpec>;
}