@pulumiverse/grafana/cloud/integration.d.ts

A Pulumi package for creating and managing grafana.

import * as pulumi from "@pulumi/pulumi";
/**
 * Manages Grafana Cloud integrations.
 *
 * * [Official documentation](https://grafana.com/docs/grafana-cloud/data-configuration/integrations/)
 *
 * This provider lets you manage Grafana Cloud Integrations.
 * Alerts can optionally be disabled.
 *
 * Please note: Grafana Cloud Integrations do not support in-place upgrades, and require a teardown and reapply to resolve version drift.
 * As such it is recommended to have a separate TF plan for integrations to cleanly destroy them as needed.
 *
 * Update, only triggered on config change, is implemented as a complete uninstall, then reinstall of the integration in question.
 *
 * Required access policy scopes:
 *
 * * folders:read
 * * folders:write
 * * dashboards:read
 * * dashboards:write
 * * rules:read
 * * rules:write
 *
 * Based on: https://grafana.com/docs/grafana/latest/alerting/alerting-rules/alerting-migration/#import-rules-with-grafana-alerting
 *
 * **Note:** This resource creates folders and dashboards as part of the integration installation process, which requires additional permissions beyond the basic integration scopes.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as grafana from "@pulumiverse/grafana";
 *
 * // install linux-node integration
 * const linux_node = new grafana.cloud.Integration("linux-node", {slug: "linux-node"});
 * // install kafka integration w. alerts disabled
 * const kafka = new grafana.cloud.Integration("kafka", {
 *     slug: "kafka",
 *     alertsEnabled: false,
 * });
 * export const linuxNodeIntegration = {
 *     name: linux_node.name,
 *     latestVersion: linux_node.latestVersion,
 *     installedVersion: linux_node.installedVersion,
 *     dashboardFolder: linux_node.dashboardFolder,
 * };
 * export const kafkaIntegration = {
 *     name: kafka.name,
 *     latestVersion: kafka.latestVersion,
 *     installedVersion: kafka.installedVersion,
 *     dashboardFolder: kafka.dashboardFolder,
 * };
 * ```
 *
 * ## Import
 *
 * ```sh
 * terraform import grafana_cloud_integration.name "{{ slug }}"
 * ```
 */
export declare class Integration extends pulumi.CustomResource {
    /**
     * Get an existing Integration 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?: IntegrationState, opts?: pulumi.CustomResourceOptions): Integration;
    /**
     * Returns true if the given object is an instance of Integration.  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 Integration;
    /**
     * Whether alerts are enabled for this integration.
     */
    readonly alertsEnabled: pulumi.Output<boolean>;
    /**
     * The dashboard folder associated with this integration.
     */
    readonly dashboardFolder: pulumi.Output<string>;
    /**
     * The version of the installed integration.
     */
    readonly installedVersion: pulumi.Output<string>;
    /**
     * The latest version available for this integration.
     */
    readonly latestVersion: pulumi.Output<string>;
    /**
     * The display name of the integration.
     */
    readonly name: pulumi.Output<string>;
    /**
     * The slug of the integration to install (e.g., 'docker', 'linux-node').
     */
    readonly slug: pulumi.Output<string>;
    /**
     * Create a Integration 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: IntegrationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Integration resources.
 */
export interface IntegrationState {
    /**
     * Whether alerts are enabled for this integration.
     */
    alertsEnabled?: pulumi.Input<boolean>;
    /**
     * The dashboard folder associated with this integration.
     */
    dashboardFolder?: pulumi.Input<string>;
    /**
     * The version of the installed integration.
     */
    installedVersion?: pulumi.Input<string>;
    /**
     * The latest version available for this integration.
     */
    latestVersion?: pulumi.Input<string>;
    /**
     * The display name of the integration.
     */
    name?: pulumi.Input<string>;
    /**
     * The slug of the integration to install (e.g., 'docker', 'linux-node').
     */
    slug?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a Integration resource.
 */
export interface IntegrationArgs {
    /**
     * Whether alerts are enabled for this integration.
     */
    alertsEnabled?: pulumi.Input<boolean>;
    /**
     * The slug of the integration to install (e.g., 'docker', 'linux-node').
     */
    slug: pulumi.Input<string>;
}