@pulumiverse/grafana/oss/annotation.d.ts

A Pulumi package for creating and managing grafana.

import * as pulumi from "@pulumi/pulumi";
/**
 * * [Official documentation](https://grafana.com/docs/grafana/latest/dashboards/build-dashboards/annotate-visualizations/)
 * * [HTTP API](https://grafana.com/docs/grafana/latest/developers/http_api/annotations/)
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as grafana from "@pulumiverse/grafana";
 *
 * const test = new grafana.oss.Annotation("test", {text: "basic text"});
 * ```
 *
 * ## Import
 *
 * ```sh
 * $ pulumi import grafana:oss/annotation:Annotation name "{{ id }}"
 * ```
 *
 * ```sh
 * $ pulumi import grafana:oss/annotation:Annotation name "{{ orgID }}:{{ id }}"
 * ```
 */
export declare class Annotation extends pulumi.CustomResource {
    /**
     * Get an existing Annotation 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?: AnnotationState, opts?: pulumi.CustomResourceOptions): Annotation;
    /**
     * Returns true if the given object is an instance of Annotation.  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 Annotation;
    /**
     * The UID of the dashboard on which to create the annotation.
     */
    readonly dashboardUid: pulumi.Output<string | undefined>;
    /**
     * The Organization ID. If not set, the Org ID defined in the provider block will be used.
     */
    readonly orgId: pulumi.Output<string | undefined>;
    /**
     * The ID of the dashboard panel on which to create the annotation.
     */
    readonly panelId: pulumi.Output<number | undefined>;
    /**
     * The tags to associate with the annotation.
     */
    readonly tags: pulumi.Output<string[] | undefined>;
    /**
     * The text to associate with the annotation.
     */
    readonly text: pulumi.Output<string>;
    /**
     * The RFC 3339-formatted time string indicating the annotation's time.
     */
    readonly time: pulumi.Output<string>;
    /**
     * The RFC 3339-formatted time string indicating the annotation's end time.
     */
    readonly timeEnd: pulumi.Output<string>;
    /**
     * Create a Annotation 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: AnnotationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Annotation resources.
 */
export interface AnnotationState {
    /**
     * The UID of the dashboard on which to create the annotation.
     */
    dashboardUid?: 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 ID of the dashboard panel on which to create the annotation.
     */
    panelId?: pulumi.Input<number>;
    /**
     * The tags to associate with the annotation.
     */
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The text to associate with the annotation.
     */
    text?: pulumi.Input<string>;
    /**
     * The RFC 3339-formatted time string indicating the annotation's time.
     */
    time?: pulumi.Input<string>;
    /**
     * The RFC 3339-formatted time string indicating the annotation's end time.
     */
    timeEnd?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Annotation resource.
 */
export interface AnnotationArgs {
    /**
     * The UID of the dashboard on which to create the annotation.
     */
    dashboardUid?: 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 ID of the dashboard panel on which to create the annotation.
     */
    panelId?: pulumi.Input<number>;
    /**
     * The tags to associate with the annotation.
     */
    tags?: pulumi.Input<pulumi.Input<string>[]>;
    /**
     * The text to associate with the annotation.
     */
    text: pulumi.Input<string>;
    /**
     * The RFC 3339-formatted time string indicating the annotation's time.
     */
    time?: pulumi.Input<string>;
    /**
     * The RFC 3339-formatted time string indicating the annotation's end time.
     */
    timeEnd?: pulumi.Input<string>;
}