@pulumiverse/scaleway/cockpitGrafanaUser.d.ts

A Pulumi package for creating and managing Scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * > **Deprecated:** This resource is deprecated and will be removed on **January 1st, 2026**.
 *
 * > **Migration Guide:** Grafana authentication is now managed through [Scaleway IAM (Identity and Access Management)](https://www.scaleway.com/en/docs/identity-and-access-management/iam/). To access your Grafana instance, use the `scaleway.observability.getGrafana` data source to retrieve the Grafana URL and authenticate using your Scaleway IAM credentials.
 *
 * The `scaleway.observability.GrafanaUser` resource allows you to create and manage [Grafana users](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#grafana-users) in Scaleway Cockpit.
 *
 * Refer to Cockpit's [product documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/) and [API documentation](https://www.scaleway.com/en/developers/api/cockpit/regional-api) for more information.
 *
 * ## Example Usage
 *
 * ### Migration to IAM Authentication
 *
 * Instead of managing Grafana users, retrieve your Grafana URL using the data source:
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * // Old approach (deprecated)
 * // resource "scaleway_cockpit_grafana_user" "main" {
 * //   project_id = scaleway_account_project.project.id
 * //   login      = "my-awesome-user"
 * //   role       = "editor"
 * // }
 * // New approach - Use IAM authentication
 * const main = scaleway.observability.getGrafana({
 *     projectId: project.id,
 * });
 * export const grafanaUrl = main.then(main => main.grafanaUrl);
 * ```
 *
 * ### Programmatic access with the Grafana provider
 *
 * To automate Grafana configuration (e.g., dashboards, alerting) with Terraform, reuse your Scaleway IAM secret as an `X-Auth-Token` header. The Grafana provider must run in `anonymous` mode because user/password authentication is deprecated.
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * const config = new pulumi.Config();
 * // Scaleway IAM secret key used for both the Scaleway and Grafana providers
 * const scalewaySecretKey = config.require("scalewaySecretKey");
 * const main = scaleway.observability.getGrafana({
 *     projectId: project.id,
 * });
 * ```
 *
 * The header `X-Auth-Token` is mandatory when Grafana users are disabled. Store the IAM secret key securely (environment variable, secrets manager, etc.) and avoid committing it to version control.
 *
 * ### Create a Grafana user (Deprecated)
 *
 * The following command allows you to create a Grafana user within a specific Scaleway Project.
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * const project = new scaleway.account.Project("project", {name: "test project grafana user"});
 * const main = new scaleway.observability.GrafanaUser("main", {
 *     projectId: project.id,
 *     login: "my-awesome-user",
 *     role: "editor",
 * });
 * ```
 *
 * ## Import
 *
 * This section explains how to import Grafana users using the ID of the Project associated with Cockpit, and the Grafana user ID in the `{project_id}/{grafana_user_id}` format.
 *
 * ```sh
 * $ pulumi import scaleway:index/cockpitGrafanaUser:CockpitGrafanaUser main 11111111-1111-1111-1111-111111111111/2
 * ```
 *
 * @deprecated scaleway.index/cockpitgrafanauser.CockpitGrafanaUser has been deprecated in favor of scaleway.observability/grafanauser.GrafanaUser
 */
export declare class CockpitGrafanaUser extends pulumi.CustomResource {
    /**
     * Get an existing CockpitGrafanaUser 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?: CockpitGrafanaUserState, opts?: pulumi.CustomResourceOptions): CockpitGrafanaUser;
    /**
     * Returns true if the given object is an instance of CockpitGrafanaUser.  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 CockpitGrafanaUser;
    /**
     * URL for Grafana.
     */
    readonly grafanaUrl: pulumi.Output<string>;
    /**
     * The username of the Grafana user. The `admin` user is not yet available for creation. You need your Grafana username to log in to Grafana and access your dashboards.
     */
    readonly login: pulumi.Output<string>;
    /**
     * The password of the Grafana user.
     */
    readonly password: pulumi.Output<string>;
    /**
     * ) The ID of the Project the Cockpit is associated with.
     */
    readonly projectId: pulumi.Output<string>;
    /**
     * The role assigned to the Grafana user. Must be `editor` or `viewer`.
     */
    readonly role: pulumi.Output<string>;
    /**
     * Create a CockpitGrafanaUser 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.
     */
    /** @deprecated scaleway.index/cockpitgrafanauser.CockpitGrafanaUser has been deprecated in favor of scaleway.observability/grafanauser.GrafanaUser */
    constructor(name: string, args: CockpitGrafanaUserArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering CockpitGrafanaUser resources.
 */
export interface CockpitGrafanaUserState {
    /**
     * URL for Grafana.
     */
    grafanaUrl?: pulumi.Input<string | undefined>;
    /**
     * The username of the Grafana user. The `admin` user is not yet available for creation. You need your Grafana username to log in to Grafana and access your dashboards.
     */
    login?: pulumi.Input<string | undefined>;
    /**
     * The password of the Grafana user.
     */
    password?: pulumi.Input<string | undefined>;
    /**
     * ) The ID of the Project the Cockpit is associated with.
     */
    projectId?: pulumi.Input<string | undefined>;
    /**
     * The role assigned to the Grafana user. Must be `editor` or `viewer`.
     */
    role?: pulumi.Input<string | undefined>;
}
/**
 * The set of arguments for constructing a CockpitGrafanaUser resource.
 */
export interface CockpitGrafanaUserArgs {
    /**
     * The username of the Grafana user. The `admin` user is not yet available for creation. You need your Grafana username to log in to Grafana and access your dashboards.
     */
    login: pulumi.Input<string>;
    /**
     * ) The ID of the Project the Cockpit is associated with.
     */
    projectId?: pulumi.Input<string | undefined>;
    /**
     * The role assigned to the Grafana user. Must be `editor` or `viewer`.
     */
    role: pulumi.Input<string>;
}
//# sourceMappingURL=cockpitGrafanaUser.d.ts.map