Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scaleway
  3. API Docs
  4. observability
  5. GrafanaUser
Scaleway v1.25.0 published on Saturday, Mar 22, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

scaleway.observability.GrafanaUser

Explore with Pulumi AI

scaleway logo
Scaleway v1.25.0 published on Saturday, Mar 22, 2025 by pulumiverse
pulumiverse/pulumi-scaleway

    The scaleway.observability.GrafanaUser resource allows you to create and manage Grafana users in Scaleway Cockpit.

    Refer to Cockpit’s product documentation and API documentation for more information.

    Example Usage

    Create a Grafana user

    The following command allows you to create a Grafana user within a specific Scaleway Project.

    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 pulumi
import pulumiverse_scaleway as scaleway

project = scaleway.account.Project("project", name="test project grafana user")
main = scaleway.observability.GrafanaUser("main",
    project_id=project.id,
    login="my-awesome-user",
    role="editor")

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/account"
	"github.com/pulumiverse/pulumi-scaleway/sdk/go/scaleway/observability"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		project, err := account.NewProject(ctx, "project", &account.ProjectArgs{
			Name: pulumi.String("test project grafana user"),
		})
		if err != nil {
			return err
		}
		_, err = observability.NewGrafanaUser(ctx, "main", &observability.GrafanaUserArgs{
			ProjectId: project.ID(),
			Login:     pulumi.String("my-awesome-user"),
			Role:      pulumi.String("editor"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scaleway = Pulumiverse.Scaleway;

return await Deployment.RunAsync(() => 
{
    var project = new Scaleway.Account.Project("project", new()
    {
        Name = "test project grafana user",
    });

    var main = new Scaleway.Observability.GrafanaUser("main", new()
    {
        ProjectId = project.Id,
        Login = "my-awesome-user",
        Role = "editor",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.scaleway.account.Project;
import com.pulumi.scaleway.account.ProjectArgs;
import com.pulumi.scaleway.observability.GrafanaUser;
import com.pulumi.scaleway.observability.GrafanaUserArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var project = new Project("project", ProjectArgs.builder()
            .name("test project grafana user")
            .build());

        var main = new GrafanaUser("main", GrafanaUserArgs.builder()
            .projectId(project.id())
            .login("my-awesome-user")
            .role("editor")
            .build());

    }
}

    resources:
  project:
    type: scaleway:account:Project
    properties:
      name: test project grafana user
  main:
    type: scaleway:observability:GrafanaUser
    properties:
      projectId: ${project.id}
      login: my-awesome-user
      role: editor

    Create GrafanaUser Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new GrafanaUser(name: string, args: GrafanaUserArgs, opts?: CustomResourceOptions);
    @overload
def GrafanaUser(resource_name: str,
                args: GrafanaUserArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def GrafanaUser(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                login: Optional[str] = None,
                role: Optional[str] = None,
                project_id: Optional[str] = None)
    func NewGrafanaUser(ctx *Context, name string, args GrafanaUserArgs, opts ...ResourceOption) (*GrafanaUser, error)
    public GrafanaUser(string name, GrafanaUserArgs args, CustomResourceOptions? opts = null)
    public GrafanaUser(String name, GrafanaUserArgs args)
public GrafanaUser(String name, GrafanaUserArgs args, CustomResourceOptions options)

    type: scaleway:observability:GrafanaUser
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args GrafanaUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GrafanaUserArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GrafanaUserArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GrafanaUserArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GrafanaUserArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var grafanaUserResource = new Scaleway.Observability.GrafanaUser("grafanaUserResource", new()
{
    Login = "string",
    Role = "string",
    ProjectId = "string",
});

    example, err := observability.NewGrafanaUser(ctx, "grafanaUserResource", &observability.GrafanaUserArgs{
	Login:     pulumi.String("string"),
	Role:      pulumi.String("string"),
	ProjectId: pulumi.String("string"),
})

    var grafanaUserResource = new GrafanaUser("grafanaUserResource", GrafanaUserArgs.builder()
    .login("string")
    .role("string")
    .projectId("string")
    .build());

    grafana_user_resource = scaleway.observability.GrafanaUser("grafanaUserResource",
    login="string",
    role="string",
    project_id="string")

    const grafanaUserResource = new scaleway.observability.GrafanaUser("grafanaUserResource", {
    login: "string",
    role: "string",
    projectId: "string",
});

    type: scaleway:observability:GrafanaUser
properties:
    login: string
    projectId: string
    role: string

    GrafanaUser Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The GrafanaUser resource accepts the following input properties:

    Login 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.
    Role string
    The role assigned to the Grafana user. Must be editor or viewer.
    ProjectId string
    ) The ID of the Project the Cockpit is associated with.
    Login 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.
    Role string
    The role assigned to the Grafana user. Must be editor or viewer.
    ProjectId string
    ) The ID of the Project the Cockpit is associated with.
    login 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.
    role String
    The role assigned to the Grafana user. Must be editor or viewer.
    projectId String
    ) The ID of the Project the Cockpit is associated with.
    login 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.
    role string
    The role assigned to the Grafana user. Must be editor or viewer.
    projectId string
    ) The ID of the Project the Cockpit is associated with.
    login str
    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.
    role str
    The role assigned to the Grafana user. Must be editor or viewer.
    project_id str
    ) The ID of the Project the Cockpit is associated with.
    login 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.
    role String
    The role assigned to the Grafana user. Must be editor or viewer.
    projectId String
    ) The ID of the Project the Cockpit is associated with.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the GrafanaUser resource produces the following output properties:

    GrafanaUrl string
    URL for Grafana.
    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    The password of the Grafana user.
    GrafanaUrl string
    URL for Grafana.
    Id string
    The provider-assigned unique ID for this managed resource.
    Password string
    The password of the Grafana user.
    grafanaUrl String
    URL for Grafana.
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    The password of the Grafana user.
    grafanaUrl string
    URL for Grafana.
    id string
    The provider-assigned unique ID for this managed resource.
    password string
    The password of the Grafana user.
    grafana_url str
    URL for Grafana.
    id str
    The provider-assigned unique ID for this managed resource.
    password str
    The password of the Grafana user.
    grafanaUrl String
    URL for Grafana.
    id String
    The provider-assigned unique ID for this managed resource.
    password String
    The password of the Grafana user.

    Look up Existing GrafanaUser Resource

    Get an existing GrafanaUser resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: GrafanaUserState, opts?: CustomResourceOptions): GrafanaUser
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        grafana_url: Optional[str] = None,
        login: Optional[str] = None,
        password: Optional[str] = None,
        project_id: Optional[str] = None,
        role: Optional[str] = None) -> GrafanaUser
    func GetGrafanaUser(ctx *Context, name string, id IDInput, state *GrafanaUserState, opts ...ResourceOption) (*GrafanaUser, error)
    public static GrafanaUser Get(string name, Input<string> id, GrafanaUserState? state, CustomResourceOptions? opts = null)
    public static GrafanaUser get(String name, Output<String> id, GrafanaUserState state, CustomResourceOptions options)
    resources:  _:    type: scaleway:observability:GrafanaUser    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    GrafanaUrl string
    URL for Grafana.
    Login 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.
    Password string
    The password of the Grafana user.
    ProjectId string
    ) The ID of the Project the Cockpit is associated with.
    Role string
    The role assigned to the Grafana user. Must be editor or viewer.
    GrafanaUrl string
    URL for Grafana.
    Login 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.
    Password string
    The password of the Grafana user.
    ProjectId string
    ) The ID of the Project the Cockpit is associated with.
    Role string
    The role assigned to the Grafana user. Must be editor or viewer.
    grafanaUrl String
    URL for Grafana.
    login 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.
    password String
    The password of the Grafana user.
    projectId String
    ) The ID of the Project the Cockpit is associated with.
    role String
    The role assigned to the Grafana user. Must be editor or viewer.
    grafanaUrl string
    URL for Grafana.
    login 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.
    password string
    The password of the Grafana user.
    projectId string
    ) The ID of the Project the Cockpit is associated with.
    role string
    The role assigned to the Grafana user. Must be editor or viewer.
    grafana_url str
    URL for Grafana.
    login str
    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.
    password str
    The password of the Grafana user.
    project_id str
    ) The ID of the Project the Cockpit is associated with.
    role str
    The role assigned to the Grafana user. Must be editor or viewer.
    grafanaUrl String
    URL for Grafana.
    login 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.
    password String
    The password of the Grafana user.
    projectId String
    ) The ID of the Project the Cockpit is associated with.
    role String
    The role assigned to the Grafana user. Must be editor or viewer.

    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.

    bash

    $ pulumi import scaleway:observability/grafanaUser:GrafanaUser main 11111111-1111-1111-1111-111111111111/2

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    scaleway pulumiverse/pulumi-scaleway
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scaleway Terraform Provider.
    scaleway logo
    Scaleway v1.25.0 published on Saturday, Mar 22, 2025 by pulumiverse
    pulumiverse/pulumi-scaleway