UNPKG

@pulumiverse/grafana

Version:

A Pulumi package for creating and managing grafana.

109 lines (108 loc) 3.71 kB
import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * * [Official documentation](https://grafana.com/docs/grafana/latest/dashboards/create-manage-playlists/) * * [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/playlist/) * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as grafana from "@pulumiverse/grafana"; * * const test = new grafana.oss.Playlist("test", { * name: "My Playlist!", * interval: "5m", * items: [ * { * order: 2, * title: "Terraform Dashboard By Tag", * type: "dashboard_by_tag", * value: "terraform", * }, * { * order: 1, * title: "Terraform Dashboard By UID", * type: "dashboard_by_uid", * value: "cIBgcSjkk", * }, * ], * }); * ``` * * ## Import * * ```sh * $ pulumi import grafana:oss/playlist:Playlist name "{{ uid }}" * ``` * * ```sh * $ pulumi import grafana:oss/playlist:Playlist name "{{ orgID }}:{{ uid }}" * ``` */ export declare class Playlist extends pulumi.CustomResource { /** * Get an existing Playlist 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?: PlaylistState, opts?: pulumi.CustomResourceOptions): Playlist; /** * Returns true if the given object is an instance of Playlist. 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 Playlist; readonly interval: pulumi.Output<string>; readonly items: pulumi.Output<outputs.oss.PlaylistItem[]>; /** * The name of the playlist. */ readonly name: pulumi.Output<string>; /** * The Organization ID. If not set, the Org ID defined in the provider block will be used. */ readonly orgId: pulumi.Output<string | undefined>; /** * Create a Playlist 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: PlaylistArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Playlist resources. */ export interface PlaylistState { interval?: pulumi.Input<string>; items?: pulumi.Input<pulumi.Input<inputs.oss.PlaylistItem>[]>; /** * The name of the playlist. */ name?: pulumi.Input<string>; /** * The Organization ID. If not set, the Org ID defined in the provider block will be used. */ orgId?: pulumi.Input<string>; } /** * The set of arguments for constructing a Playlist resource. */ export interface PlaylistArgs { interval: pulumi.Input<string>; items: pulumi.Input<pulumi.Input<inputs.oss.PlaylistItem>[]>; /** * The name of the playlist. */ name?: pulumi.Input<string>; /** * The Organization ID. If not set, the Org ID defined in the provider block will be used. */ orgId?: pulumi.Input<string>; }