Viewing docs for SignalFx v7.23.0
published on Friday, Mar 13, 2026 by Pulumi
published on Friday, Mar 13, 2026 by Pulumi
Viewing docs for SignalFx v7.23.0
published on Friday, Mar 13, 2026 by Pulumi
published on Friday, Mar 13, 2026 by Pulumi
A dashboard is a curated collection of specific charts and supports dimensional filters, dashboard variables and time range options. These options are applied to all charts in the dashboard, providing a consistent view of the data displayed in that dashboard. This also means that when you open a chart to drill down for more details, you are viewing the same data that is visible in the dashboard view.
Since every dashboard is included in a dashboard group, which is a collection of dashboards, you need to create that first and reference it as shown in the example.
NOTE When you want to change or remove write permissions for a user other than yourself regarding dashboards, use a session token of an administrator to authenticate the Splunk Observability Cloud provider. See Operations that require a session token for an administrator.
Example
import * as pulumi from "@pulumi/pulumi";
import * as signalfx from "@pulumi/signalfx";
const mydashboard0 = new signalfx.Dashboard("mydashboard0", {
name: "My Dashboard",
dashboardGroup: mydashboardgroup0.id,
timeRange: "-30m",
filters: [{
property: "collector",
values: [
"cpu",
"Diamond",
],
}],
variables: [{
property: "region",
alias: "region",
values: ["uswest-1-"],
}],
charts: [
{
chartId: mychart0.id,
width: 12,
height: 1,
},
{
chartId: mychart1.id,
width: 5,
height: 2,
},
],
});
import pulumi
import pulumi_signalfx as signalfx
mydashboard0 = signalfx.Dashboard("mydashboard0",
name="My Dashboard",
dashboard_group=mydashboardgroup0["id"],
time_range="-30m",
filters=[{
"property": "collector",
"values": [
"cpu",
"Diamond",
],
}],
variables=[{
"property": "region",
"alias": "region",
"values": ["uswest-1-"],
}],
charts=[
{
"chart_id": mychart0["id"],
"width": 12,
"height": 1,
},
{
"chart_id": mychart1["id"],
"width": 5,
"height": 2,
},
])
package main
import (
"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := signalfx.NewDashboard(ctx, "mydashboard0", &signalfx.DashboardArgs{
Name: pulumi.String("My Dashboard"),
DashboardGroup: pulumi.Any(mydashboardgroup0.Id),
TimeRange: pulumi.String("-30m"),
Filters: signalfx.DashboardFilterArray{
&signalfx.DashboardFilterArgs{
Property: pulumi.String("collector"),
Values: pulumi.StringArray{
pulumi.String("cpu"),
pulumi.String("Diamond"),
},
},
},
Variables: signalfx.DashboardVariableArray{
&signalfx.DashboardVariableArgs{
Property: pulumi.String("region"),
Alias: pulumi.String("region"),
Values: pulumi.StringArray{
pulumi.String("uswest-1-"),
},
},
},
Charts: signalfx.DashboardChartArray{
&signalfx.DashboardChartArgs{
ChartId: pulumi.Any(mychart0.Id),
Width: pulumi.Int(12),
Height: pulumi.Int(1),
},
&signalfx.DashboardChartArgs{
ChartId: pulumi.Any(mychart1.Id),
Width: pulumi.Int(5),
Height: pulumi.Int(2),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SignalFx = Pulumi.SignalFx;
return await Deployment.RunAsync(() =>
{
var mydashboard0 = new SignalFx.Dashboard("mydashboard0", new()
{
Name = "My Dashboard",
DashboardGroup = mydashboardgroup0.Id,
TimeRange = "-30m",
Filters = new[]
{
new SignalFx.Inputs.DashboardFilterArgs
{
Property = "collector",
Values = new[]
{
"cpu",
"Diamond",
},
},
},
Variables = new[]
{
new SignalFx.Inputs.DashboardVariableArgs
{
Property = "region",
Alias = "region",
Values = new[]
{
"uswest-1-",
},
},
},
Charts = new[]
{
new SignalFx.Inputs.DashboardChartArgs
{
ChartId = mychart0.Id,
Width = 12,
Height = 1,
},
new SignalFx.Inputs.DashboardChartArgs
{
ChartId = mychart1.Id,
Width = 5,
Height = 2,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.signalfx.Dashboard;
import com.pulumi.signalfx.DashboardArgs;
import com.pulumi.signalfx.inputs.DashboardFilterArgs;
import com.pulumi.signalfx.inputs.DashboardVariableArgs;
import com.pulumi.signalfx.inputs.DashboardChartArgs;
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 mydashboard0 = new Dashboard("mydashboard0", DashboardArgs.builder()
.name("My Dashboard")
.dashboardGroup(mydashboardgroup0.id())
.timeRange("-30m")
.filters(DashboardFilterArgs.builder()
.property("collector")
.values(
"cpu",
"Diamond")
.build())
.variables(DashboardVariableArgs.builder()
.property("region")
.alias("region")
.values("uswest-1-")
.build())
.charts(
DashboardChartArgs.builder()
.chartId(mychart0.id())
.width(12)
.height(1)
.build(),
DashboardChartArgs.builder()
.chartId(mychart1.id())
.width(5)
.height(2)
.build())
.build());
}
}
resources:
mydashboard0:
type: signalfx:Dashboard
properties:
name: My Dashboard
dashboardGroup: ${mydashboardgroup0.id}
timeRange: -30m
filters:
- property: collector
values:
- cpu
- Diamond
variables:
- property: region
alias: region
values:
- uswest-1-
charts:
- chartId: ${mychart0.id}
width: 12
height: 1
- chartId: ${mychart1.id}
width: 5
height: 2
Example with inheriting permissions
import * as pulumi from "@pulumi/pulumi";
import * as signalfx from "@pulumi/signalfx";
const mydashboardInheritingpermissions = new signalfx.Dashboard("mydashboard_inheritingpermissions", {
name: "My Dashboard",
dashboardGroup: mydashboardgroup0.id,
permissions: {
parent: mydashboardgroup0.id,
},
});
import pulumi
import pulumi_signalfx as signalfx
mydashboard_inheritingpermissions = signalfx.Dashboard("mydashboard_inheritingpermissions",
name="My Dashboard",
dashboard_group=mydashboardgroup0["id"],
permissions={
"parent": mydashboardgroup0["id"],
})
package main
import (
"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := signalfx.NewDashboard(ctx, "mydashboard_inheritingpermissions", &signalfx.DashboardArgs{
Name: pulumi.String("My Dashboard"),
DashboardGroup: pulumi.Any(mydashboardgroup0.Id),
Permissions: &signalfx.DashboardPermissionsArgs{
Parent: pulumi.Any(mydashboardgroup0.Id),
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SignalFx = Pulumi.SignalFx;
return await Deployment.RunAsync(() =>
{
var mydashboardInheritingpermissions = new SignalFx.Dashboard("mydashboard_inheritingpermissions", new()
{
Name = "My Dashboard",
DashboardGroup = mydashboardgroup0.Id,
Permissions = new SignalFx.Inputs.DashboardPermissionsArgs
{
Parent = mydashboardgroup0.Id,
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.signalfx.Dashboard;
import com.pulumi.signalfx.DashboardArgs;
import com.pulumi.signalfx.inputs.DashboardPermissionsArgs;
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 mydashboardInheritingpermissions = new Dashboard("mydashboardInheritingpermissions", DashboardArgs.builder()
.name("My Dashboard")
.dashboardGroup(mydashboardgroup0.id())
.permissions(DashboardPermissionsArgs.builder()
.parent(mydashboardgroup0.id())
.build())
.build());
}
}
resources:
mydashboardInheritingpermissions:
type: signalfx:Dashboard
name: mydashboard_inheritingpermissions
properties:
name: My Dashboard
dashboardGroup: ${mydashboardgroup0.id}
permissions:
parent: ${mydashboardgroup0.id}
Example with custom permissions
import * as pulumi from "@pulumi/pulumi";
import * as signalfx from "@pulumi/signalfx";
const mydashboardCustompermissions = new signalfx.Dashboard("mydashboard_custompermissions", {
name: "My Dashboard",
dashboardGroup: mydashboardgroup0.id,
permissions: {
acls: [
{
principalId: "abc123",
principalType: "ORG",
actions: ["READ"],
},
{
principalId: "abc456",
principalType: "USER",
actions: [
"READ",
"WRITE",
],
},
],
},
});
import pulumi
import pulumi_signalfx as signalfx
mydashboard_custompermissions = signalfx.Dashboard("mydashboard_custompermissions",
name="My Dashboard",
dashboard_group=mydashboardgroup0["id"],
permissions={
"acls": [
{
"principal_id": "abc123",
"principal_type": "ORG",
"actions": ["READ"],
},
{
"principal_id": "abc456",
"principal_type": "USER",
"actions": [
"READ",
"WRITE",
],
},
],
})
package main
import (
"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := signalfx.NewDashboard(ctx, "mydashboard_custompermissions", &signalfx.DashboardArgs{
Name: pulumi.String("My Dashboard"),
DashboardGroup: pulumi.Any(mydashboardgroup0.Id),
Permissions: &signalfx.DashboardPermissionsArgs{
Acls: signalfx.DashboardPermissionsAclArray{
&signalfx.DashboardPermissionsAclArgs{
PrincipalId: pulumi.String("abc123"),
PrincipalType: pulumi.String("ORG"),
Actions: pulumi.StringArray{
pulumi.String("READ"),
},
},
&signalfx.DashboardPermissionsAclArgs{
PrincipalId: pulumi.String("abc456"),
PrincipalType: pulumi.String("USER"),
Actions: pulumi.StringArray{
pulumi.String("READ"),
pulumi.String("WRITE"),
},
},
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SignalFx = Pulumi.SignalFx;
return await Deployment.RunAsync(() =>
{
var mydashboardCustompermissions = new SignalFx.Dashboard("mydashboard_custompermissions", new()
{
Name = "My Dashboard",
DashboardGroup = mydashboardgroup0.Id,
Permissions = new SignalFx.Inputs.DashboardPermissionsArgs
{
Acls = new[]
{
new SignalFx.Inputs.DashboardPermissionsAclArgs
{
PrincipalId = "abc123",
PrincipalType = "ORG",
Actions = new[]
{
"READ",
},
},
new SignalFx.Inputs.DashboardPermissionsAclArgs
{
PrincipalId = "abc456",
PrincipalType = "USER",
Actions = new[]
{
"READ",
"WRITE",
},
},
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.signalfx.Dashboard;
import com.pulumi.signalfx.DashboardArgs;
import com.pulumi.signalfx.inputs.DashboardPermissionsArgs;
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 mydashboardCustompermissions = new Dashboard("mydashboardCustompermissions", DashboardArgs.builder()
.name("My Dashboard")
.dashboardGroup(mydashboardgroup0.id())
.permissions(DashboardPermissionsArgs.builder()
.acls(
DashboardPermissionsAclArgs.builder()
.principalId("abc123")
.principalType("ORG")
.actions("READ")
.build(),
DashboardPermissionsAclArgs.builder()
.principalId("abc456")
.principalType("USER")
.actions(
"READ",
"WRITE")
.build())
.build())
.build());
}
}
resources:
mydashboardCustompermissions:
type: signalfx:Dashboard
name: mydashboard_custompermissions
properties:
name: My Dashboard
dashboardGroup: ${mydashboardgroup0.id}
permissions:
acls:
- principalId: abc123
principalType: ORG
actions:
- READ
- principalId: abc456
principalType: USER
actions:
- READ
- WRITE
Dashboard layout information
Every Splunk Observability Cloud dashboard is shown as a grid of 12 columns and potentially infinite number of rows. The dimension of the single column depends on the screen resolution.
When you define a dashboard resource, you need to specify which charts, by chart_id, you want to show in the dashboard, along with layout information determining where on the dashboard you want to show the charts. Assign to every chart a width in terms of number of columns to cover up, from 1 to 12, and a height in terms of number of rows, more or equal than 1.
You can also assign a position in the dashboard grid where you like the graph to stay. To do that, assign a row that represents the topmost row of the chart and a column that represents the leftmost column of the chart. If, by mistake, you wrote a configuration where there are not enough columns to accommodate your charts in a specific row, they are split in different rows. In case a row is specified with a value higher than 1, if all the rows above are not filled by other charts, the chart is placed in the first empty row.
The are several use cases where this layout makes things too verbose and hard to work with loops. For those cases, you can now use one of these layouts: grids or columns.
WARNING Grids and column layouts are not supported by the Splunk Observability Cloud API and are Terraform-side constructs. As such, the provider cannot import them and cannot properly reconcile API-side changes. In other words, if someone changes the charts in the UI they are not reconciled at the next apply. Also, you can only use one of
chart,column, orgridwhen laying out dashboards. You can, however, use multiple instances of each, for example multiplegrids, for fancier layouts.
Grid
The dashboard is split into equal-sized charts, defined by width and height. If a chart doesn’t fit in the same row because the total width is greater than the maximum allowed by the dashboard, this chart and the next ones are placed in the next rows.
import * as pulumi from "@pulumi/pulumi";
import * as signalfx from "@pulumi/signalfx";
import * as std from "@pulumi/std";
const gridExample = new signalfx.Dashboard("grid_example", {
name: "Grid",
dashboardGroup: example.id,
timeRange: "-15m",
grids: [{
chartIds: [std.index.concat({
input: [
rps.map(__item => __item.id),
p50ths.map(__item => __item.id),
p99ths.map(__item => __item.id),
idleWorkers.map(__item => __item.id),
cpuIdle.map(__item => __item.id),
],
}).result],
width: 3,
height: 1,
}],
});
import pulumi
import pulumi_signalfx as signalfx
import pulumi_std as std
grid_example = signalfx.Dashboard("grid_example",
name="Grid",
dashboard_group=example["id"],
time_range="-15m",
grids=[{
"chart_ids": [std.index.concat(input=[
[__item["id"] for __item in rps],
[__item["id"] for __item in p50ths],
[__item["id"] for __item in p99ths],
[__item["id"] for __item in idle_workers],
[__item["id"] for __item in cpu_idle],
])["result"]],
"width": 3,
"height": 1,
}])
package main
import (
"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx"
"github.com/pulumi/pulumi-std/sdk/go/std"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
invokeConcat, err := std.Concat(ctx, map[string]interface{}{
"input": [][]interface{}{
%!v(PANIC=Format method: fatal: A failure has occurred: unlowered splat expression @ example.pp:7,16-25),
%!v(PANIC=Format method: fatal: A failure has occurred: unlowered splat expression @ example.pp:7,27-39),
%!v(PANIC=Format method: fatal: A failure has occurred: unlowered splat expression @ example.pp:7,41-53),
%!v(PANIC=Format method: fatal: A failure has occurred: unlowered splat expression @ example.pp:7,55-72),
%!v(PANIC=Format method: fatal: A failure has occurred: unlowered splat expression @ example.pp:7,74-87),
},
}, nil)
if err != nil {
return err
}
_, err = signalfx.NewDashboard(ctx, "grid_example", &signalfx.DashboardArgs{
Name: pulumi.String("Grid"),
DashboardGroup: pulumi.Any(example.Id),
TimeRange: pulumi.String("-15m"),
Grids: signalfx.DashboardGridArray{
&signalfx.DashboardGridArgs{
ChartIds: pulumi.StringArray{
invokeConcat.Result,
},
Width: pulumi.Int(3),
Height: pulumi.Int(1),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SignalFx = Pulumi.SignalFx;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
var gridExample = new SignalFx.Dashboard("grid_example", new()
{
Name = "Grid",
DashboardGroup = example.Id,
TimeRange = "-15m",
Grids = new[]
{
new SignalFx.Inputs.DashboardGridArgs
{
ChartIds = new[]
{
Std.Index.Concat.Invoke(new()
{
Input = new[]
{
rps.Select(__item => __item.Id).ToList(),
p50ths.Select(__item => __item.Id).ToList(),
p99ths.Select(__item => __item.Id).ToList(),
idleWorkers.Select(__item => __item.Id).ToList(),
cpuIdle.Select(__item => __item.Id).ToList(),
},
}).Result,
},
Width = 3,
Height = 1,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.signalfx.Dashboard;
import com.pulumi.signalfx.DashboardArgs;
import com.pulumi.signalfx.inputs.DashboardGridArgs;
import com.pulumi.std.StdFunctions;
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 gridExample = new Dashboard("gridExample", DashboardArgs.builder()
.name("Grid")
.dashboardGroup(example.id())
.timeRange("-15m")
.grids(DashboardGridArgs.builder()
.chartIds(StdFunctions.concat(Map.of("input",
rps.stream().map(element -> element.id()).collect(toList()),
p50ths.stream().map(element -> element.id()).collect(toList()),
p99ths.stream().map(element -> element.id()).collect(toList()),
idleWorkers.stream().map(element -> element.id()).collect(toList()),
cpuIdle.stream().map(element -> element.id()).collect(toList()))).result())
.width(3)
.height(1)
.build())
.build());
}
}
Example coming soon!
Column
The dashboard is split into equal-sized charts, defined by width and height. The charts are placed in the grid by column. The column number is called column.
import * as pulumi from "@pulumi/pulumi";
import * as signalfx from "@pulumi/signalfx";
const load = new signalfx.Dashboard("load", {
name: "Load",
dashboardGroup: example.id,
columns: [
{
chartIds: [rps.map(__item => __item.id)],
width: 2,
},
{
chartIds: [cpuCapacity.map(__item => __item.id)],
column: 2,
width: 4,
},
],
});
import pulumi
import pulumi_signalfx as signalfx
load = signalfx.Dashboard("load",
name="Load",
dashboard_group=example["id"],
columns=[
{
"chart_ids": [[__item["id"] for __item in rps]],
"width": 2,
},
{
"chart_ids": [[__item["id"] for __item in cpu_capacity]],
"column": 2,
"width": 4,
},
])
package main
import (
"github.com/pulumi/pulumi-signalfx/sdk/v7/go/signalfx"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := signalfx.NewDashboard(ctx, "load", &signalfx.DashboardArgs{
Name: pulumi.String("Load"),
DashboardGroup: pulumi.Any(example.Id),
Columns: signalfx.DashboardColumnArray{
&signalfx.DashboardColumnArgs{
ChartIds: pulumi.StringArray{
pulumi.String(%!v(PANIC=Format method: fatal: A failure has occurred: unlowered splat expression @ example.pp:4,17-26)),
},
Width: pulumi.Int(2),
},
&signalfx.DashboardColumnArgs{
ChartIds: pulumi.StringArray{
pulumi.String(%!v(PANIC=Format method: fatal: A failure has occurred: unlowered splat expression @ example.pp:7,17-34)),
},
Column: pulumi.Int(2),
Width: pulumi.Int(4),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using SignalFx = Pulumi.SignalFx;
return await Deployment.RunAsync(() =>
{
var load = new SignalFx.Dashboard("load", new()
{
Name = "Load",
DashboardGroup = example.Id,
Columns = new[]
{
new SignalFx.Inputs.DashboardColumnArgs
{
ChartIds = new[]
{
rps.Select(__item => __item.Id).ToList(),
},
Width = 2,
},
new SignalFx.Inputs.DashboardColumnArgs
{
ChartIds = new[]
{
cpuCapacity.Select(__item => __item.Id).ToList(),
},
Column = 2,
Width = 4,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.signalfx.Dashboard;
import com.pulumi.signalfx.DashboardArgs;
import com.pulumi.signalfx.inputs.DashboardColumnArgs;
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 load = new Dashboard("load", DashboardArgs.builder()
.name("Load")
.dashboardGroup(example.id())
.columns(
DashboardColumnArgs.builder()
.chartIds(rps.stream().map(element -> element.id()).collect(toList()))
.width(2)
.build(),
DashboardColumnArgs.builder()
.chartIds(cpuCapacity.stream().map(element -> element.id()).collect(toList()))
.column(2)
.width(4)
.build())
.build());
}
}
Example coming soon!
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_group: Optional[str] = None,
event_overlays: Optional[Sequence[DashboardEventOverlayArgs]] = None,
filters: Optional[Sequence[DashboardFilterArgs]] = None,
charts_resolution: Optional[str] = None,
authorized_writer_teams: Optional[Sequence[str]] = None,
authorized_writer_users: Optional[Sequence[str]] = None,
description: Optional[str] = None,
discovery_options_query: Optional[str] = None,
discovery_options_selectors: Optional[Sequence[str]] = None,
charts: Optional[Sequence[DashboardChartArgs]] = None,
end_time: Optional[int] = None,
columns: Optional[Sequence[DashboardColumnArgs]] = None,
grids: Optional[Sequence[DashboardGridArgs]] = None,
name: Optional[str] = None,
permissions: Optional[DashboardPermissionsArgs] = None,
selected_event_overlays: Optional[Sequence[DashboardSelectedEventOverlayArgs]] = None,
start_time: Optional[int] = None,
tags: Optional[Sequence[str]] = None,
time_range: Optional[str] = None,
variables: Optional[Sequence[DashboardVariableArgs]] = 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: signalfx:Dashboard
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 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 SignalFx.Dashboard("dashboardResource", new()
{
DashboardGroup = "string",
EventOverlays = new[]
{
new SignalFx.Inputs.DashboardEventOverlayArgs
{
Signal = "string",
Color = "string",
Label = "string",
Line = false,
Sources = new[]
{
new SignalFx.Inputs.DashboardEventOverlaySourceArgs
{
Property = "string",
Values = new[]
{
"string",
},
Negated = false,
},
},
Type = "string",
},
},
Filters = new[]
{
new SignalFx.Inputs.DashboardFilterArgs
{
Property = "string",
Values = new[]
{
"string",
},
ApplyIfExist = false,
Negated = false,
},
},
ChartsResolution = "string",
Description = "string",
DiscoveryOptionsQuery = "string",
DiscoveryOptionsSelectors = new[]
{
"string",
},
Charts = new[]
{
new SignalFx.Inputs.DashboardChartArgs
{
ChartId = "string",
Column = 0,
Height = 0,
Row = 0,
Width = 0,
},
},
EndTime = 0,
Columns = new[]
{
new SignalFx.Inputs.DashboardColumnArgs
{
ChartIds = new[]
{
"string",
},
Column = 0,
Height = 0,
Width = 0,
},
},
Grids = new[]
{
new SignalFx.Inputs.DashboardGridArgs
{
ChartIds = new[]
{
"string",
},
Height = 0,
Width = 0,
},
},
Name = "string",
Permissions = new SignalFx.Inputs.DashboardPermissionsArgs
{
Acls = new[]
{
new SignalFx.Inputs.DashboardPermissionsAclArgs
{
PrincipalId = "string",
PrincipalType = "string",
Actions = new[]
{
"string",
},
},
},
Parent = "string",
},
SelectedEventOverlays = new[]
{
new SignalFx.Inputs.DashboardSelectedEventOverlayArgs
{
Signal = "string",
Sources = new[]
{
new SignalFx.Inputs.DashboardSelectedEventOverlaySourceArgs
{
Property = "string",
Values = new[]
{
"string",
},
Negated = false,
},
},
Type = "string",
},
},
StartTime = 0,
Tags = new[]
{
"string",
},
TimeRange = "string",
Variables = new[]
{
new SignalFx.Inputs.DashboardVariableArgs
{
Alias = "string",
Property = "string",
ApplyIfExist = false,
Description = "string",
ReplaceOnly = false,
RestrictedSuggestions = false,
ValueRequired = false,
Values = new[]
{
"string",
},
ValuesSuggesteds = new[]
{
"string",
},
},
},
});
example, err := signalfx.NewDashboard(ctx, "dashboardResource", &signalfx.DashboardArgs{
DashboardGroup: pulumi.String("string"),
EventOverlays: signalfx.DashboardEventOverlayArray{
&signalfx.DashboardEventOverlayArgs{
Signal: pulumi.String("string"),
Color: pulumi.String("string"),
Label: pulumi.String("string"),
Line: pulumi.Bool(false),
Sources: signalfx.DashboardEventOverlaySourceArray{
&signalfx.DashboardEventOverlaySourceArgs{
Property: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
Negated: pulumi.Bool(false),
},
},
Type: pulumi.String("string"),
},
},
Filters: signalfx.DashboardFilterArray{
&signalfx.DashboardFilterArgs{
Property: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
ApplyIfExist: pulumi.Bool(false),
Negated: pulumi.Bool(false),
},
},
ChartsResolution: pulumi.String("string"),
Description: pulumi.String("string"),
DiscoveryOptionsQuery: pulumi.String("string"),
DiscoveryOptionsSelectors: pulumi.StringArray{
pulumi.String("string"),
},
Charts: signalfx.DashboardChartArray{
&signalfx.DashboardChartArgs{
ChartId: pulumi.String("string"),
Column: pulumi.Int(0),
Height: pulumi.Int(0),
Row: pulumi.Int(0),
Width: pulumi.Int(0),
},
},
EndTime: pulumi.Int(0),
Columns: signalfx.DashboardColumnArray{
&signalfx.DashboardColumnArgs{
ChartIds: pulumi.StringArray{
pulumi.String("string"),
},
Column: pulumi.Int(0),
Height: pulumi.Int(0),
Width: pulumi.Int(0),
},
},
Grids: signalfx.DashboardGridArray{
&signalfx.DashboardGridArgs{
ChartIds: pulumi.StringArray{
pulumi.String("string"),
},
Height: pulumi.Int(0),
Width: pulumi.Int(0),
},
},
Name: pulumi.String("string"),
Permissions: &signalfx.DashboardPermissionsArgs{
Acls: signalfx.DashboardPermissionsAclArray{
&signalfx.DashboardPermissionsAclArgs{
PrincipalId: pulumi.String("string"),
PrincipalType: pulumi.String("string"),
Actions: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Parent: pulumi.String("string"),
},
SelectedEventOverlays: signalfx.DashboardSelectedEventOverlayArray{
&signalfx.DashboardSelectedEventOverlayArgs{
Signal: pulumi.String("string"),
Sources: signalfx.DashboardSelectedEventOverlaySourceArray{
&signalfx.DashboardSelectedEventOverlaySourceArgs{
Property: pulumi.String("string"),
Values: pulumi.StringArray{
pulumi.String("string"),
},
Negated: pulumi.Bool(false),
},
},
Type: pulumi.String("string"),
},
},
StartTime: pulumi.Int(0),
Tags: pulumi.StringArray{
pulumi.String("string"),
},
TimeRange: pulumi.String("string"),
Variables: signalfx.DashboardVariableArray{
&signalfx.DashboardVariableArgs{
Alias: pulumi.String("string"),
Property: pulumi.String("string"),
ApplyIfExist: pulumi.Bool(false),
Description: pulumi.String("string"),
ReplaceOnly: pulumi.Bool(false),
RestrictedSuggestions: pulumi.Bool(false),
ValueRequired: pulumi.Bool(false),
Values: pulumi.StringArray{
pulumi.String("string"),
},
ValuesSuggesteds: pulumi.StringArray{
pulumi.String("string"),
},
},
},
})
var dashboardResource = new Dashboard("dashboardResource", DashboardArgs.builder()
.dashboardGroup("string")
.eventOverlays(DashboardEventOverlayArgs.builder()
.signal("string")
.color("string")
.label("string")
.line(false)
.sources(DashboardEventOverlaySourceArgs.builder()
.property("string")
.values("string")
.negated(false)
.build())
.type("string")
.build())
.filters(DashboardFilterArgs.builder()
.property("string")
.values("string")
.applyIfExist(false)
.negated(false)
.build())
.chartsResolution("string")
.description("string")
.discoveryOptionsQuery("string")
.discoveryOptionsSelectors("string")
.charts(DashboardChartArgs.builder()
.chartId("string")
.column(0)
.height(0)
.row(0)
.width(0)
.build())
.endTime(0)
.columns(DashboardColumnArgs.builder()
.chartIds("string")
.column(0)
.height(0)
.width(0)
.build())
.grids(DashboardGridArgs.builder()
.chartIds("string")
.height(0)
.width(0)
.build())
.name("string")
.permissions(DashboardPermissionsArgs.builder()
.acls(DashboardPermissionsAclArgs.builder()
.principalId("string")
.principalType("string")
.actions("string")
.build())
.parent("string")
.build())
.selectedEventOverlays(DashboardSelectedEventOverlayArgs.builder()
.signal("string")
.sources(DashboardSelectedEventOverlaySourceArgs.builder()
.property("string")
.values("string")
.negated(false)
.build())
.type("string")
.build())
.startTime(0)
.tags("string")
.timeRange("string")
.variables(DashboardVariableArgs.builder()
.alias("string")
.property("string")
.applyIfExist(false)
.description("string")
.replaceOnly(false)
.restrictedSuggestions(false)
.valueRequired(false)
.values("string")
.valuesSuggesteds("string")
.build())
.build());
dashboard_resource = signalfx.Dashboard("dashboardResource",
dashboard_group="string",
event_overlays=[{
"signal": "string",
"color": "string",
"label": "string",
"line": False,
"sources": [{
"property": "string",
"values": ["string"],
"negated": False,
}],
"type": "string",
}],
filters=[{
"property": "string",
"values": ["string"],
"apply_if_exist": False,
"negated": False,
}],
charts_resolution="string",
description="string",
discovery_options_query="string",
discovery_options_selectors=["string"],
charts=[{
"chart_id": "string",
"column": 0,
"height": 0,
"row": 0,
"width": 0,
}],
end_time=0,
columns=[{
"chart_ids": ["string"],
"column": 0,
"height": 0,
"width": 0,
}],
grids=[{
"chart_ids": ["string"],
"height": 0,
"width": 0,
}],
name="string",
permissions={
"acls": [{
"principal_id": "string",
"principal_type": "string",
"actions": ["string"],
}],
"parent": "string",
},
selected_event_overlays=[{
"signal": "string",
"sources": [{
"property": "string",
"values": ["string"],
"negated": False,
}],
"type": "string",
}],
start_time=0,
tags=["string"],
time_range="string",
variables=[{
"alias": "string",
"property": "string",
"apply_if_exist": False,
"description": "string",
"replace_only": False,
"restricted_suggestions": False,
"value_required": False,
"values": ["string"],
"values_suggesteds": ["string"],
}])
const dashboardResource = new signalfx.Dashboard("dashboardResource", {
dashboardGroup: "string",
eventOverlays: [{
signal: "string",
color: "string",
label: "string",
line: false,
sources: [{
property: "string",
values: ["string"],
negated: false,
}],
type: "string",
}],
filters: [{
property: "string",
values: ["string"],
applyIfExist: false,
negated: false,
}],
chartsResolution: "string",
description: "string",
discoveryOptionsQuery: "string",
discoveryOptionsSelectors: ["string"],
charts: [{
chartId: "string",
column: 0,
height: 0,
row: 0,
width: 0,
}],
endTime: 0,
columns: [{
chartIds: ["string"],
column: 0,
height: 0,
width: 0,
}],
grids: [{
chartIds: ["string"],
height: 0,
width: 0,
}],
name: "string",
permissions: {
acls: [{
principalId: "string",
principalType: "string",
actions: ["string"],
}],
parent: "string",
},
selectedEventOverlays: [{
signal: "string",
sources: [{
property: "string",
values: ["string"],
negated: false,
}],
type: "string",
}],
startTime: 0,
tags: ["string"],
timeRange: "string",
variables: [{
alias: "string",
property: "string",
applyIfExist: false,
description: "string",
replaceOnly: false,
restrictedSuggestions: false,
valueRequired: false,
values: ["string"],
valuesSuggesteds: ["string"],
}],
});
type: signalfx:Dashboard
properties:
charts:
- chartId: string
column: 0
height: 0
row: 0
width: 0
chartsResolution: string
columns:
- chartIds:
- string
column: 0
height: 0
width: 0
dashboardGroup: string
description: string
discoveryOptionsQuery: string
discoveryOptionsSelectors:
- string
endTime: 0
eventOverlays:
- color: string
label: string
line: false
signal: string
sources:
- negated: false
property: string
values:
- string
type: string
filters:
- applyIfExist: false
negated: false
property: string
values:
- string
grids:
- chartIds:
- string
height: 0
width: 0
name: string
permissions:
acls:
- actions:
- string
principalId: string
principalType: string
parent: string
selectedEventOverlays:
- signal: string
sources:
- negated: false
property: string
values:
- string
type: string
startTime: 0
tags:
- string
timeRange: string
variables:
- alias: string
applyIfExist: false
description: string
property: string
replaceOnly: false
restrictedSuggestions: false
valueRequired: false
values:
- string
valuesSuggesteds:
- 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:
- Dashboard
Group string - The ID of the dashboard group that contains the dashboard.
- List<string>
- Team IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's team (or user id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - List<string>
- User IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - Charts
List<Pulumi.
Signal Fx. Inputs. Dashboard Chart> - Chart ID and layout information for the charts in the dashboard.
- Charts
Resolution string - Specifies the chart data display resolution for charts in this dashboard. Value can be one of
"default","low","high", or"highest". - Columns
List<Pulumi.
Signal Fx. Inputs. Dashboard Column> - Column layout. Charts listed will be placed in a single column with the same width and height.
- Description string
- Description of the dashboard.
- Discovery
Options stringQuery - Discovery
Options List<string>Selectors - End
Time int - Seconds since epoch. Used for visualization.
- Event
Overlays List<Pulumi.Signal Fx. Inputs. Dashboard Event Overlay> - Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the
selected_event_overlayproperty instead. - Filters
List<Pulumi.
Signal Fx. Inputs. Dashboard Filter> - Filter to apply to the charts when displaying the dashboard.
- Grids
List<Pulumi.
Signal Fx. Inputs. Dashboard Grid> - Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.
- Name string
- Name of the dashboard.
- Permissions
Pulumi.
Signal Fx. Inputs. Dashboard Permissions - Permissions Controls who can view and/or edit your dashboard. Note: This feature is not present in all accounts. Please contact support if you are unsure.
- Selected
Event List<Pulumi.Overlays Signal Fx. Inputs. Dashboard Selected Event Overlay> - Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in
event_overlay, which are similar to the properties here. - Start
Time int - Seconds since epoch. Used for visualization.
- List<string>
- Tags of the dashboard.
- Time
Range string - The time range prior to now to visualize. Splunk Observability Cloud time syntax (e.g.
"-5m","-1h"). - Variables
List<Pulumi.
Signal Fx. Inputs. Dashboard Variable> - Dashboard variable to apply to each chart in the dashboard.
- Dashboard
Group string - The ID of the dashboard group that contains the dashboard.
- []string
- Team IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's team (or user id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - []string
- User IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - Charts
[]Dashboard
Chart Args - Chart ID and layout information for the charts in the dashboard.
- Charts
Resolution string - Specifies the chart data display resolution for charts in this dashboard. Value can be one of
"default","low","high", or"highest". - Columns
[]Dashboard
Column Args - Column layout. Charts listed will be placed in a single column with the same width and height.
- Description string
- Description of the dashboard.
- Discovery
Options stringQuery - Discovery
Options []stringSelectors - End
Time int - Seconds since epoch. Used for visualization.
- Event
Overlays []DashboardEvent Overlay Args - Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the
selected_event_overlayproperty instead. - Filters
[]Dashboard
Filter Args - Filter to apply to the charts when displaying the dashboard.
- Grids
[]Dashboard
Grid Args - Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.
- Name string
- Name of the dashboard.
- Permissions
Dashboard
Permissions Args - Permissions Controls who can view and/or edit your dashboard. Note: This feature is not present in all accounts. Please contact support if you are unsure.
- Selected
Event []DashboardOverlays Selected Event Overlay Args - Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in
event_overlay, which are similar to the properties here. - Start
Time int - Seconds since epoch. Used for visualization.
- []string
- Tags of the dashboard.
- Time
Range string - The time range prior to now to visualize. Splunk Observability Cloud time syntax (e.g.
"-5m","-1h"). - Variables
[]Dashboard
Variable Args - Dashboard variable to apply to each chart in the dashboard.
- dashboard
Group String - The ID of the dashboard group that contains the dashboard.
- List<String>
- Team IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's team (or user id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - List<String>
- User IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - charts
List<Dashboard
Chart> - Chart ID and layout information for the charts in the dashboard.
- charts
Resolution String - Specifies the chart data display resolution for charts in this dashboard. Value can be one of
"default","low","high", or"highest". - columns
List<Dashboard
Column> - Column layout. Charts listed will be placed in a single column with the same width and height.
- description String
- Description of the dashboard.
- discovery
Options StringQuery - discovery
Options List<String>Selectors - end
Time Integer - Seconds since epoch. Used for visualization.
- event
Overlays List<DashboardEvent Overlay> - Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the
selected_event_overlayproperty instead. - filters
List<Dashboard
Filter> - Filter to apply to the charts when displaying the dashboard.
- grids
List<Dashboard
Grid> - Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.
- name String
- Name of the dashboard.
- permissions
Dashboard
Permissions - Permissions Controls who can view and/or edit your dashboard. Note: This feature is not present in all accounts. Please contact support if you are unsure.
- selected
Event List<DashboardOverlays Selected Event Overlay> - Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in
event_overlay, which are similar to the properties here. - start
Time Integer - Seconds since epoch. Used for visualization.
- List<String>
- Tags of the dashboard.
- time
Range String - The time range prior to now to visualize. Splunk Observability Cloud time syntax (e.g.
"-5m","-1h"). - variables
List<Dashboard
Variable> - Dashboard variable to apply to each chart in the dashboard.
- dashboard
Group string - The ID of the dashboard group that contains the dashboard.
- string[]
- Team IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's team (or user id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - string[]
- User IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - charts
Dashboard
Chart[] - Chart ID and layout information for the charts in the dashboard.
- charts
Resolution string - Specifies the chart data display resolution for charts in this dashboard. Value can be one of
"default","low","high", or"highest". - columns
Dashboard
Column[] - Column layout. Charts listed will be placed in a single column with the same width and height.
- description string
- Description of the dashboard.
- discovery
Options stringQuery - discovery
Options string[]Selectors - end
Time number - Seconds since epoch. Used for visualization.
- event
Overlays DashboardEvent Overlay[] - Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the
selected_event_overlayproperty instead. - filters
Dashboard
Filter[] - Filter to apply to the charts when displaying the dashboard.
- grids
Dashboard
Grid[] - Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.
- name string
- Name of the dashboard.
- permissions
Dashboard
Permissions - Permissions Controls who can view and/or edit your dashboard. Note: This feature is not present in all accounts. Please contact support if you are unsure.
- selected
Event DashboardOverlays Selected Event Overlay[] - Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in
event_overlay, which are similar to the properties here. - start
Time number - Seconds since epoch. Used for visualization.
- string[]
- Tags of the dashboard.
- time
Range string - The time range prior to now to visualize. Splunk Observability Cloud time syntax (e.g.
"-5m","-1h"). - variables
Dashboard
Variable[] - Dashboard variable to apply to each chart in the dashboard.
- dashboard_
group str - The ID of the dashboard group that contains the dashboard.
- Sequence[str]
- Team IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's team (or user id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - Sequence[str]
- User IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - charts
Sequence[Dashboard
Chart Args] - Chart ID and layout information for the charts in the dashboard.
- charts_
resolution str - Specifies the chart data display resolution for charts in this dashboard. Value can be one of
"default","low","high", or"highest". - columns
Sequence[Dashboard
Column Args] - Column layout. Charts listed will be placed in a single column with the same width and height.
- description str
- Description of the dashboard.
- discovery_
options_ strquery - discovery_
options_ Sequence[str]selectors - end_
time int - Seconds since epoch. Used for visualization.
- event_
overlays Sequence[DashboardEvent Overlay Args] - Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the
selected_event_overlayproperty instead. - filters
Sequence[Dashboard
Filter Args] - Filter to apply to the charts when displaying the dashboard.
- grids
Sequence[Dashboard
Grid Args] - Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.
- name str
- Name of the dashboard.
- permissions
Dashboard
Permissions Args - Permissions Controls who can view and/or edit your dashboard. Note: This feature is not present in all accounts. Please contact support if you are unsure.
- selected_
event_ Sequence[Dashboardoverlays Selected Event Overlay Args] - Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in
event_overlay, which are similar to the properties here. - start_
time int - Seconds since epoch. Used for visualization.
- Sequence[str]
- Tags of the dashboard.
- time_
range str - The time range prior to now to visualize. Splunk Observability Cloud time syntax (e.g.
"-5m","-1h"). - variables
Sequence[Dashboard
Variable Args] - Dashboard variable to apply to each chart in the dashboard.
- dashboard
Group String - The ID of the dashboard group that contains the dashboard.
- List<String>
- Team IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's team (or user id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - List<String>
- User IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - charts List<Property Map>
- Chart ID and layout information for the charts in the dashboard.
- charts
Resolution String - Specifies the chart data display resolution for charts in this dashboard. Value can be one of
"default","low","high", or"highest". - columns List<Property Map>
- Column layout. Charts listed will be placed in a single column with the same width and height.
- description String
- Description of the dashboard.
- discovery
Options StringQuery - discovery
Options List<String>Selectors - end
Time Number - Seconds since epoch. Used for visualization.
- event
Overlays List<Property Map> - Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the
selected_event_overlayproperty instead. - filters List<Property Map>
- Filter to apply to the charts when displaying the dashboard.
- grids List<Property Map>
- Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.
- name String
- Name of the dashboard.
- permissions Property Map
- Permissions Controls who can view and/or edit your dashboard. Note: This feature is not present in all accounts. Please contact support if you are unsure.
- selected
Event List<Property Map>Overlays - Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in
event_overlay, which are similar to the properties here. - start
Time Number - Seconds since epoch. Used for visualization.
- List<String>
- Tags of the dashboard.
- time
Range String - The time range prior to now to visualize. Splunk Observability Cloud time syntax (e.g.
"-5m","-1h"). - variables List<Property Map>
- Dashboard variable to apply to each chart in the dashboard.
Outputs
All input properties are implicitly available as output properties. Additionally, the Dashboard resource produces the following output properties:
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,
authorized_writer_teams: Optional[Sequence[str]] = None,
authorized_writer_users: Optional[Sequence[str]] = None,
charts: Optional[Sequence[DashboardChartArgs]] = None,
charts_resolution: Optional[str] = None,
columns: Optional[Sequence[DashboardColumnArgs]] = None,
dashboard_group: Optional[str] = None,
description: Optional[str] = None,
discovery_options_query: Optional[str] = None,
discovery_options_selectors: Optional[Sequence[str]] = None,
end_time: Optional[int] = None,
event_overlays: Optional[Sequence[DashboardEventOverlayArgs]] = None,
filters: Optional[Sequence[DashboardFilterArgs]] = None,
grids: Optional[Sequence[DashboardGridArgs]] = None,
name: Optional[str] = None,
permissions: Optional[DashboardPermissionsArgs] = None,
selected_event_overlays: Optional[Sequence[DashboardSelectedEventOverlayArgs]] = None,
start_time: Optional[int] = None,
tags: Optional[Sequence[str]] = None,
time_range: Optional[str] = None,
url: Optional[str] = None,
variables: Optional[Sequence[DashboardVariableArgs]] = None) -> Dashboardfunc 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: signalfx:Dashboard 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.
- List<string>
- Team IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's team (or user id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - List<string>
- User IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - Charts
List<Pulumi.
Signal Fx. Inputs. Dashboard Chart> - Chart ID and layout information for the charts in the dashboard.
- Charts
Resolution string - Specifies the chart data display resolution for charts in this dashboard. Value can be one of
"default","low","high", or"highest". - Columns
List<Pulumi.
Signal Fx. Inputs. Dashboard Column> - Column layout. Charts listed will be placed in a single column with the same width and height.
- Dashboard
Group string - The ID of the dashboard group that contains the dashboard.
- Description string
- Description of the dashboard.
- Discovery
Options stringQuery - Discovery
Options List<string>Selectors - End
Time int - Seconds since epoch. Used for visualization.
- Event
Overlays List<Pulumi.Signal Fx. Inputs. Dashboard Event Overlay> - Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the
selected_event_overlayproperty instead. - Filters
List<Pulumi.
Signal Fx. Inputs. Dashboard Filter> - Filter to apply to the charts when displaying the dashboard.
- Grids
List<Pulumi.
Signal Fx. Inputs. Dashboard Grid> - Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.
- Name string
- Name of the dashboard.
- Permissions
Pulumi.
Signal Fx. Inputs. Dashboard Permissions - Permissions Controls who can view and/or edit your dashboard. Note: This feature is not present in all accounts. Please contact support if you are unsure.
- Selected
Event List<Pulumi.Overlays Signal Fx. Inputs. Dashboard Selected Event Overlay> - Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in
event_overlay, which are similar to the properties here. - Start
Time int - Seconds since epoch. Used for visualization.
- List<string>
- Tags of the dashboard.
- Time
Range string - The time range prior to now to visualize. Splunk Observability Cloud time syntax (e.g.
"-5m","-1h"). - Url string
- The URL of the dashboard.
- Variables
List<Pulumi.
Signal Fx. Inputs. Dashboard Variable> - Dashboard variable to apply to each chart in the dashboard.
- []string
- Team IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's team (or user id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - []string
- User IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - Charts
[]Dashboard
Chart Args - Chart ID and layout information for the charts in the dashboard.
- Charts
Resolution string - Specifies the chart data display resolution for charts in this dashboard. Value can be one of
"default","low","high", or"highest". - Columns
[]Dashboard
Column Args - Column layout. Charts listed will be placed in a single column with the same width and height.
- Dashboard
Group string - The ID of the dashboard group that contains the dashboard.
- Description string
- Description of the dashboard.
- Discovery
Options stringQuery - Discovery
Options []stringSelectors - End
Time int - Seconds since epoch. Used for visualization.
- Event
Overlays []DashboardEvent Overlay Args - Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the
selected_event_overlayproperty instead. - Filters
[]Dashboard
Filter Args - Filter to apply to the charts when displaying the dashboard.
- Grids
[]Dashboard
Grid Args - Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.
- Name string
- Name of the dashboard.
- Permissions
Dashboard
Permissions Args - Permissions Controls who can view and/or edit your dashboard. Note: This feature is not present in all accounts. Please contact support if you are unsure.
- Selected
Event []DashboardOverlays Selected Event Overlay Args - Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in
event_overlay, which are similar to the properties here. - Start
Time int - Seconds since epoch. Used for visualization.
- []string
- Tags of the dashboard.
- Time
Range string - The time range prior to now to visualize. Splunk Observability Cloud time syntax (e.g.
"-5m","-1h"). - Url string
- The URL of the dashboard.
- Variables
[]Dashboard
Variable Args - Dashboard variable to apply to each chart in the dashboard.
- List<String>
- Team IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's team (or user id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - List<String>
- User IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - charts
List<Dashboard
Chart> - Chart ID and layout information for the charts in the dashboard.
- charts
Resolution String - Specifies the chart data display resolution for charts in this dashboard. Value can be one of
"default","low","high", or"highest". - columns
List<Dashboard
Column> - Column layout. Charts listed will be placed in a single column with the same width and height.
- dashboard
Group String - The ID of the dashboard group that contains the dashboard.
- description String
- Description of the dashboard.
- discovery
Options StringQuery - discovery
Options List<String>Selectors - end
Time Integer - Seconds since epoch. Used for visualization.
- event
Overlays List<DashboardEvent Overlay> - Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the
selected_event_overlayproperty instead. - filters
List<Dashboard
Filter> - Filter to apply to the charts when displaying the dashboard.
- grids
List<Dashboard
Grid> - Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.
- name String
- Name of the dashboard.
- permissions
Dashboard
Permissions - Permissions Controls who can view and/or edit your dashboard. Note: This feature is not present in all accounts. Please contact support if you are unsure.
- selected
Event List<DashboardOverlays Selected Event Overlay> - Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in
event_overlay, which are similar to the properties here. - start
Time Integer - Seconds since epoch. Used for visualization.
- List<String>
- Tags of the dashboard.
- time
Range String - The time range prior to now to visualize. Splunk Observability Cloud time syntax (e.g.
"-5m","-1h"). - url String
- The URL of the dashboard.
- variables
List<Dashboard
Variable> - Dashboard variable to apply to each chart in the dashboard.
- string[]
- Team IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's team (or user id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - string[]
- User IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - charts
Dashboard
Chart[] - Chart ID and layout information for the charts in the dashboard.
- charts
Resolution string - Specifies the chart data display resolution for charts in this dashboard. Value can be one of
"default","low","high", or"highest". - columns
Dashboard
Column[] - Column layout. Charts listed will be placed in a single column with the same width and height.
- dashboard
Group string - The ID of the dashboard group that contains the dashboard.
- description string
- Description of the dashboard.
- discovery
Options stringQuery - discovery
Options string[]Selectors - end
Time number - Seconds since epoch. Used for visualization.
- event
Overlays DashboardEvent Overlay[] - Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the
selected_event_overlayproperty instead. - filters
Dashboard
Filter[] - Filter to apply to the charts when displaying the dashboard.
- grids
Dashboard
Grid[] - Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.
- name string
- Name of the dashboard.
- permissions
Dashboard
Permissions - Permissions Controls who can view and/or edit your dashboard. Note: This feature is not present in all accounts. Please contact support if you are unsure.
- selected
Event DashboardOverlays Selected Event Overlay[] - Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in
event_overlay, which are similar to the properties here. - start
Time number - Seconds since epoch. Used for visualization.
- string[]
- Tags of the dashboard.
- time
Range string - The time range prior to now to visualize. Splunk Observability Cloud time syntax (e.g.
"-5m","-1h"). - url string
- The URL of the dashboard.
- variables
Dashboard
Variable[] - Dashboard variable to apply to each chart in the dashboard.
- Sequence[str]
- Team IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's team (or user id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - Sequence[str]
- User IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - charts
Sequence[Dashboard
Chart Args] - Chart ID and layout information for the charts in the dashboard.
- charts_
resolution str - Specifies the chart data display resolution for charts in this dashboard. Value can be one of
"default","low","high", or"highest". - columns
Sequence[Dashboard
Column Args] - Column layout. Charts listed will be placed in a single column with the same width and height.
- dashboard_
group str - The ID of the dashboard group that contains the dashboard.
- description str
- Description of the dashboard.
- discovery_
options_ strquery - discovery_
options_ Sequence[str]selectors - end_
time int - Seconds since epoch. Used for visualization.
- event_
overlays Sequence[DashboardEvent Overlay Args] - Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the
selected_event_overlayproperty instead. - filters
Sequence[Dashboard
Filter Args] - Filter to apply to the charts when displaying the dashboard.
- grids
Sequence[Dashboard
Grid Args] - Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.
- name str
- Name of the dashboard.
- permissions
Dashboard
Permissions Args - Permissions Controls who can view and/or edit your dashboard. Note: This feature is not present in all accounts. Please contact support if you are unsure.
- selected_
event_ Sequence[Dashboardoverlays Selected Event Overlay Args] - Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in
event_overlay, which are similar to the properties here. - start_
time int - Seconds since epoch. Used for visualization.
- Sequence[str]
- Tags of the dashboard.
- time_
range str - The time range prior to now to visualize. Splunk Observability Cloud time syntax (e.g.
"-5m","-1h"). - url str
- The URL of the dashboard.
- variables
Sequence[Dashboard
Variable Args] - Dashboard variable to apply to each chart in the dashboard.
- List<String>
- Team IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's team (or user id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - List<String>
- User IDs that have write access to this dashboard group. Remember to use an admin's token if using this feature and to include that admin's user id (or team id in
authorized_writer_teams). Note: Deprecated usepermissionsinstead. - charts List<Property Map>
- Chart ID and layout information for the charts in the dashboard.
- charts
Resolution String - Specifies the chart data display resolution for charts in this dashboard. Value can be one of
"default","low","high", or"highest". - columns List<Property Map>
- Column layout. Charts listed will be placed in a single column with the same width and height.
- dashboard
Group String - The ID of the dashboard group that contains the dashboard.
- description String
- Description of the dashboard.
- discovery
Options StringQuery - discovery
Options List<String>Selectors - end
Time Number - Seconds since epoch. Used for visualization.
- event
Overlays List<Property Map> - Specify a list of event overlays to include in the dashboard. Note: These overlays correspond to the suggested event overlays specified in the web UI, and they're not automatically applied as active overlays. To set default active event overlays, use the
selected_event_overlayproperty instead. - filters List<Property Map>
- Filter to apply to the charts when displaying the dashboard.
- grids List<Property Map>
- Grid dashboard layout. Charts listed will be placed in a grid by row with the same width and height. If a chart cannot fit in a row, it will be placed automatically in the next row.
- name String
- Name of the dashboard.
- permissions Property Map
- Permissions Controls who can view and/or edit your dashboard. Note: This feature is not present in all accounts. Please contact support if you are unsure.
- selected
Event List<Property Map>Overlays - Defines event overlays which are enabled by default. Any overlay specified here should have an accompanying entry in
event_overlay, which are similar to the properties here. - start
Time Number - Seconds since epoch. Used for visualization.
- List<String>
- Tags of the dashboard.
- time
Range String - The time range prior to now to visualize. Splunk Observability Cloud time syntax (e.g.
"-5m","-1h"). - url String
- The URL of the dashboard.
- variables List<Property Map>
- Dashboard variable to apply to each chart in the dashboard.
Supporting Types
DashboardChart, DashboardChartArgs
- Chart
Id string - ID of the chart to display.
- Column int
- The column to show the chart in (zero-based); this value always represents the leftmost column of the chart (between
0and11). - Height int
- How many rows the chart should take up (greater than or equal to
1).1by default. - Row int
- The row to show the chart in (zero-based); if
height > 1, this value represents the topmost row of the chart (greater than or equal to0). - Width int
- How many columns (out of a total of 12) the chart should take up (between
1and12).12by default.
- Chart
Id string - ID of the chart to display.
- Column int
- The column to show the chart in (zero-based); this value always represents the leftmost column of the chart (between
0and11). - Height int
- How many rows the chart should take up (greater than or equal to
1).1by default. - Row int
- The row to show the chart in (zero-based); if
height > 1, this value represents the topmost row of the chart (greater than or equal to0). - Width int
- How many columns (out of a total of 12) the chart should take up (between
1and12).12by default.
- chart
Id String - ID of the chart to display.
- column Integer
- The column to show the chart in (zero-based); this value always represents the leftmost column of the chart (between
0and11). - height Integer
- How many rows the chart should take up (greater than or equal to
1).1by default. - row Integer
- The row to show the chart in (zero-based); if
height > 1, this value represents the topmost row of the chart (greater than or equal to0). - width Integer
- How many columns (out of a total of 12) the chart should take up (between
1and12).12by default.
- chart
Id string - ID of the chart to display.
- column number
- The column to show the chart in (zero-based); this value always represents the leftmost column of the chart (between
0and11). - height number
- How many rows the chart should take up (greater than or equal to
1).1by default. - row number
- The row to show the chart in (zero-based); if
height > 1, this value represents the topmost row of the chart (greater than or equal to0). - width number
- How many columns (out of a total of 12) the chart should take up (between
1and12).12by default.
- chart_
id str - ID of the chart to display.
- column int
- The column to show the chart in (zero-based); this value always represents the leftmost column of the chart (between
0and11). - height int
- How many rows the chart should take up (greater than or equal to
1).1by default. - row int
- The row to show the chart in (zero-based); if
height > 1, this value represents the topmost row of the chart (greater than or equal to0). - width int
- How many columns (out of a total of 12) the chart should take up (between
1and12).12by default.
- chart
Id String - ID of the chart to display.
- column Number
- The column to show the chart in (zero-based); this value always represents the leftmost column of the chart (between
0and11). - height Number
- How many rows the chart should take up (greater than or equal to
1).1by default. - row Number
- The row to show the chart in (zero-based); if
height > 1, this value represents the topmost row of the chart (greater than or equal to0). - width Number
- How many columns (out of a total of 12) the chart should take up (between
1and12).12by default.
DashboardColumn, DashboardColumnArgs
- Chart
Ids List<string> - List of IDs of the charts to display.
- Column int
- Column number for the layout.
- Height int
- How many rows every chart should take up (greater than or equal to 1). 1 by default.
- Width int
- How many columns (out of a total of
12) every chart should take up (between1and12).12by default.
- chart
Ids List<String> - List of IDs of the charts to display.
- column Integer
- Column number for the layout.
- height Integer
- How many rows every chart should take up (greater than or equal to 1). 1 by default.
- width Integer
- How many columns (out of a total of
12) every chart should take up (between1and12).12by default.
- chart
Ids string[] - List of IDs of the charts to display.
- column number
- Column number for the layout.
- height number
- How many rows every chart should take up (greater than or equal to 1). 1 by default.
- width number
- How many columns (out of a total of
12) every chart should take up (between1and12).12by default.
- chart_
ids Sequence[str] - List of IDs of the charts to display.
- column int
- Column number for the layout.
- height int
- How many rows every chart should take up (greater than or equal to 1). 1 by default.
- width int
- How many columns (out of a total of
12) every chart should take up (between1and12).12by default.
- chart
Ids List<String> - List of IDs of the charts to display.
- column Number
- Column number for the layout.
- height Number
- How many rows every chart should take up (greater than or equal to 1). 1 by default.
- width Number
- How many columns (out of a total of
12) every chart should take up (between1and12).12by default.
DashboardEventOverlay, DashboardEventOverlayArgs
- Signal string
- Search term used to choose the events shown in the overlay.
- Color string
- Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
- Label string
- Text shown in the dropdown when selecting this overlay from the menu.
- Line bool
- Show a vertical line for the event.
falseby default. - Sources
List<Pulumi.
Signal Fx. Inputs. Dashboard Event Overlay Source> - Each element specifies a filter to use against the signal specified in the
signal. - Type string
- Can be set to
eventTimeSeries(the default) to refer to externally reported events, ordetectorEventsto refer to events from detector triggers.
- Signal string
- Search term used to choose the events shown in the overlay.
- Color string
- Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
- Label string
- Text shown in the dropdown when selecting this overlay from the menu.
- Line bool
- Show a vertical line for the event.
falseby default. - Sources
[]Dashboard
Event Overlay Source - Each element specifies a filter to use against the signal specified in the
signal. - Type string
- Can be set to
eventTimeSeries(the default) to refer to externally reported events, ordetectorEventsto refer to events from detector triggers.
- signal String
- Search term used to choose the events shown in the overlay.
- color String
- Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
- label String
- Text shown in the dropdown when selecting this overlay from the menu.
- line Boolean
- Show a vertical line for the event.
falseby default. - sources
List<Dashboard
Event Overlay Source> - Each element specifies a filter to use against the signal specified in the
signal. - type String
- Can be set to
eventTimeSeries(the default) to refer to externally reported events, ordetectorEventsto refer to events from detector triggers.
- signal string
- Search term used to choose the events shown in the overlay.
- color string
- Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
- label string
- Text shown in the dropdown when selecting this overlay from the menu.
- line boolean
- Show a vertical line for the event.
falseby default. - sources
Dashboard
Event Overlay Source[] - Each element specifies a filter to use against the signal specified in the
signal. - type string
- Can be set to
eventTimeSeries(the default) to refer to externally reported events, ordetectorEventsto refer to events from detector triggers.
- signal str
- Search term used to choose the events shown in the overlay.
- color str
- Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
- label str
- Text shown in the dropdown when selecting this overlay from the menu.
- line bool
- Show a vertical line for the event.
falseby default. - sources
Sequence[Dashboard
Event Overlay Source] - Each element specifies a filter to use against the signal specified in the
signal. - type str
- Can be set to
eventTimeSeries(the default) to refer to externally reported events, ordetectorEventsto refer to events from detector triggers.
- signal String
- Search term used to choose the events shown in the overlay.
- color String
- Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
- label String
- Text shown in the dropdown when selecting this overlay from the menu.
- line Boolean
- Show a vertical line for the event.
falseby default. - sources List<Property Map>
- Each element specifies a filter to use against the signal specified in the
signal. - type String
- Can be set to
eventTimeSeries(the default) to refer to externally reported events, ordetectorEventsto refer to events from detector triggers.
DashboardEventOverlaySource, DashboardEventOverlaySourceArgs
DashboardFilter, DashboardFilterArgs
- Property string
- A metric time series dimension or property name.
- Values List<string>
- List of of strings (which will be treated as an OR filter on the property).
- Apply
If boolExist - If true, this filter will also match data that doesn't have this property at all.
- Negated bool
- Whether this filter should be a not filter.
falseby default.
- Property string
- A metric time series dimension or property name.
- Values []string
- List of of strings (which will be treated as an OR filter on the property).
- Apply
If boolExist - If true, this filter will also match data that doesn't have this property at all.
- Negated bool
- Whether this filter should be a not filter.
falseby default.
- property String
- A metric time series dimension or property name.
- values List<String>
- List of of strings (which will be treated as an OR filter on the property).
- apply
If BooleanExist - If true, this filter will also match data that doesn't have this property at all.
- negated Boolean
- Whether this filter should be a not filter.
falseby default.
- property string
- A metric time series dimension or property name.
- values string[]
- List of of strings (which will be treated as an OR filter on the property).
- apply
If booleanExist - If true, this filter will also match data that doesn't have this property at all.
- negated boolean
- Whether this filter should be a not filter.
falseby default.
- property str
- A metric time series dimension or property name.
- values Sequence[str]
- List of of strings (which will be treated as an OR filter on the property).
- apply_
if_ boolexist - If true, this filter will also match data that doesn't have this property at all.
- negated bool
- Whether this filter should be a not filter.
falseby default.
- property String
- A metric time series dimension or property name.
- values List<String>
- List of of strings (which will be treated as an OR filter on the property).
- apply
If BooleanExist - If true, this filter will also match data that doesn't have this property at all.
- negated Boolean
- Whether this filter should be a not filter.
falseby default.
DashboardGrid, DashboardGridArgs
DashboardPermissions, DashboardPermissionsArgs
- Acls
List<Pulumi.
Signal Fx. Inputs. Dashboard Permissions Acl> - List of read and write permission configurations to specify which user, team, and organization can view and/or edit your dashboard. Use the
permissions.parentinstead if you want to inherit permissions. - Parent string
- ID of the dashboard group you want your dashboard to inherit permissions from. Use the
permissions.aclinstead if you want to specify various read and write permission configurations.
- Acls
[]Dashboard
Permissions Acl - List of read and write permission configurations to specify which user, team, and organization can view and/or edit your dashboard. Use the
permissions.parentinstead if you want to inherit permissions. - Parent string
- ID of the dashboard group you want your dashboard to inherit permissions from. Use the
permissions.aclinstead if you want to specify various read and write permission configurations.
- acls
List<Dashboard
Permissions Acl> - List of read and write permission configurations to specify which user, team, and organization can view and/or edit your dashboard. Use the
permissions.parentinstead if you want to inherit permissions. - parent String
- ID of the dashboard group you want your dashboard to inherit permissions from. Use the
permissions.aclinstead if you want to specify various read and write permission configurations.
- acls
Dashboard
Permissions Acl[] - List of read and write permission configurations to specify which user, team, and organization can view and/or edit your dashboard. Use the
permissions.parentinstead if you want to inherit permissions. - parent string
- ID of the dashboard group you want your dashboard to inherit permissions from. Use the
permissions.aclinstead if you want to specify various read and write permission configurations.
- acls
Sequence[Dashboard
Permissions Acl] - List of read and write permission configurations to specify which user, team, and organization can view and/or edit your dashboard. Use the
permissions.parentinstead if you want to inherit permissions. - parent str
- ID of the dashboard group you want your dashboard to inherit permissions from. Use the
permissions.aclinstead if you want to specify various read and write permission configurations.
- acls List<Property Map>
- List of read and write permission configurations to specify which user, team, and organization can view and/or edit your dashboard. Use the
permissions.parentinstead if you want to inherit permissions. - parent String
- ID of the dashboard group you want your dashboard to inherit permissions from. Use the
permissions.aclinstead if you want to specify various read and write permission configurations.
DashboardPermissionsAcl, DashboardPermissionsAclArgs
- Principal
Id string - ID of the user, team, or organization for which you're granting permissions.
- Principal
Type string - Clarify whether this permission configuration is for a user, a team, or an organization. Value can be one of "USER", "TEAM", or "ORG".
- Actions List<string>
- Action the user, team, or organization can take with the dashboard. List of values (value can be "READ" or "WRITE").
- Principal
Id string - ID of the user, team, or organization for which you're granting permissions.
- Principal
Type string - Clarify whether this permission configuration is for a user, a team, or an organization. Value can be one of "USER", "TEAM", or "ORG".
- Actions []string
- Action the user, team, or organization can take with the dashboard. List of values (value can be "READ" or "WRITE").
- principal
Id String - ID of the user, team, or organization for which you're granting permissions.
- principal
Type String - Clarify whether this permission configuration is for a user, a team, or an organization. Value can be one of "USER", "TEAM", or "ORG".
- actions List<String>
- Action the user, team, or organization can take with the dashboard. List of values (value can be "READ" or "WRITE").
- principal
Id string - ID of the user, team, or organization for which you're granting permissions.
- principal
Type string - Clarify whether this permission configuration is for a user, a team, or an organization. Value can be one of "USER", "TEAM", or "ORG".
- actions string[]
- Action the user, team, or organization can take with the dashboard. List of values (value can be "READ" or "WRITE").
- principal_
id str - ID of the user, team, or organization for which you're granting permissions.
- principal_
type str - Clarify whether this permission configuration is for a user, a team, or an organization. Value can be one of "USER", "TEAM", or "ORG".
- actions Sequence[str]
- Action the user, team, or organization can take with the dashboard. List of values (value can be "READ" or "WRITE").
- principal
Id String - ID of the user, team, or organization for which you're granting permissions.
- principal
Type String - Clarify whether this permission configuration is for a user, a team, or an organization. Value can be one of "USER", "TEAM", or "ORG".
- actions List<String>
- Action the user, team, or organization can take with the dashboard. List of values (value can be "READ" or "WRITE").
DashboardSelectedEventOverlay, DashboardSelectedEventOverlayArgs
- Signal string
- Search term used to choose the events shown in the overlay.
- Sources
List<Pulumi.
Signal Fx. Inputs. Dashboard Selected Event Overlay Source> - Each element specifies a filter to use against the signal specified in the
signal. - Type string
- Can be set to
eventTimeSeries(the default) to refer to externally reported events, ordetectorEventsto refer to events from detector triggers.
- Signal string
- Search term used to choose the events shown in the overlay.
- Sources
[]Dashboard
Selected Event Overlay Source - Each element specifies a filter to use against the signal specified in the
signal. - Type string
- Can be set to
eventTimeSeries(the default) to refer to externally reported events, ordetectorEventsto refer to events from detector triggers.
- signal String
- Search term used to choose the events shown in the overlay.
- sources
List<Dashboard
Selected Event Overlay Source> - Each element specifies a filter to use against the signal specified in the
signal. - type String
- Can be set to
eventTimeSeries(the default) to refer to externally reported events, ordetectorEventsto refer to events from detector triggers.
- signal string
- Search term used to choose the events shown in the overlay.
- sources
Dashboard
Selected Event Overlay Source[] - Each element specifies a filter to use against the signal specified in the
signal. - type string
- Can be set to
eventTimeSeries(the default) to refer to externally reported events, ordetectorEventsto refer to events from detector triggers.
- signal str
- Search term used to choose the events shown in the overlay.
- sources
Sequence[Dashboard
Selected Event Overlay Source] - Each element specifies a filter to use against the signal specified in the
signal. - type str
- Can be set to
eventTimeSeries(the default) to refer to externally reported events, ordetectorEventsto refer to events from detector triggers.
- signal String
- Search term used to choose the events shown in the overlay.
- sources List<Property Map>
- Each element specifies a filter to use against the signal specified in the
signal. - type String
- Can be set to
eventTimeSeries(the default) to refer to externally reported events, ordetectorEventsto refer to events from detector triggers.
DashboardSelectedEventOverlaySource, DashboardSelectedEventOverlaySourceArgs
DashboardVariable, DashboardVariableArgs
- Alias string
- An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.
- Property string
- A metric time series dimension or property name.
- Apply
If boolExist - If true, this variable will also match data that doesn't have this property at all.
- Description string
- Variable description.
- Replace
Only bool - If
true, this variable will only apply to charts that have a filter for the property. - Restricted
Suggestions bool - If
true, this variable may only be set to the values listed invalues_suggestedand only these values will appear in autosuggestion menus.falseby default. - Value
Required bool - Determines whether a value is required for this variable (and therefore whether it will be possible to view this dashboard without this filter applied).
falseby default. - Values List<string>
- List of of strings (which will be treated as an OR filter on the property).
- Values
Suggesteds List<string> - A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.
- Alias string
- An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.
- Property string
- A metric time series dimension or property name.
- Apply
If boolExist - If true, this variable will also match data that doesn't have this property at all.
- Description string
- Variable description.
- Replace
Only bool - If
true, this variable will only apply to charts that have a filter for the property. - Restricted
Suggestions bool - If
true, this variable may only be set to the values listed invalues_suggestedand only these values will appear in autosuggestion menus.falseby default. - Value
Required bool - Determines whether a value is required for this variable (and therefore whether it will be possible to view this dashboard without this filter applied).
falseby default. - Values []string
- List of of strings (which will be treated as an OR filter on the property).
- Values
Suggesteds []string - A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.
- alias String
- An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.
- property String
- A metric time series dimension or property name.
- apply
If BooleanExist - If true, this variable will also match data that doesn't have this property at all.
- description String
- Variable description.
- replace
Only Boolean - If
true, this variable will only apply to charts that have a filter for the property. - restricted
Suggestions Boolean - If
true, this variable may only be set to the values listed invalues_suggestedand only these values will appear in autosuggestion menus.falseby default. - value
Required Boolean - Determines whether a value is required for this variable (and therefore whether it will be possible to view this dashboard without this filter applied).
falseby default. - values List<String>
- List of of strings (which will be treated as an OR filter on the property).
- values
Suggesteds List<String> - A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.
- alias string
- An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.
- property string
- A metric time series dimension or property name.
- apply
If booleanExist - If true, this variable will also match data that doesn't have this property at all.
- description string
- Variable description.
- replace
Only boolean - If
true, this variable will only apply to charts that have a filter for the property. - restricted
Suggestions boolean - If
true, this variable may only be set to the values listed invalues_suggestedand only these values will appear in autosuggestion menus.falseby default. - value
Required boolean - Determines whether a value is required for this variable (and therefore whether it will be possible to view this dashboard without this filter applied).
falseby default. - values string[]
- List of of strings (which will be treated as an OR filter on the property).
- values
Suggesteds string[] - A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.
- alias str
- An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.
- property str
- A metric time series dimension or property name.
- apply_
if_ boolexist - If true, this variable will also match data that doesn't have this property at all.
- description str
- Variable description.
- replace_
only bool - If
true, this variable will only apply to charts that have a filter for the property. - restricted_
suggestions bool - If
true, this variable may only be set to the values listed invalues_suggestedand only these values will appear in autosuggestion menus.falseby default. - value_
required bool - Determines whether a value is required for this variable (and therefore whether it will be possible to view this dashboard without this filter applied).
falseby default. - values Sequence[str]
- List of of strings (which will be treated as an OR filter on the property).
- values_
suggesteds Sequence[str] - A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.
- alias String
- An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.
- property String
- A metric time series dimension or property name.
- apply
If BooleanExist - If true, this variable will also match data that doesn't have this property at all.
- description String
- Variable description.
- replace
Only Boolean - If
true, this variable will only apply to charts that have a filter for the property. - restricted
Suggestions Boolean - If
true, this variable may only be set to the values listed invalues_suggestedand only these values will appear in autosuggestion menus.falseby default. - value
Required Boolean - Determines whether a value is required for this variable (and therefore whether it will be possible to view this dashboard without this filter applied).
falseby default. - values List<String>
- List of of strings (which will be treated as an OR filter on the property).
- values
Suggesteds List<String> - A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.
Package Details
- Repository
- SignalFx pulumi/pulumi-signalfx
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
signalfxTerraform Provider.
Viewing docs for SignalFx v7.23.0
published on Friday, Mar 13, 2026 by Pulumi
published on Friday, Mar 13, 2026 by Pulumi
