1. Packages
  2. Packages
  3. Chronosphere
  4. API Docs
  5. Dashboard
Viewing docs for Chronosphere v0.9.16
published on Friday, Jun 5, 2026 by Chronosphere
Viewing docs for Chronosphere v0.9.16
published on Friday, Jun 5, 2026 by Chronosphere

    A Chronosphere dashboard composed of panels, layouts, and variables defined by dashboard_json. For Grafana-compatible dashboards, use chronosphere.ClassicDashboard instead.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using System.Text.Json;
    using Pulumi;
    using Pulumi = Chronosphere.Pulumi;
    
    return await Deployment.RunAsync(() => 
    {
        var collection = new Pulumi.Collection("collection", new()
        {
            Name = "Platform",
        });
    
        var platform = new Pulumi.Dashboard("platform", new()
        {
            Name = "Platform Overview",
            Slug = "platform-overview",
            CollectionId = collection.Id,
            Labels = 
            {
                { "team", "platform" },
            },
            DashboardJson = JsonSerializer.Serialize(new Dictionary<string, object?>
            {
                ["kind"] = "Dashboard",
                ["spec"] = new Dictionary<string, object?>
                {
                    ["events"] = new[]
                    {
                    },
                    ["panels"] = new Dictionary<string, object?>
                    {
                    },
                    ["layouts"] = new[]
                    {
                    },
                    ["variables"] = new[]
                    {
                    },
                    ["duration"] = "30m",
                },
                ["spec_version"] = "1",
            }),
        });
    
    });
    
    package main
    
    import (
    	"encoding/json"
    
    	"github.com/chronosphereio/pulumi-chronosphere/sdk/go/chronosphere"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		collection, err := chronosphere.NewCollection(ctx, "collection", &chronosphere.CollectionArgs{
    			Name: pulumi.String("Platform"),
    		})
    		if err != nil {
    			return err
    		}
    		tmpJSON0, err := json.Marshal(map[string]interface{}{
    			"kind": "Dashboard",
    			"spec": map[string]interface{}{
    				"events":    []interface{}{},
    				"panels":    nil,
    				"layouts":   []interface{}{},
    				"variables": []interface{}{},
    				"duration":  "30m",
    			},
    			"spec_version": "1",
    		})
    		if err != nil {
    			return err
    		}
    		json0 := string(tmpJSON0)
    		_, err = chronosphere.NewDashboard(ctx, "platform", &chronosphere.DashboardArgs{
    			Name:         pulumi.String("Platform Overview"),
    			Slug:         pulumi.String("platform-overview"),
    			CollectionId: collection.ID(),
    			Labels: pulumi.StringMap{
    				"team": pulumi.String("platform"),
    			},
    			DashboardJson: pulumi.String(json0),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    

    Example coming soon!

    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.chronosphere.Collection;
    import com.pulumi.chronosphere.CollectionArgs;
    import com.pulumi.chronosphere.Dashboard;
    import com.pulumi.chronosphere.DashboardArgs;
    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 collection = new Collection("collection", CollectionArgs.builder()        
                .name("Platform")
                .build());
    
            var platform = new Dashboard("platform", DashboardArgs.builder()        
                .name("Platform Overview")
                .slug("platform-overview")
                .collectionId(collection.id())
                .labels(Map.of("team", "platform"))
                .dashboardJson(serializeJson(
                    jsonObject(
                        jsonProperty("kind", "Dashboard"),
                        jsonProperty("spec", jsonObject(
                            jsonProperty("events", jsonArray(
                            )),
                            jsonProperty("panels", jsonObject(
    
                            )),
                            jsonProperty("layouts", jsonArray(
                            )),
                            jsonProperty("variables", jsonArray(
                            )),
                            jsonProperty("duration", "30m")
                        )),
                        jsonProperty("spec_version", "1")
                    )))
                .build());
    
        }
    }
    
    import * as pulumi from "@pulumi/pulumi";
    import * as chronosphere from "@pulumi-chronosphere/pulumi-chronosphere";
    
    const collection = new chronosphere.Collection("collection", {name: "Platform"});
    const platform = new chronosphere.Dashboard("platform", {
        name: "Platform Overview",
        slug: "platform-overview",
        collectionId: collection.id,
        labels: {
            team: "platform",
        },
        dashboardJson: JSON.stringify({
            kind: "Dashboard",
            spec: {
                events: [],
                panels: {},
                layouts: [],
                variables: [],
                duration: "30m",
            },
            spec_version: "1",
        }),
    });
    
    import pulumi
    import json
    import pulumi_chronosphere as chronosphere
    
    collection = chronosphere.Collection("collection", name="Platform")
    platform = chronosphere.Dashboard("platform",
        name="Platform Overview",
        slug="platform-overview",
        collection_id=collection.id,
        labels={
            "team": "platform",
        },
        dashboard_json=json.dumps({
            "kind": "Dashboard",
            "spec": {
                "events": [],
                "panels": {},
                "layouts": [],
                "variables": [],
                "duration": "30m",
            },
            "spec_version": "1",
        }))
    
    resources:
      collection:
        type: chronosphere:Collection
        properties:
          name: Platform
      platform:
        type: chronosphere:Dashboard
        properties:
          name: Platform Overview
          slug: platform-overview
          collectionId: ${collection.id}
          labels:
            team: platform
          dashboardJson:
            fn::toJSON:
              kind: Dashboard
              spec:
                events: []
                panels: {}
                layouts: []
                variables: []
                duration: 30m
              spec_version: '1'
    

    Create Dashboard Resource

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

    Constructor syntax

    new Dashboard(name: string, args: DashboardArgs, opts?: CustomResourceOptions);
    @overload
    def Dashboard(resource_name: str,
                  args: DashboardArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Dashboard(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  dashboard_json: Optional[str] = None,
                  collection_id: Optional[str] = None,
                  labels: Optional[Mapping[str, str]] = None,
                  name: Optional[str] = None,
                  slug: Optional[str] = None)
    func NewDashboard(ctx *Context, name string, args DashboardArgs, opts ...ResourceOption) (*Dashboard, error)
    public Dashboard(string name, DashboardArgs args, CustomResourceOptions? opts = null)
    public Dashboard(String name, DashboardArgs args)
    public Dashboard(String name, DashboardArgs args, CustomResourceOptions options)
    
    type: chronosphere:Dashboard
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "chronosphere_dashboard" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args DashboardArgs
    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 DashboardArgs
    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 DashboardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DashboardArgs
    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 dashboardResource = new Pulumi.Dashboard("dashboardResource", new()
    {
        DashboardJson = "string",
        CollectionId = "string",
        Labels = 
        {
            { "string", "string" },
        },
        Name = "string",
        Slug = "string",
    });
    
    example, err := chronosphere.NewDashboard(ctx, "dashboardResource", &chronosphere.DashboardArgs{
    	DashboardJson: pulumi.String("string"),
    	CollectionId:  pulumi.String("string"),
    	Labels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	Slug: pulumi.String("string"),
    })
    
    resource "chronosphere_dashboard" "dashboardResource" {
      dashboard_json = "string"
      collection_id  = "string"
      labels = {
        "string" = "string"
      }
      name = "string"
      slug = "string"
    }
    
    var dashboardResource = new Dashboard("dashboardResource", DashboardArgs.builder()
        .dashboardJson("string")
        .collectionId("string")
        .labels(Map.of("string", "string"))
        .name("string")
        .slug("string")
        .build());
    
    dashboard_resource = chronosphere.Dashboard("dashboardResource",
        dashboard_json="string",
        collection_id="string",
        labels={
            "string": "string",
        },
        name="string",
        slug="string")
    
    const dashboardResource = new chronosphere.Dashboard("dashboardResource", {
        dashboardJson: "string",
        collectionId: "string",
        labels: {
            string: "string",
        },
        name: "string",
        slug: "string",
    });
    
    type: chronosphere:Dashboard
    properties:
        collectionId: string
        dashboardJson: string
        labels:
            string: string
        name: string
        slug: string
    

    Dashboard 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 Dashboard resource accepts the following input properties:

    DashboardJson string
    JSON payload describing the dashboard's panels, layouts, variables, and other content. Wrap with jsonencode({...}) in HCL. The provider sanitizes the JSON before diffing, so cosmetic differences (key ordering, whitespace) do not cause spurious plans.
    CollectionId string
    ID of the collection that owns this dashboard.
    Labels Dictionary<string, string>
    Key/value labels attached to the dashboard for organization and filtering.
    Name string
    Display name of the dashboard. Can be changed after creation.
    Slug string
    Stable identifier for the dashboard. Generated from name if omitted. Immutable after creation.
    DashboardJson string
    JSON payload describing the dashboard's panels, layouts, variables, and other content. Wrap with jsonencode({...}) in HCL. The provider sanitizes the JSON before diffing, so cosmetic differences (key ordering, whitespace) do not cause spurious plans.
    CollectionId string
    ID of the collection that owns this dashboard.
    Labels map[string]string
    Key/value labels attached to the dashboard for organization and filtering.
    Name string
    Display name of the dashboard. Can be changed after creation.
    Slug string
    Stable identifier for the dashboard. Generated from name if omitted. Immutable after creation.
    dashboard_json string
    JSON payload describing the dashboard's panels, layouts, variables, and other content. Wrap with jsonencode({...}) in HCL. The provider sanitizes the JSON before diffing, so cosmetic differences (key ordering, whitespace) do not cause spurious plans.
    collection_id string
    ID of the collection that owns this dashboard.
    labels map(string)
    Key/value labels attached to the dashboard for organization and filtering.
    name string
    Display name of the dashboard. Can be changed after creation.
    slug string
    Stable identifier for the dashboard. Generated from name if omitted. Immutable after creation.
    dashboardJson String
    JSON payload describing the dashboard's panels, layouts, variables, and other content. Wrap with jsonencode({...}) in HCL. The provider sanitizes the JSON before diffing, so cosmetic differences (key ordering, whitespace) do not cause spurious plans.
    collectionId String
    ID of the collection that owns this dashboard.
    labels Map<String,String>
    Key/value labels attached to the dashboard for organization and filtering.
    name String
    Display name of the dashboard. Can be changed after creation.
    slug String
    Stable identifier for the dashboard. Generated from name if omitted. Immutable after creation.
    dashboardJson string
    JSON payload describing the dashboard's panels, layouts, variables, and other content. Wrap with jsonencode({...}) in HCL. The provider sanitizes the JSON before diffing, so cosmetic differences (key ordering, whitespace) do not cause spurious plans.
    collectionId string
    ID of the collection that owns this dashboard.
    labels {[key: string]: string}
    Key/value labels attached to the dashboard for organization and filtering.
    name string
    Display name of the dashboard. Can be changed after creation.
    slug string
    Stable identifier for the dashboard. Generated from name if omitted. Immutable after creation.
    dashboard_json str
    JSON payload describing the dashboard's panels, layouts, variables, and other content. Wrap with jsonencode({...}) in HCL. The provider sanitizes the JSON before diffing, so cosmetic differences (key ordering, whitespace) do not cause spurious plans.
    collection_id str
    ID of the collection that owns this dashboard.
    labels Mapping[str, str]
    Key/value labels attached to the dashboard for organization and filtering.
    name str
    Display name of the dashboard. Can be changed after creation.
    slug str
    Stable identifier for the dashboard. Generated from name if omitted. Immutable after creation.
    dashboardJson String
    JSON payload describing the dashboard's panels, layouts, variables, and other content. Wrap with jsonencode({...}) in HCL. The provider sanitizes the JSON before diffing, so cosmetic differences (key ordering, whitespace) do not cause spurious plans.
    collectionId String
    ID of the collection that owns this dashboard.
    labels Map<String>
    Key/value labels attached to the dashboard for organization and filtering.
    name String
    Display name of the dashboard. Can be changed after creation.
    slug String
    Stable identifier for the dashboard. Generated from name if omitted. Immutable after creation.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Dashboard 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 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 Dashboard Resource

    Get an existing Dashboard 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?: DashboardState, opts?: CustomResourceOptions): Dashboard
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            collection_id: Optional[str] = None,
            dashboard_json: Optional[str] = None,
            labels: Optional[Mapping[str, str]] = None,
            name: Optional[str] = None,
            slug: Optional[str] = None) -> Dashboard
    func GetDashboard(ctx *Context, name string, id IDInput, state *DashboardState, opts ...ResourceOption) (*Dashboard, error)
    public static Dashboard Get(string name, Input<string> id, DashboardState? state, CustomResourceOptions? opts = null)
    public static Dashboard get(String name, Output<String> id, DashboardState state, CustomResourceOptions options)
    resources:  _:    type: chronosphere:Dashboard    get:      id: ${id}
    import {
      to = chronosphere_dashboard.example
      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:
    CollectionId string
    ID of the collection that owns this dashboard.
    DashboardJson string
    JSON payload describing the dashboard's panels, layouts, variables, and other content. Wrap with jsonencode({...}) in HCL. The provider sanitizes the JSON before diffing, so cosmetic differences (key ordering, whitespace) do not cause spurious plans.
    Labels Dictionary<string, string>
    Key/value labels attached to the dashboard for organization and filtering.
    Name string
    Display name of the dashboard. Can be changed after creation.
    Slug string
    Stable identifier for the dashboard. Generated from name if omitted. Immutable after creation.
    CollectionId string
    ID of the collection that owns this dashboard.
    DashboardJson string
    JSON payload describing the dashboard's panels, layouts, variables, and other content. Wrap with jsonencode({...}) in HCL. The provider sanitizes the JSON before diffing, so cosmetic differences (key ordering, whitespace) do not cause spurious plans.
    Labels map[string]string
    Key/value labels attached to the dashboard for organization and filtering.
    Name string
    Display name of the dashboard. Can be changed after creation.
    Slug string
    Stable identifier for the dashboard. Generated from name if omitted. Immutable after creation.
    collection_id string
    ID of the collection that owns this dashboard.
    dashboard_json string
    JSON payload describing the dashboard's panels, layouts, variables, and other content. Wrap with jsonencode({...}) in HCL. The provider sanitizes the JSON before diffing, so cosmetic differences (key ordering, whitespace) do not cause spurious plans.
    labels map(string)
    Key/value labels attached to the dashboard for organization and filtering.
    name string
    Display name of the dashboard. Can be changed after creation.
    slug string
    Stable identifier for the dashboard. Generated from name if omitted. Immutable after creation.
    collectionId String
    ID of the collection that owns this dashboard.
    dashboardJson String
    JSON payload describing the dashboard's panels, layouts, variables, and other content. Wrap with jsonencode({...}) in HCL. The provider sanitizes the JSON before diffing, so cosmetic differences (key ordering, whitespace) do not cause spurious plans.
    labels Map<String,String>
    Key/value labels attached to the dashboard for organization and filtering.
    name String
    Display name of the dashboard. Can be changed after creation.
    slug String
    Stable identifier for the dashboard. Generated from name if omitted. Immutable after creation.
    collectionId string
    ID of the collection that owns this dashboard.
    dashboardJson string
    JSON payload describing the dashboard's panels, layouts, variables, and other content. Wrap with jsonencode({...}) in HCL. The provider sanitizes the JSON before diffing, so cosmetic differences (key ordering, whitespace) do not cause spurious plans.
    labels {[key: string]: string}
    Key/value labels attached to the dashboard for organization and filtering.
    name string
    Display name of the dashboard. Can be changed after creation.
    slug string
    Stable identifier for the dashboard. Generated from name if omitted. Immutable after creation.
    collection_id str
    ID of the collection that owns this dashboard.
    dashboard_json str
    JSON payload describing the dashboard's panels, layouts, variables, and other content. Wrap with jsonencode({...}) in HCL. The provider sanitizes the JSON before diffing, so cosmetic differences (key ordering, whitespace) do not cause spurious plans.
    labels Mapping[str, str]
    Key/value labels attached to the dashboard for organization and filtering.
    name str
    Display name of the dashboard. Can be changed after creation.
    slug str
    Stable identifier for the dashboard. Generated from name if omitted. Immutable after creation.
    collectionId String
    ID of the collection that owns this dashboard.
    dashboardJson String
    JSON payload describing the dashboard's panels, layouts, variables, and other content. Wrap with jsonencode({...}) in HCL. The provider sanitizes the JSON before diffing, so cosmetic differences (key ordering, whitespace) do not cause spurious plans.
    labels Map<String>
    Key/value labels attached to the dashboard for organization and filtering.
    name String
    Display name of the dashboard. Can be changed after creation.
    slug String
    Stable identifier for the dashboard. Generated from name if omitted. Immutable after creation.

    Package Details

    Repository
    chronosphere chronosphereio/pulumi-chronosphere
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the chronosphere Terraform Provider.
    Viewing docs for Chronosphere v0.9.16
    published on Friday, Jun 5, 2026 by Chronosphere

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial