@lbrlabs/pulumi-scaleway
Version:
A Pulumi package for creating and managing scaleway cloud resources.
110 lines (109 loc) • 3.92 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates and manages Scaleway Cockpit Grafana Users.
*
* For more information consult the [documentation](https://www.scaleway.com/en/docs/observability/cockpit/concepts/#grafana-users).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as scaleway from "@lbrlabs/pulumi-scaleway";
* import * as scaleway from "@pulumi/scaleway";
*
* const mainCockpit = scaleway.getCockpit({});
* // Create an editor grafana user for the cockpit
* const mainCockpitGrafanaUser = new scaleway.CockpitGrafanaUser("mainCockpitGrafanaUser", {
* projectId: mainCockpit.then(mainCockpit => mainCockpit.projectId),
* login: "my-awesome-user",
* role: "editor",
* });
* ```
*
* ## Import
*
* Cockpits Grafana Users can be imported using the project ID and the grafana user ID formatted `{project_id}/{grafana_user_id}`, e.g. bash
*
* ```sh
* $ pulumi import scaleway:index/cockpitGrafanaUser:CockpitGrafanaUser main 11111111-1111-1111-1111-111111111111/2
* ```
*/
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;
/**
* The login of the grafana user.
*/
readonly login: pulumi.Output<string>;
/**
* The password of the grafana user
*/
readonly password: pulumi.Output<string>;
/**
* `projectId`) The ID of the project the cockpit is associated with.
*/
readonly projectId: pulumi.Output<string>;
/**
* The role of 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.
*/
constructor(name: string, args: CockpitGrafanaUserArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering CockpitGrafanaUser resources.
*/
export interface CockpitGrafanaUserState {
/**
* The login of the grafana user.
*/
login?: pulumi.Input<string>;
/**
* The password of the grafana user
*/
password?: pulumi.Input<string>;
/**
* `projectId`) The ID of the project the cockpit is associated with.
*/
projectId?: pulumi.Input<string>;
/**
* The role of the grafana user. Must be `editor` or `viewer`.
*/
role?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a CockpitGrafanaUser resource.
*/
export interface CockpitGrafanaUserArgs {
/**
* The login of the grafana user.
*/
login: pulumi.Input<string>;
/**
* `projectId`) The ID of the project the cockpit is associated with.
*/
projectId?: pulumi.Input<string>;
/**
* The role of the grafana user. Must be `editor` or `viewer`.
*/
role: pulumi.Input<string>;
}