published on Friday, May 1, 2026 by pulumiverse
published on Friday, May 1, 2026 by pulumiverse
Manages Grafana dashboards using the new Grafana APIs.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as grafana from "@pulumiverse/grafana";
const example = new grafana.apps.v1beta1.Dashboard("example", {
metadata: {
uid: "example-dashboard",
},
spec: {
title: "Example Dashboard",
json: JSON.stringify({
title: "Example Dashboard",
uid: "example-dashboard",
panels: [],
schemaVersion: 42,
}),
},
});
import pulumi
import json
import pulumiverse_grafana as grafana
example = grafana.apps.v1beta1.Dashboard("example",
metadata={
"uid": "example-dashboard",
},
spec={
"title": "Example Dashboard",
"json": json.dumps({
"title": "Example Dashboard",
"uid": "example-dashboard",
"panels": [],
"schemaVersion": 42,
}),
})
package main
import (
"encoding/json"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumiverse/pulumi-grafana/sdk/v2/go/grafana/apps"
appsv1beta1 "github.com/pulumiverse/pulumi-grafana/sdk/v2/go/grafana/apps/v1beta1"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
tmpJSON0, err := json.Marshal(map[string]interface{}{
"title": "Example Dashboard",
"uid": "example-dashboard",
"panels": []interface{}{},
"schemaVersion": 42,
})
if err != nil {
return err
}
json0 := string(tmpJSON0)
_, err = apps.NewDashboard(ctx, "example", &apps.DashboardArgs{
Metadata: &appsv1beta1.DashboardMetadataArgs{
Uid: pulumi.String("example-dashboard"),
},
Spec: &appsv1beta1.DashboardSpecArgs{
Title: pulumi.String("Example Dashboard"),
Json: pulumi.String(pulumi.String(json0)),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using System.Text.Json;
using Pulumi;
using Grafana = Pulumiverse.Grafana;
return await Deployment.RunAsync(() =>
{
var example = new Grafana.Apps.V1Beta1.Dashboard("example", new()
{
Metadata = new Grafana.Apps.V1Beta1.Inputs.DashboardMetadataArgs
{
Uid = "example-dashboard",
},
Spec = new Grafana.Apps.V1Beta1.Inputs.DashboardSpecArgs
{
Title = "Example Dashboard",
Json = JsonSerializer.Serialize(new Dictionary<string, object?>
{
["title"] = "Example Dashboard",
["uid"] = "example-dashboard",
["panels"] = new[]
{
},
["schemaVersion"] = 42,
}),
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.grafana.apps_v1beta1.Dashboard;
import com.pulumi.grafana.apps_v1beta1.DashboardArgs;
import com.pulumi.grafana.apps.inputs.DashboardMetadataArgs;
import com.pulumi.grafana.apps.inputs.DashboardSpecArgs;
import static com.pulumi.codegen.internal.Serialization.*;
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 example = new Dashboard("example", DashboardArgs.builder()
.metadata(DashboardMetadataArgs.builder()
.uid("example-dashboard")
.build())
.spec(DashboardSpecArgs.builder()
.title("Example Dashboard")
.json(serializeJson(
jsonObject(
jsonProperty("title", "Example Dashboard"),
jsonProperty("uid", "example-dashboard"),
jsonProperty("panels", jsonArray(
)),
jsonProperty("schemaVersion", 42)
)))
.build())
.build());
}
}
resources:
example:
type: grafana:apps/v1beta1:Dashboard
properties:
metadata:
uid: example-dashboard
spec:
title: Example Dashboard
json:
fn::toJSON:
title: Example Dashboard
uid: example-dashboard
panels: []
schemaVersion: 42
Create AppsDashboard Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AppsDashboard(name: string, args?: AppsDashboardArgs, opts?: CustomResourceOptions);@overload
def AppsDashboard(resource_name: str,
args: Optional[AppsDashboardArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def AppsDashboard(resource_name: str,
opts: Optional[ResourceOptions] = None,
metadata: Optional[AppsDashboardMetadataArgs] = None,
options: Optional[AppsDashboardOptionsArgs] = None,
spec: Optional[AppsDashboardSpecArgs] = None)func NewAppsDashboard(ctx *Context, name string, args *AppsDashboardArgs, opts ...ResourceOption) (*AppsDashboard, error)public AppsDashboard(string name, AppsDashboardArgs? args = null, CustomResourceOptions? opts = null)
public AppsDashboard(String name, AppsDashboardArgs args)
public AppsDashboard(String name, AppsDashboardArgs args, CustomResourceOptions options)
type: grafana:experimental:AppsDashboard
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 AppsDashboardArgs
- 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 AppsDashboardArgs
- 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 AppsDashboardArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AppsDashboardArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AppsDashboardArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
AppsDashboard 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 AppsDashboard resource accepts the following input properties:
- Metadata
Pulumiverse.
Grafana. Experimental. Inputs. Apps Dashboard Metadata - The metadata of the resource.
- Options
Pulumiverse.
Grafana. Experimental. Inputs. Apps Dashboard Options - Options for applying the resource.
- Spec
Pulumiverse.
Grafana. Experimental. Inputs. Apps Dashboard Spec - The spec of the resource.
- Metadata
Apps
Dashboard Metadata Args - The metadata of the resource.
- Options
Apps
Dashboard Options Args - Options for applying the resource.
- Spec
Apps
Dashboard Spec Args - The spec of the resource.
- metadata
Apps
Dashboard Metadata - The metadata of the resource.
- options
Apps
Dashboard Options - Options for applying the resource.
- spec
Apps
Dashboard Spec - The spec of the resource.
- metadata
Apps
Dashboard Metadata - The metadata of the resource.
- options
Apps
Dashboard Options - Options for applying the resource.
- spec
Apps
Dashboard Spec - The spec of the resource.
- metadata
Apps
Dashboard Metadata Args - The metadata of the resource.
- options
Apps
Dashboard Options Args - Options for applying the resource.
- spec
Apps
Dashboard Spec Args - The spec of the resource.
- metadata Property Map
- The metadata of the resource.
- options Property Map
- Options for applying the resource.
- spec Property Map
- The spec of the resource.
Outputs
All input properties are implicitly available as output properties. Additionally, the AppsDashboard resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing AppsDashboard Resource
Get an existing AppsDashboard 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?: AppsDashboardState, opts?: CustomResourceOptions): AppsDashboard@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
metadata: Optional[AppsDashboardMetadataArgs] = None,
options: Optional[AppsDashboardOptionsArgs] = None,
spec: Optional[AppsDashboardSpecArgs] = None) -> AppsDashboardfunc GetAppsDashboard(ctx *Context, name string, id IDInput, state *AppsDashboardState, opts ...ResourceOption) (*AppsDashboard, error)public static AppsDashboard Get(string name, Input<string> id, AppsDashboardState? state, CustomResourceOptions? opts = null)public static AppsDashboard get(String name, Output<String> id, AppsDashboardState state, CustomResourceOptions options)resources: _: type: grafana:experimental:AppsDashboard 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.
- Metadata
Pulumiverse.
Grafana. Experimental. Inputs. Apps Dashboard Metadata - The metadata of the resource.
- Options
Pulumiverse.
Grafana. Experimental. Inputs. Apps Dashboard Options - Options for applying the resource.
- Spec
Pulumiverse.
Grafana. Experimental. Inputs. Apps Dashboard Spec - The spec of the resource.
- Metadata
Apps
Dashboard Metadata Args - The metadata of the resource.
- Options
Apps
Dashboard Options Args - Options for applying the resource.
- Spec
Apps
Dashboard Spec Args - The spec of the resource.
- metadata
Apps
Dashboard Metadata - The metadata of the resource.
- options
Apps
Dashboard Options - Options for applying the resource.
- spec
Apps
Dashboard Spec - The spec of the resource.
- metadata
Apps
Dashboard Metadata - The metadata of the resource.
- options
Apps
Dashboard Options - Options for applying the resource.
- spec
Apps
Dashboard Spec - The spec of the resource.
- metadata
Apps
Dashboard Metadata Args - The metadata of the resource.
- options
Apps
Dashboard Options Args - Options for applying the resource.
- spec
Apps
Dashboard Spec Args - The spec of the resource.
- metadata Property Map
- The metadata of the resource.
- options Property Map
- Options for applying the resource.
- spec Property Map
- The spec of the resource.
Supporting Types
AppsDashboardMetadata, AppsDashboardMetadataArgs
- Uid string
- The unique identifier of the resource.
- Annotations Dictionary<string, string>
- Annotations of the resource.
- Folder
Uid string - The UID of the folder to save the resource in. For example, it's supported for dashboards and folders. To know if it's supported for the specific resource you're using check the documentation.
- Url string
- The full URL of the resource.
- Uuid string
- The globally unique identifier of a resource, used by the API for tracking.
- Version string
- The version of the resource.
- Uid string
- The unique identifier of the resource.
- Annotations map[string]string
- Annotations of the resource.
- Folder
Uid string - The UID of the folder to save the resource in. For example, it's supported for dashboards and folders. To know if it's supported for the specific resource you're using check the documentation.
- Url string
- The full URL of the resource.
- Uuid string
- The globally unique identifier of a resource, used by the API for tracking.
- Version string
- The version of the resource.
- uid String
- The unique identifier of the resource.
- annotations Map<String,String>
- Annotations of the resource.
- folder
Uid String - The UID of the folder to save the resource in. For example, it's supported for dashboards and folders. To know if it's supported for the specific resource you're using check the documentation.
- url String
- The full URL of the resource.
- uuid String
- The globally unique identifier of a resource, used by the API for tracking.
- version String
- The version of the resource.
- uid string
- The unique identifier of the resource.
- annotations {[key: string]: string}
- Annotations of the resource.
- folder
Uid string - The UID of the folder to save the resource in. For example, it's supported for dashboards and folders. To know if it's supported for the specific resource you're using check the documentation.
- url string
- The full URL of the resource.
- uuid string
- The globally unique identifier of a resource, used by the API for tracking.
- version string
- The version of the resource.
- uid str
- The unique identifier of the resource.
- annotations Mapping[str, str]
- Annotations of the resource.
- folder_
uid str - The UID of the folder to save the resource in. For example, it's supported for dashboards and folders. To know if it's supported for the specific resource you're using check the documentation.
- url str
- The full URL of the resource.
- uuid str
- The globally unique identifier of a resource, used by the API for tracking.
- version str
- The version of the resource.
- uid String
- The unique identifier of the resource.
- annotations Map<String>
- Annotations of the resource.
- folder
Uid String - The UID of the folder to save the resource in. For example, it's supported for dashboards and folders. To know if it's supported for the specific resource you're using check the documentation.
- url String
- The full URL of the resource.
- uuid String
- The globally unique identifier of a resource, used by the API for tracking.
- version String
- The version of the resource.
AppsDashboardOptions, AppsDashboardOptionsArgs
- Allow
Ui boolUpdates - Set to true to allow editing the resource from the Grafana UI. By default, resources managed by Terraform cannot be edited in the UI. Enabling this option will cause divergence between the Terraform configuration and the resource in Grafana.
- Manager
Identity string - Override the identity stamped on this resource's manager metadata. Defaults to "grafana-terraform-provider". Use this to distinguish resources managed by different Pulumi Stacks targeting the same Grafana instance.
- Overwrite bool
- Set to true if you want to overwrite existing resource with newer version, same resource title in folder or same resource uid.
- Allow
Ui boolUpdates - Set to true to allow editing the resource from the Grafana UI. By default, resources managed by Terraform cannot be edited in the UI. Enabling this option will cause divergence between the Terraform configuration and the resource in Grafana.
- Manager
Identity string - Override the identity stamped on this resource's manager metadata. Defaults to "grafana-terraform-provider". Use this to distinguish resources managed by different Pulumi Stacks targeting the same Grafana instance.
- Overwrite bool
- Set to true if you want to overwrite existing resource with newer version, same resource title in folder or same resource uid.
- allow
Ui BooleanUpdates - Set to true to allow editing the resource from the Grafana UI. By default, resources managed by Terraform cannot be edited in the UI. Enabling this option will cause divergence between the Terraform configuration and the resource in Grafana.
- manager
Identity String - Override the identity stamped on this resource's manager metadata. Defaults to "grafana-terraform-provider". Use this to distinguish resources managed by different Pulumi Stacks targeting the same Grafana instance.
- overwrite Boolean
- Set to true if you want to overwrite existing resource with newer version, same resource title in folder or same resource uid.
- allow
Ui booleanUpdates - Set to true to allow editing the resource from the Grafana UI. By default, resources managed by Terraform cannot be edited in the UI. Enabling this option will cause divergence between the Terraform configuration and the resource in Grafana.
- manager
Identity string - Override the identity stamped on this resource's manager metadata. Defaults to "grafana-terraform-provider". Use this to distinguish resources managed by different Pulumi Stacks targeting the same Grafana instance.
- overwrite boolean
- Set to true if you want to overwrite existing resource with newer version, same resource title in folder or same resource uid.
- allow_
ui_ boolupdates - Set to true to allow editing the resource from the Grafana UI. By default, resources managed by Terraform cannot be edited in the UI. Enabling this option will cause divergence between the Terraform configuration and the resource in Grafana.
- manager_
identity str - Override the identity stamped on this resource's manager metadata. Defaults to "grafana-terraform-provider". Use this to distinguish resources managed by different Pulumi Stacks targeting the same Grafana instance.
- overwrite bool
- Set to true if you want to overwrite existing resource with newer version, same resource title in folder or same resource uid.
- allow
Ui BooleanUpdates - Set to true to allow editing the resource from the Grafana UI. By default, resources managed by Terraform cannot be edited in the UI. Enabling this option will cause divergence between the Terraform configuration and the resource in Grafana.
- manager
Identity String - Override the identity stamped on this resource's manager metadata. Defaults to "grafana-terraform-provider". Use this to distinguish resources managed by different Pulumi Stacks targeting the same Grafana instance.
- overwrite Boolean
- Set to true if you want to overwrite existing resource with newer version, same resource title in folder or same resource uid.
AppsDashboardSpec, AppsDashboardSpecArgs
Package Details
- Repository
- grafana pulumiverse/pulumi-grafana
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
grafanaTerraform Provider.
published on Friday, May 1, 2026 by pulumiverse
