Dashboard

Rootly v3.4.0, May 12 26

Viewing docs for Rootly v3.4.0
published on Tuesday, May 12, 2026 by rootlyhq

Schema (JSON)

rootlyhq/pulumi-rootly

Viewing docs for Rootly v3.4.0
published on Tuesday, May 12, 2026 by rootlyhq

Schema (JSON)

rootlyhq/pulumi-rootly

Example Usage

resource "rootly_dashboard" "overview" {
  name = "my_dashboard"
}

resource "rootly_dashboard_panel" "incidents_by_severity" {
  dashboard_id = rootly_dashboard.foo.id
  name         = "test"
  params {
    display = "line_chart"
    datasets {
      collection = "incidents"
      filter {
        operation = "and"
        rules {
          operation = "and"
          condition = "="
          key       = "status"
          value     = "started"
        }
      }
      group_by = "severity"
      aggregate {
        cumulative = false
        key        = "results"
        operation  = "count"
      }
    }
  }
}

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: Optional[DashboardArgs] = None,
              opts: Optional[ResourceOptions] = None)

@overload
def Dashboard(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              name: Optional[str] = None,
              owner: Optional[str] = None,
              public: Optional[bool] = None)

func NewDashboard(ctx *Context, name string, args *DashboardArgs, opts ...ResourceOption) (*Dashboard, error)

public Dashboard(string name, DashboardArgs? args = null, CustomResourceOptions? opts = null)

public Dashboard(String name, DashboardArgs args)
public Dashboard(String name, DashboardArgs args, CustomResourceOptions options)

type: rootly:Dashboard
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

resource "rootly_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 Rootly.Dashboard("dashboardResource", new()
{
    Name = "string",
    Owner = "string",
    Public = false,
});

example, err := rootly.NewDashboard(ctx, "dashboardResource", &rootly.DashboardArgs{
	Name:   pulumi.String("string"),
	Owner:  pulumi.String("string"),
	Public: pulumi.Bool(false),
})

resource "rootly_dashboard" "dashboardResource" {
  name   = "string"
  owner  = "string"
  public = false
}

var dashboardResource = new Dashboard("dashboardResource", DashboardArgs.builder()
    .name("string")
    .owner("string")
    .public_(false)
    .build());

dashboard_resource = rootly.Dashboard("dashboardResource",
    name="string",
    owner="string",
    public=False)

const dashboardResource = new rootly.Dashboard("dashboardResource", {
    name: "string",
    owner: "string",
    "public": false,
});

type: rootly:Dashboard
properties:
    name: string
    owner: string
    public: false

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:

Name string: The name of the dashboard
Owner string: Whether the dashboard is owned by organization or user.
Public bool: Whether the dashboard is public

Name string: The name of the dashboard
Owner string: Whether the dashboard is owned by organization or user.
Public bool: Whether the dashboard is public

name string: The name of the dashboard
owner string: Whether the dashboard is owned by organization or user.
public bool: Whether the dashboard is public

name String: The name of the dashboard
owner String: Whether the dashboard is owned by organization or user.
public_ Boolean: Whether the dashboard is public

name string: The name of the dashboard
owner string: Whether the dashboard is owned by organization or user.
public boolean: Whether the dashboard is public

name str: The name of the dashboard
owner str: Whether the dashboard is owned by organization or user.
public bool: Whether the dashboard is public

name String: The name of the dashboard
owner String: Whether the dashboard is owned by organization or user.
public Boolean: Whether the dashboard is public

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.
Slug string: The slug of the dashboard
UserId int: The userId of the dashboard, for dashboards with owner == user

Id string: The provider-assigned unique ID for this managed resource.
Slug string: The slug of the dashboard
UserId int: The userId of the dashboard, for dashboards with owner == user

id string: The provider-assigned unique ID for this managed resource.
slug string: The slug of the dashboard
user_id number: The userId of the dashboard, for dashboards with owner == user

id String: The provider-assigned unique ID for this managed resource.
slug String: The slug of the dashboard
userId Integer: The userId of the dashboard, for dashboards with owner == user

id string: The provider-assigned unique ID for this managed resource.
slug string: The slug of the dashboard
userId number: The userId of the dashboard, for dashboards with owner == user

id str: The provider-assigned unique ID for this managed resource.
slug str: The slug of the dashboard
user_id int: The userId of the dashboard, for dashboards with owner == user

id String: The provider-assigned unique ID for this managed resource.
slug String: The slug of the dashboard
userId Number: The userId of the dashboard, for dashboards with owner == user

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,
        name: Optional[str] = None,
        owner: Optional[str] = None,
        public: Optional[bool] = None,
        slug: Optional[str] = None,
        user_id: Optional[int] = 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: rootly:Dashboard    get:      id: ${id}

import {
  to = rootly_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:

Name string: The name of the dashboard
Owner string: Whether the dashboard is owned by organization or user.
Public bool: Whether the dashboard is public
Slug string: The slug of the dashboard
UserId int: The userId of the dashboard, for dashboards with owner == user

Name string: The name of the dashboard
Owner string: Whether the dashboard is owned by organization or user.
Public bool: Whether the dashboard is public
Slug string: The slug of the dashboard
UserId int: The userId of the dashboard, for dashboards with owner == user

name string: The name of the dashboard
owner string: Whether the dashboard is owned by organization or user.
public bool: Whether the dashboard is public
slug string: The slug of the dashboard
user_id number: The userId of the dashboard, for dashboards with owner == user

name String: The name of the dashboard
owner String: Whether the dashboard is owned by organization or user.
public_ Boolean: Whether the dashboard is public
slug String: The slug of the dashboard
userId Integer: The userId of the dashboard, for dashboards with owner == user

name string: The name of the dashboard
owner string: Whether the dashboard is owned by organization or user.
public boolean: Whether the dashboard is public
slug string: The slug of the dashboard
userId number: The userId of the dashboard, for dashboards with owner == user

name str: The name of the dashboard
owner str: Whether the dashboard is owned by organization or user.
public bool: Whether the dashboard is public
slug str: The slug of the dashboard
user_id int: The userId of the dashboard, for dashboards with owner == user

name String: The name of the dashboard
owner String: Whether the dashboard is owned by organization or user.
public Boolean: Whether the dashboard is public
slug String: The slug of the dashboard
userId Number: The userId of the dashboard, for dashboards with owner == user

Import

rootly.Dashboard can be imported using the import command.

$ pulumi import rootly:index/dashboard:Dashboard primary a816421c-6ceb-481a-87c4-585e47451f24

Or using an import block.

Locate the resource id in the web app, or retrieve it by listing resources through the API if it’s not visible in the web app.

HCL can be generated from the import block using the -generate-config-out flag.

pulumi preview -generate-config-out=generated.tf

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

Package Details

Repository: rootly rootlyhq/pulumi-rootly
License: Apache-2.0
Notes: This Pulumi package is based on the rootly Terraform Provider.

Viewing docs for Rootly v3.4.0
published on Tuesday, May 12, 2026 by rootlyhq

Schema (JSON)

rootlyhq/pulumi-rootly

rootly.Dashboard

On this page

On this page

Example Usage

Create Dashboard Resource

Constructor syntax

Parameters

Constructor example

Dashboard Resource Properties

Inputs

Outputs

Look up Existing Dashboard Resource

Import

Package Details

On this page

On this page