@pulumiverse/scaleway/cockpit.d.ts

A Pulumi package for creating and managing Scaleway cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
/**
 * > **Important:** The resource `scaleway.observability.Cockpit` has been deprecated and will no longer be supported after January 1st, 2025. Instead, use the new specialized resources:
 *
 * - `scaleway.observability.Source` for managing data sources (metrics, logs, traces)
 * - `scaleway.observability.AlertManager` for managing alert manager
 * - `scaleway.observability.getGrafana` data source for accessing Grafana (authentication via IAM)
 *
 * For detailed migration instructions, see the Cockpit Migration Guide.
 *
 * > **Note:**
 * As of September 2024, Cockpit has introduced [regionalization](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#region) to offer more flexibility and resilience.
 * If you have created customized dashboards with data for your Scaleway resources before April 2024, you will need to update your queries in Grafana, with the new regionalized data sources.
 *
 * > **Note:**
 * From January 1st 2025, Cockpit plans have been deprecated. You can now edit the retention period for all your datasources (metrics, logs, and traces) separately. Refer to our product documentation for more information on [possible retention values](https://www.scaleway.com/en/docs/cockpit/concepts/#retention) and [pricing](https://www.scaleway.com/en/docs/cockpit/faq/#how-am-i-billed-for-increasing-data-retention-period).
 *
 * > **Note:** The `scaleway.observability.GrafanaUser` resource is deprecated. Use the `scaleway.observability.getGrafana` data source to retrieve the Grafana URL and authenticate using your Scaleway IAM credentials.
 *
 * The `scaleway.observability.Cockpit` resource allows you to create and manage Scaleway Cockpit instances.
 *
 * 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
 *
 * ### Manage Cockpit in the Scaleway default Project
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * // Activate Cockpit in the default Project
 * const main = new scaleway.observability.Cockpit("main", {});
 * ```
 *
 * ### Manage Cockpit in a specific Project
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * // Activate Cockpit in a specific Project
 * const main = new scaleway.observability.Cockpit("main", {projectId: "11111111-1111-1111-1111-111111111111"});
 * ```
 *
 * ### Choose a specific pricing plan for Cockpit
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * const main = new scaleway.observability.Cockpit("main", {
 *     projectId: "11111111-1111-1111-1111-111111111111",
 *     plan: "premium",
 * });
 * ```
 *
 * ### Use the Grafana Terraform provider (Deprecated)
 *
 * > **Note:** This example is deprecated. Use the `scaleway.observability.getGrafana` data source with IAM authentication instead.
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as scaleway from "@pulumiverse/scaleway";
 *
 * // Old approach (deprecated) - Using scaleway_cockpit_grafana_user
 * // resource "scaleway_cockpit_grafana_user" "main" {
 * //   project_id = scaleway_cockpit.main.project_id
 * //   login      = "example"
 * //   role       = "editor"
 * // }
 * //
 * // provider "grafana" {
 * //   url  = scaleway_cockpit.main.endpoints.0.grafana_url
 * //   auth = "${scaleway_cockpit_grafana_user.main.login}:${scaleway_cockpit_grafana_user.main.password}"
 * // }
 * // New approach - Use scaleway_cockpit_grafana data source with IAM auth
 * const main = scaleway.observability.getGrafana({
 *     projectId: mainScalewayCockpit.projectId,
 * });
 * ```
 *
 * ## Migration
 *
 * This resource is deprecated and will be removed after January 1st, 2025. To migrate to the new infrastructure, please refer to the Cockpit Migration Guide which provides step-by-step instructions for transitioning to:
 *
 * - `scaleway.observability.Source` for managing data sources (metrics, logs, traces)
 * - `scaleway.observability.AlertManager` for managing alert manager
 * - `scaleway.observability.getGrafana` data source for accessing Grafana (with IAM authentication)
 *
 * ## Import
 *
 * This section explains how to import a Cockpit using its `{project_id}`.
 *
 * ```sh
 * $ pulumi import scaleway:index/cockpit:Cockpit main 11111111-1111-1111-1111-111111111111
 * ```
 *
 * > **Note:** Import functionality will be removed when this resource is deprecated.
 *
 * @deprecated scaleway.index/cockpit.Cockpit has been deprecated in favor of scaleway.observability/cockpit.Cockpit
 */
export declare class Cockpit extends pulumi.CustomResource {
    /**
     * Get an existing Cockpit 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?: CockpitState, opts?: pulumi.CustomResourceOptions): Cockpit;
    /**
     * Returns true if the given object is an instance of Cockpit.  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 Cockpit;
    /**
     * (Deprecated) A list of [endpoints](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#endpoints) related to Cockpit, each with specific URLs:
     *
     * @deprecated Use 'scaleway_cockpit_source' instead of 'endpoints'. This field will be removed in future releases.
     */
    readonly endpoints: pulumi.Output<outputs.CockpitEndpoint[]>;
    /**
     * Name of the plan to use. Available plans are: free, premium, and custom.
     * > **Important:** The plan field is deprecated. Any modification or selection will have no effect.
     *
     * > **Warning:** This entire resource is deprecated and will be removed after January 1st, 2025. Please migrate to the new specialized resources as described in the Cockpit Migration Guide.
     *
     * @deprecated The 'plan' attribute is deprecated and no longer has any effect. Future updates will remove this attribute entirely.
     */
    readonly plan: pulumi.Output<string | undefined>;
    /**
     * (Deprecated) The ID of the current pricing plan.
     *
     * @deprecated The 'plan_id' attribute is deprecated and will be removed in a future release.
     */
    readonly planId: pulumi.Output<string>;
    /**
     * ) The ID of the Project the Cockpit is associated with.
     */
    readonly projectId: pulumi.Output<string>;
    /**
     * [DEPRECATED] Push_url
     *
     * @deprecated Please use `scaleway.observability.Source` instead
     */
    readonly pushUrls: pulumi.Output<outputs.CockpitPushUrl[]>;
    /**
     * Create a Cockpit 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/cockpit.Cockpit has been deprecated in favor of scaleway.observability/cockpit.Cockpit */
    constructor(name: string, args?: CockpitArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering Cockpit resources.
 */
export interface CockpitState {
    /**
     * (Deprecated) A list of [endpoints](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#endpoints) related to Cockpit, each with specific URLs:
     *
     * @deprecated Use 'scaleway_cockpit_source' instead of 'endpoints'. This field will be removed in future releases.
     */
    endpoints?: pulumi.Input<pulumi.Input<inputs.CockpitEndpoint>[] | undefined>;
    /**
     * Name of the plan to use. Available plans are: free, premium, and custom.
     * > **Important:** The plan field is deprecated. Any modification or selection will have no effect.
     *
     * > **Warning:** This entire resource is deprecated and will be removed after January 1st, 2025. Please migrate to the new specialized resources as described in the Cockpit Migration Guide.
     *
     * @deprecated The 'plan' attribute is deprecated and no longer has any effect. Future updates will remove this attribute entirely.
     */
    plan?: pulumi.Input<string | undefined>;
    /**
     * (Deprecated) The ID of the current pricing plan.
     *
     * @deprecated The 'plan_id' attribute is deprecated and will be removed in a future release.
     */
    planId?: pulumi.Input<string | undefined>;
    /**
     * ) The ID of the Project the Cockpit is associated with.
     */
    projectId?: pulumi.Input<string | undefined>;
    /**
     * [DEPRECATED] Push_url
     *
     * @deprecated Please use `scaleway.observability.Source` instead
     */
    pushUrls?: pulumi.Input<pulumi.Input<inputs.CockpitPushUrl>[] | undefined>;
}
/**
 * The set of arguments for constructing a Cockpit resource.
 */
export interface CockpitArgs {
    /**
     * Name of the plan to use. Available plans are: free, premium, and custom.
     * > **Important:** The plan field is deprecated. Any modification or selection will have no effect.
     *
     * > **Warning:** This entire resource is deprecated and will be removed after January 1st, 2025. Please migrate to the new specialized resources as described in the Cockpit Migration Guide.
     *
     * @deprecated The 'plan' attribute is deprecated and no longer has any effect. Future updates will remove this attribute entirely.
     */
    plan?: pulumi.Input<string | undefined>;
    /**
     * ) The ID of the Project the Cockpit is associated with.
     */
    projectId?: pulumi.Input<string | undefined>;
}
//# sourceMappingURL=cockpit.d.ts.map