Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Signalfx Provider
  3. API Docs
  4. Dashboard
SignalFx v7.9.0 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-signalfx

signalfx.Dashboard

Explore with Pulumi AI

SignalFx v7.9.0 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-signalfx

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,
              variables: Optional[Sequence[DashboardVariableArgs]] = None,
              end_time: Optional[int] = None,
              columns: Optional[Sequence[DashboardColumnArgs]] = 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_resolution: Optional[str] = None,
              charts: Optional[Sequence[DashboardChartArgs]] = None,
              grids: Optional[Sequence[DashboardGridArgs]] = None,
              filters: Optional[Sequence[DashboardFilterArgs]] = 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,
              authorized_writer_teams: Optional[Sequence[str]] = None)
func NewDashboard(ctx *Context, name string, args DashboardArgs, opts ...ResourceOption) (*Dashboard, error)
public Dashboard(string name, DashboardArgs args, CustomResourceOptions? opts = null)
public Dashboard(String name, DashboardArgs args)
public Dashboard(String name, DashboardArgs args, CustomResourceOptions options)

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

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DashboardArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. DashboardArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DashboardArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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",
        },
    },
    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",
            },
        },
    },
    EndTime = 0,
    Columns = new[]
    {
        new SignalFx.Inputs.DashboardColumnArgs
        {
            ChartIds = new[]
            {
                "string",
            },
            Column = 0,
            Height = 0,
            Width = 0,
        },
    },
    Description = "string",
    DiscoveryOptionsQuery = "string",
    DiscoveryOptionsSelectors = new[]
    {
        "string",
    },
    ChartsResolution = "string",
    Charts = new[]
    {
        new SignalFx.Inputs.DashboardChartArgs
        {
            ChartId = "string",
            Column = 0,
            Height = 0,
            Row = 0,
            Width = 0,
        },
    },
    Grids = new[]
    {
        new SignalFx.Inputs.DashboardGridArgs
        {
            ChartIds = new[]
            {
                "string",
            },
            Height = 0,
            Width = 0,
        },
    },
    Filters = new[]
    {
        new SignalFx.Inputs.DashboardFilterArgs
        {
            Property = "string",
            Values = new[]
            {
                "string",
            },
            ApplyIfExist = false,
            Negated = false,
        },
    },
    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",
});
Copy
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"),
		},
	},
	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"),
			},
		},
	},
	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),
		},
	},
	Description:           pulumi.String("string"),
	DiscoveryOptionsQuery: pulumi.String("string"),
	DiscoveryOptionsSelectors: pulumi.StringArray{
		pulumi.String("string"),
	},
	ChartsResolution: 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),
		},
	},
	Grids: signalfx.DashboardGridArray{
		&signalfx.DashboardGridArgs{
			ChartIds: pulumi.StringArray{
				pulumi.String("string"),
			},
			Height: pulumi.Int(0),
			Width:  pulumi.Int(0),
		},
	},
	Filters: signalfx.DashboardFilterArray{
		&signalfx.DashboardFilterArgs{
			Property: pulumi.String("string"),
			Values: pulumi.StringArray{
				pulumi.String("string"),
			},
			ApplyIfExist: pulumi.Bool(false),
			Negated:      pulumi.Bool(false),
		},
	},
	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"),
})
Copy
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())
    .variables(DashboardVariableArgs.builder()
        .alias("string")
        .property("string")
        .applyIfExist(false)
        .description("string")
        .replaceOnly(false)
        .restrictedSuggestions(false)
        .valueRequired(false)
        .values("string")
        .valuesSuggesteds("string")
        .build())
    .endTime(0)
    .columns(DashboardColumnArgs.builder()
        .chartIds("string")
        .column(0)
        .height(0)
        .width(0)
        .build())
    .description("string")
    .discoveryOptionsQuery("string")
    .discoveryOptionsSelectors("string")
    .chartsResolution("string")
    .charts(DashboardChartArgs.builder()
        .chartId("string")
        .column(0)
        .height(0)
        .row(0)
        .width(0)
        .build())
    .grids(DashboardGridArgs.builder()
        .chartIds("string")
        .height(0)
        .width(0)
        .build())
    .filters(DashboardFilterArgs.builder()
        .property("string")
        .values("string")
        .applyIfExist(false)
        .negated(false)
        .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")
    .build());
Copy
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",
    }],
    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"],
    }],
    end_time=0,
    columns=[{
        "chart_ids": ["string"],
        "column": 0,
        "height": 0,
        "width": 0,
    }],
    description="string",
    discovery_options_query="string",
    discovery_options_selectors=["string"],
    charts_resolution="string",
    charts=[{
        "chart_id": "string",
        "column": 0,
        "height": 0,
        "row": 0,
        "width": 0,
    }],
    grids=[{
        "chart_ids": ["string"],
        "height": 0,
        "width": 0,
    }],
    filters=[{
        "property": "string",
        "values": ["string"],
        "apply_if_exist": False,
        "negated": False,
    }],
    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")
Copy
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",
    }],
    variables: [{
        alias: "string",
        property: "string",
        applyIfExist: false,
        description: "string",
        replaceOnly: false,
        restrictedSuggestions: false,
        valueRequired: false,
        values: ["string"],
        valuesSuggesteds: ["string"],
    }],
    endTime: 0,
    columns: [{
        chartIds: ["string"],
        column: 0,
        height: 0,
        width: 0,
    }],
    description: "string",
    discoveryOptionsQuery: "string",
    discoveryOptionsSelectors: ["string"],
    chartsResolution: "string",
    charts: [{
        chartId: "string",
        column: 0,
        height: 0,
        row: 0,
        width: 0,
    }],
    grids: [{
        chartIds: ["string"],
        height: 0,
        width: 0,
    }],
    filters: [{
        property: "string",
        values: ["string"],
        applyIfExist: false,
        negated: false,
    }],
    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",
});
Copy
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
Copy

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:

DashboardGroup This property is required. string
The ID of the dashboard group that contains the dashboard.
AuthorizedWriterTeams 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 use permissions instead.

Deprecated: Please use permissions_* fields now

AuthorizedWriterUsers 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 use permissions instead.

Deprecated: Please use permissions fields now

Charts List<Pulumi.SignalFx.Inputs.DashboardChart>
Chart ID and layout information for the charts in the dashboard.
ChartsResolution 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.SignalFx.Inputs.DashboardColumn>
Column layout. Charts listed will be placed in a single column with the same width and height.
Description string
Description of the dashboard.
DiscoveryOptionsQuery string
DiscoveryOptionsSelectors List<string>
EndTime int
Seconds since epoch. Used for visualization.
EventOverlays List<Pulumi.SignalFx.Inputs.DashboardEventOverlay>
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_overlay property instead.
Filters List<Pulumi.SignalFx.Inputs.DashboardFilter>
Filter to apply to the charts when displaying the dashboard.
Grids List<Pulumi.SignalFx.Inputs.DashboardGrid>
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.SignalFx.Inputs.DashboardPermissions
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.
SelectedEventOverlays List<Pulumi.SignalFx.Inputs.DashboardSelectedEventOverlay>
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.
StartTime int
Seconds since epoch. Used for visualization.
Tags List<string>
Tags of the dashboard.
TimeRange string
The time range prior to now to visualize. Splunk Observability Cloud time syntax (e.g. "-5m", "-1h").
Variables List<Pulumi.SignalFx.Inputs.DashboardVariable>
Dashboard variable to apply to each chart in the dashboard.
DashboardGroup This property is required. string
The ID of the dashboard group that contains the dashboard.
AuthorizedWriterTeams []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 use permissions instead.

Deprecated: Please use permissions_* fields now

AuthorizedWriterUsers []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 use permissions instead.

Deprecated: Please use permissions fields now

Charts []DashboardChartArgs
Chart ID and layout information for the charts in the dashboard.
ChartsResolution string
Specifies the chart data display resolution for charts in this dashboard. Value can be one of "default", "low", "high", or "highest".
Columns []DashboardColumnArgs
Column layout. Charts listed will be placed in a single column with the same width and height.
Description string
Description of the dashboard.
DiscoveryOptionsQuery string
DiscoveryOptionsSelectors []string
EndTime int
Seconds since epoch. Used for visualization.
EventOverlays []DashboardEventOverlayArgs
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_overlay property instead.
Filters []DashboardFilterArgs
Filter to apply to the charts when displaying the dashboard.
Grids []DashboardGridArgs
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 DashboardPermissionsArgs
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.
SelectedEventOverlays []DashboardSelectedEventOverlayArgs
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.
StartTime int
Seconds since epoch. Used for visualization.
Tags []string
Tags of the dashboard.
TimeRange string
The time range prior to now to visualize. Splunk Observability Cloud time syntax (e.g. "-5m", "-1h").
Variables []DashboardVariableArgs
Dashboard variable to apply to each chart in the dashboard.
dashboardGroup This property is required. String
The ID of the dashboard group that contains the dashboard.
authorizedWriterTeams 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 use permissions instead.

Deprecated: Please use permissions_* fields now

authorizedWriterUsers 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 use permissions instead.

Deprecated: Please use permissions fields now

charts List<DashboardChart>
Chart ID and layout information for the charts in the dashboard.
chartsResolution String
Specifies the chart data display resolution for charts in this dashboard. Value can be one of "default", "low", "high", or "highest".
columns List<DashboardColumn>
Column layout. Charts listed will be placed in a single column with the same width and height.
description String
Description of the dashboard.
discoveryOptionsQuery String
discoveryOptionsSelectors List<String>
endTime Integer
Seconds since epoch. Used for visualization.
eventOverlays List<DashboardEventOverlay>
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_overlay property instead.
filters List<DashboardFilter>
Filter to apply to the charts when displaying the dashboard.
grids List<DashboardGrid>
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 DashboardPermissions
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.
selectedEventOverlays List<DashboardSelectedEventOverlay>
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.
startTime Integer
Seconds since epoch. Used for visualization.
tags List<String>
Tags of the dashboard.
timeRange String
The time range prior to now to visualize. Splunk Observability Cloud time syntax (e.g. "-5m", "-1h").
variables List<DashboardVariable>
Dashboard variable to apply to each chart in the dashboard.
dashboardGroup This property is required. string
The ID of the dashboard group that contains the dashboard.
authorizedWriterTeams 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 use permissions instead.

Deprecated: Please use permissions_* fields now

authorizedWriterUsers 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 use permissions instead.

Deprecated: Please use permissions fields now

charts DashboardChart[]
Chart ID and layout information for the charts in the dashboard.
chartsResolution string
Specifies the chart data display resolution for charts in this dashboard. Value can be one of "default", "low", "high", or "highest".
columns DashboardColumn[]
Column layout. Charts listed will be placed in a single column with the same width and height.
description string
Description of the dashboard.
discoveryOptionsQuery string
discoveryOptionsSelectors string[]
endTime number
Seconds since epoch. Used for visualization.
eventOverlays DashboardEventOverlay[]
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_overlay property instead.
filters DashboardFilter[]
Filter to apply to the charts when displaying the dashboard.
grids DashboardGrid[]
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 DashboardPermissions
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.
selectedEventOverlays DashboardSelectedEventOverlay[]
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.
startTime number
Seconds since epoch. Used for visualization.
tags string[]
Tags of the dashboard.
timeRange string
The time range prior to now to visualize. Splunk Observability Cloud time syntax (e.g. "-5m", "-1h").
variables DashboardVariable[]
Dashboard variable to apply to each chart in the dashboard.
dashboard_group This property is required. str
The ID of the dashboard group that contains the dashboard.
authorized_writer_teams 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 use permissions instead.

Deprecated: Please use permissions_* fields now

authorized_writer_users 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 use permissions instead.

Deprecated: Please use permissions fields now

charts Sequence[DashboardChartArgs]
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[DashboardColumnArgs]
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_query str
discovery_options_selectors Sequence[str]
end_time int
Seconds since epoch. Used for visualization.
event_overlays Sequence[DashboardEventOverlayArgs]
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_overlay property instead.
filters Sequence[DashboardFilterArgs]
Filter to apply to the charts when displaying the dashboard.
grids Sequence[DashboardGridArgs]
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 DashboardPermissionsArgs
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_overlays Sequence[DashboardSelectedEventOverlayArgs]
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.
tags 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[DashboardVariableArgs]
Dashboard variable to apply to each chart in the dashboard.
dashboardGroup This property is required. String
The ID of the dashboard group that contains the dashboard.
authorizedWriterTeams 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 use permissions instead.

Deprecated: Please use permissions_* fields now

authorizedWriterUsers 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 use permissions instead.

Deprecated: Please use permissions fields now

charts List<Property Map>
Chart ID and layout information for the charts in the dashboard.
chartsResolution 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.
discoveryOptionsQuery String
discoveryOptionsSelectors List<String>
endTime Number
Seconds since epoch. Used for visualization.
eventOverlays 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_overlay property 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.
selectedEventOverlays List<Property Map>
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.
startTime Number
Seconds since epoch. Used for visualization.
tags List<String>
Tags of the dashboard.
timeRange 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:

Id string
The provider-assigned unique ID for this managed resource.
Url string
The URL of the dashboard.
Id string
The provider-assigned unique ID for this managed resource.
Url string
The URL of the dashboard.
id String
The provider-assigned unique ID for this managed resource.
url String
The URL of the dashboard.
id string
The provider-assigned unique ID for this managed resource.
url string
The URL of the dashboard.
id str
The provider-assigned unique ID for this managed resource.
url str
The URL of the dashboard.
id String
The provider-assigned unique ID for this managed resource.
url String
The URL of the dashboard.

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) -> Dashboard
func GetDashboard(ctx *Context, name string, id IDInput, state *DashboardState, opts ...ResourceOption) (*Dashboard, error)
public static Dashboard Get(string name, Input<string> id, DashboardState? state, CustomResourceOptions? opts = null)
public static Dashboard get(String name, Output<String> id, DashboardState state, CustomResourceOptions options)
resources:  _:    type: signalfx:Dashboard    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
AuthorizedWriterTeams 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 use permissions instead.

Deprecated: Please use permissions_* fields now

AuthorizedWriterUsers 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 use permissions instead.

Deprecated: Please use permissions fields now

Charts List<Pulumi.SignalFx.Inputs.DashboardChart>
Chart ID and layout information for the charts in the dashboard.
ChartsResolution 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.SignalFx.Inputs.DashboardColumn>
Column layout. Charts listed will be placed in a single column with the same width and height.
DashboardGroup string
The ID of the dashboard group that contains the dashboard.
Description string
Description of the dashboard.
DiscoveryOptionsQuery string
DiscoveryOptionsSelectors List<string>
EndTime int
Seconds since epoch. Used for visualization.
EventOverlays List<Pulumi.SignalFx.Inputs.DashboardEventOverlay>
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_overlay property instead.
Filters List<Pulumi.SignalFx.Inputs.DashboardFilter>
Filter to apply to the charts when displaying the dashboard.
Grids List<Pulumi.SignalFx.Inputs.DashboardGrid>
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.SignalFx.Inputs.DashboardPermissions
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.
SelectedEventOverlays List<Pulumi.SignalFx.Inputs.DashboardSelectedEventOverlay>
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.
StartTime int
Seconds since epoch. Used for visualization.
Tags List<string>
Tags of the dashboard.
TimeRange 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.SignalFx.Inputs.DashboardVariable>
Dashboard variable to apply to each chart in the dashboard.
AuthorizedWriterTeams []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 use permissions instead.

Deprecated: Please use permissions_* fields now

AuthorizedWriterUsers []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 use permissions instead.

Deprecated: Please use permissions fields now

Charts []DashboardChartArgs
Chart ID and layout information for the charts in the dashboard.
ChartsResolution string
Specifies the chart data display resolution for charts in this dashboard. Value can be one of "default", "low", "high", or "highest".
Columns []DashboardColumnArgs
Column layout. Charts listed will be placed in a single column with the same width and height.
DashboardGroup string
The ID of the dashboard group that contains the dashboard.
Description string
Description of the dashboard.
DiscoveryOptionsQuery string
DiscoveryOptionsSelectors []string
EndTime int
Seconds since epoch. Used for visualization.
EventOverlays []DashboardEventOverlayArgs
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_overlay property instead.
Filters []DashboardFilterArgs
Filter to apply to the charts when displaying the dashboard.
Grids []DashboardGridArgs
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 DashboardPermissionsArgs
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.
SelectedEventOverlays []DashboardSelectedEventOverlayArgs
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.
StartTime int
Seconds since epoch. Used for visualization.
Tags []string
Tags of the dashboard.
TimeRange 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 []DashboardVariableArgs
Dashboard variable to apply to each chart in the dashboard.
authorizedWriterTeams 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 use permissions instead.

Deprecated: Please use permissions_* fields now

authorizedWriterUsers 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 use permissions instead.

Deprecated: Please use permissions fields now

charts List<DashboardChart>
Chart ID and layout information for the charts in the dashboard.
chartsResolution String
Specifies the chart data display resolution for charts in this dashboard. Value can be one of "default", "low", "high", or "highest".
columns List<DashboardColumn>
Column layout. Charts listed will be placed in a single column with the same width and height.
dashboardGroup String
The ID of the dashboard group that contains the dashboard.
description String
Description of the dashboard.
discoveryOptionsQuery String
discoveryOptionsSelectors List<String>
endTime Integer
Seconds since epoch. Used for visualization.
eventOverlays List<DashboardEventOverlay>
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_overlay property instead.
filters List<DashboardFilter>
Filter to apply to the charts when displaying the dashboard.
grids List<DashboardGrid>
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 DashboardPermissions
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.
selectedEventOverlays List<DashboardSelectedEventOverlay>
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.
startTime Integer
Seconds since epoch. Used for visualization.
tags List<String>
Tags of the dashboard.
timeRange 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<DashboardVariable>
Dashboard variable to apply to each chart in the dashboard.
authorizedWriterTeams 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 use permissions instead.

Deprecated: Please use permissions_* fields now

authorizedWriterUsers 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 use permissions instead.

Deprecated: Please use permissions fields now

charts DashboardChart[]
Chart ID and layout information for the charts in the dashboard.
chartsResolution string
Specifies the chart data display resolution for charts in this dashboard. Value can be one of "default", "low", "high", or "highest".
columns DashboardColumn[]
Column layout. Charts listed will be placed in a single column with the same width and height.
dashboardGroup string
The ID of the dashboard group that contains the dashboard.
description string
Description of the dashboard.
discoveryOptionsQuery string
discoveryOptionsSelectors string[]
endTime number
Seconds since epoch. Used for visualization.
eventOverlays DashboardEventOverlay[]
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_overlay property instead.
filters DashboardFilter[]
Filter to apply to the charts when displaying the dashboard.
grids DashboardGrid[]
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 DashboardPermissions
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.
selectedEventOverlays DashboardSelectedEventOverlay[]
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.
startTime number
Seconds since epoch. Used for visualization.
tags string[]
Tags of the dashboard.
timeRange 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 DashboardVariable[]
Dashboard variable to apply to each chart in the dashboard.
authorized_writer_teams 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 use permissions instead.

Deprecated: Please use permissions_* fields now

authorized_writer_users 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 use permissions instead.

Deprecated: Please use permissions fields now

charts Sequence[DashboardChartArgs]
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[DashboardColumnArgs]
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_query str
discovery_options_selectors Sequence[str]
end_time int
Seconds since epoch. Used for visualization.
event_overlays Sequence[DashboardEventOverlayArgs]
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_overlay property instead.
filters Sequence[DashboardFilterArgs]
Filter to apply to the charts when displaying the dashboard.
grids Sequence[DashboardGridArgs]
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 DashboardPermissionsArgs
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_overlays Sequence[DashboardSelectedEventOverlayArgs]
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.
tags 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[DashboardVariableArgs]
Dashboard variable to apply to each chart in the dashboard.
authorizedWriterTeams 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 use permissions instead.

Deprecated: Please use permissions_* fields now

authorizedWriterUsers 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 use permissions instead.

Deprecated: Please use permissions fields now

charts List<Property Map>
Chart ID and layout information for the charts in the dashboard.
chartsResolution 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.
dashboardGroup String
The ID of the dashboard group that contains the dashboard.
description String
Description of the dashboard.
discoveryOptionsQuery String
discoveryOptionsSelectors List<String>
endTime Number
Seconds since epoch. Used for visualization.
eventOverlays 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_overlay property 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.
selectedEventOverlays List<Property Map>
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.
startTime Number
Seconds since epoch. Used for visualization.
tags List<String>
Tags of the dashboard.
timeRange 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

ChartId This property is required. 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 0 and 11).
Height int
How many rows the chart should take up (greater than or equal to 1). 1 by 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 to 0).
Width int
How many columns (out of a total of 12) the chart should take up (between 1 and 12). 12 by default.
ChartId This property is required. 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 0 and 11).
Height int
How many rows the chart should take up (greater than or equal to 1). 1 by 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 to 0).
Width int
How many columns (out of a total of 12) the chart should take up (between 1 and 12). 12 by default.
chartId This property is required. 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 0 and 11).
height Integer
How many rows the chart should take up (greater than or equal to 1). 1 by 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 to 0).
width Integer
How many columns (out of a total of 12) the chart should take up (between 1 and 12). 12 by default.
chartId This property is required. 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 0 and 11).
height number
How many rows the chart should take up (greater than or equal to 1). 1 by 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 to 0).
width number
How many columns (out of a total of 12) the chart should take up (between 1 and 12). 12 by default.
chart_id This property is required. 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 0 and 11).
height int
How many rows the chart should take up (greater than or equal to 1). 1 by 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 to 0).
width int
How many columns (out of a total of 12) the chart should take up (between 1 and 12). 12 by default.
chartId This property is required. 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 0 and 11).
height Number
How many rows the chart should take up (greater than or equal to 1). 1 by 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 to 0).
width Number
How many columns (out of a total of 12) the chart should take up (between 1 and 12). 12 by default.

DashboardColumn
, DashboardColumnArgs

ChartIds This property is required. 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 (between 1 and 12). 12 by default.
ChartIds This property is required. []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 (between 1 and 12). 12 by default.
chartIds This property is required. 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 (between 1 and 12). 12 by default.
chartIds This property is required. 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 (between 1 and 12). 12 by default.
chart_ids This property is required. 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 (between 1 and 12). 12 by default.
chartIds This property is required. 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 (between 1 and 12). 12 by default.

DashboardEventOverlay
, DashboardEventOverlayArgs

Signal This property is required. 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. false by default.
Sources List<Pulumi.SignalFx.Inputs.DashboardEventOverlaySource>
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, or detectorEvents to refer to events from detector triggers.
Signal This property is required. 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. false by default.
Sources []DashboardEventOverlaySource
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, or detectorEvents to refer to events from detector triggers.
signal This property is required. 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. false by default.
sources List<DashboardEventOverlaySource>
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, or detectorEvents to refer to events from detector triggers.
signal This property is required. 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. false by default.
sources DashboardEventOverlaySource[]
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, or detectorEvents to refer to events from detector triggers.
signal This property is required. 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. false by default.
sources Sequence[DashboardEventOverlaySource]
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, or detectorEvents to refer to events from detector triggers.
signal This property is required. 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. false by 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, or detectorEvents to refer to events from detector triggers.

DashboardEventOverlaySource
, DashboardEventOverlaySourceArgs

Property This property is required. string
The name of a dimension to filter against.
Values This property is required. List<string>
A list of values to be used with the property, they will be combined via OR.
Negated bool
If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.
Property This property is required. string
The name of a dimension to filter against.
Values This property is required. []string
A list of values to be used with the property, they will be combined via OR.
Negated bool
If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.
property This property is required. String
The name of a dimension to filter against.
values This property is required. List<String>
A list of values to be used with the property, they will be combined via OR.
negated Boolean
If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.
property This property is required. string
The name of a dimension to filter against.
values This property is required. string[]
A list of values to be used with the property, they will be combined via OR.
negated boolean
If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.
property This property is required. str
The name of a dimension to filter against.
values This property is required. Sequence[str]
A list of values to be used with the property, they will be combined via OR.
negated bool
If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.
property This property is required. String
The name of a dimension to filter against.
values This property is required. List<String>
A list of values to be used with the property, they will be combined via OR.
negated Boolean
If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

DashboardFilter
, DashboardFilterArgs

Property This property is required. string
A metric time series dimension or property name.
Values This property is required. List<string>
List of of strings (which will be treated as an OR filter on the property).
ApplyIfExist bool
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. false by default.
Property This property is required. string
A metric time series dimension or property name.
Values This property is required. []string
List of of strings (which will be treated as an OR filter on the property).
ApplyIfExist bool
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. false by default.
property This property is required. String
A metric time series dimension or property name.
values This property is required. List<String>
List of of strings (which will be treated as an OR filter on the property).
applyIfExist Boolean
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. false by default.
property This property is required. string
A metric time series dimension or property name.
values This property is required. string[]
List of of strings (which will be treated as an OR filter on the property).
applyIfExist boolean
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. false by default.
property This property is required. str
A metric time series dimension or property name.
values This property is required. Sequence[str]
List of of strings (which will be treated as an OR filter on the property).
apply_if_exist bool
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. false by default.
property This property is required. String
A metric time series dimension or property name.
values This property is required. List<String>
List of of strings (which will be treated as an OR filter on the property).
applyIfExist Boolean
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. false by default.

DashboardGrid
, DashboardGridArgs

ChartIds This property is required. List<string>
List of IDs of the charts to display.
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 (between 1 and 12). 12 by default.
ChartIds This property is required. []string
List of IDs of the charts to display.
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 (between 1 and 12). 12 by default.
chartIds This property is required. List<String>
List of IDs of the charts to display.
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 (between 1 and 12). 12 by default.
chartIds This property is required. string[]
List of IDs of the charts to display.
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 (between 1 and 12). 12 by default.
chart_ids This property is required. Sequence[str]
List of IDs of the charts to display.
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 (between 1 and 12). 12 by default.
chartIds This property is required. List<String>
List of IDs of the charts to display.
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 (between 1 and 12). 12 by default.

DashboardPermissions
, DashboardPermissionsArgs

Acls List<Pulumi.SignalFx.Inputs.DashboardPermissionsAcl>
List of read and write permission configurations to specify which user, team, and organization can view and/or edit your dashboard. Use the permissions.parent instead if you want to inherit permissions.
Parent string
ID of the dashboard group you want your dashboard to inherit permissions from. Use the permissions.acl instead if you want to specify various read and write permission configurations.
Acls []DashboardPermissionsAcl
List of read and write permission configurations to specify which user, team, and organization can view and/or edit your dashboard. Use the permissions.parent instead if you want to inherit permissions.
Parent string
ID of the dashboard group you want your dashboard to inherit permissions from. Use the permissions.acl instead if you want to specify various read and write permission configurations.
acls List<DashboardPermissionsAcl>
List of read and write permission configurations to specify which user, team, and organization can view and/or edit your dashboard. Use the permissions.parent instead if you want to inherit permissions.
parent String
ID of the dashboard group you want your dashboard to inherit permissions from. Use the permissions.acl instead if you want to specify various read and write permission configurations.
acls DashboardPermissionsAcl[]
List of read and write permission configurations to specify which user, team, and organization can view and/or edit your dashboard. Use the permissions.parent instead if you want to inherit permissions.
parent string
ID of the dashboard group you want your dashboard to inherit permissions from. Use the permissions.acl instead if you want to specify various read and write permission configurations.
acls Sequence[DashboardPermissionsAcl]
List of read and write permission configurations to specify which user, team, and organization can view and/or edit your dashboard. Use the permissions.parent instead if you want to inherit permissions.
parent str
ID of the dashboard group you want your dashboard to inherit permissions from. Use the permissions.acl instead 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.parent instead if you want to inherit permissions.
parent String
ID of the dashboard group you want your dashboard to inherit permissions from. Use the permissions.acl instead if you want to specify various read and write permission configurations.

DashboardPermissionsAcl
, DashboardPermissionsAclArgs

PrincipalId This property is required. string
ID of the user, team, or organization for which you're granting permissions.
PrincipalType This property is required. 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").
PrincipalId This property is required. string
ID of the user, team, or organization for which you're granting permissions.
PrincipalType This property is required. 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").
principalId This property is required. String
ID of the user, team, or organization for which you're granting permissions.
principalType This property is required. 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").
principalId This property is required. string
ID of the user, team, or organization for which you're granting permissions.
principalType This property is required. 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 This property is required. str
ID of the user, team, or organization for which you're granting permissions.
principal_type This property is required. 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").
principalId This property is required. String
ID of the user, team, or organization for which you're granting permissions.
principalType This property is required. 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 This property is required. string
Search term used to choose the events shown in the overlay.
Sources List<Pulumi.SignalFx.Inputs.DashboardSelectedEventOverlaySource>
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, or detectorEvents to refer to events from detector triggers.
Signal This property is required. string
Search term used to choose the events shown in the overlay.
Sources []DashboardSelectedEventOverlaySource
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, or detectorEvents to refer to events from detector triggers.
signal This property is required. String
Search term used to choose the events shown in the overlay.
sources List<DashboardSelectedEventOverlaySource>
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, or detectorEvents to refer to events from detector triggers.
signal This property is required. string
Search term used to choose the events shown in the overlay.
sources DashboardSelectedEventOverlaySource[]
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, or detectorEvents to refer to events from detector triggers.
signal This property is required. str
Search term used to choose the events shown in the overlay.
sources Sequence[DashboardSelectedEventOverlaySource]
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, or detectorEvents to refer to events from detector triggers.
signal This property is required. 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, or detectorEvents to refer to events from detector triggers.

DashboardSelectedEventOverlaySource
, DashboardSelectedEventOverlaySourceArgs

Property This property is required. string
The name of a dimension to filter against.
Values This property is required. List<string>
A list of values to be used with the property, they will be combined via OR.
Negated bool
If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.
Property This property is required. string
The name of a dimension to filter against.
Values This property is required. []string
A list of values to be used with the property, they will be combined via OR.
Negated bool
If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.
property This property is required. String
The name of a dimension to filter against.
values This property is required. List<String>
A list of values to be used with the property, they will be combined via OR.
negated Boolean
If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.
property This property is required. string
The name of a dimension to filter against.
values This property is required. string[]
A list of values to be used with the property, they will be combined via OR.
negated boolean
If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.
property This property is required. str
The name of a dimension to filter against.
values This property is required. Sequence[str]
A list of values to be used with the property, they will be combined via OR.
negated bool
If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.
property This property is required. String
The name of a dimension to filter against.
values This property is required. List<String>
A list of values to be used with the property, they will be combined via OR.
negated Boolean
If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to false.

DashboardVariable
, DashboardVariableArgs

Alias This property is required. string
An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.
Property This property is required. string
A metric time series dimension or property name.
ApplyIfExist bool
If true, this variable will also match data that doesn't have this property at all.
Description string
Variable description.
ReplaceOnly bool
If true, this variable will only apply to charts that have a filter for the property.
RestrictedSuggestions bool
If true, this variable may only be set to the values listed in values_suggested and only these values will appear in autosuggestion menus. false by default.
ValueRequired 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). false by default.
Values List<string>
List of of strings (which will be treated as an OR filter on the property).
ValuesSuggesteds 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 This property is required. string
An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.
Property This property is required. string
A metric time series dimension or property name.
ApplyIfExist bool
If true, this variable will also match data that doesn't have this property at all.
Description string
Variable description.
ReplaceOnly bool
If true, this variable will only apply to charts that have a filter for the property.
RestrictedSuggestions bool
If true, this variable may only be set to the values listed in values_suggested and only these values will appear in autosuggestion menus. false by default.
ValueRequired 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). false by default.
Values []string
List of of strings (which will be treated as an OR filter on the property).
ValuesSuggesteds []string
A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.
alias This property is required. String
An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.
property This property is required. String
A metric time series dimension or property name.
applyIfExist Boolean
If true, this variable will also match data that doesn't have this property at all.
description String
Variable description.
replaceOnly Boolean
If true, this variable will only apply to charts that have a filter for the property.
restrictedSuggestions Boolean
If true, this variable may only be set to the values listed in values_suggested and only these values will appear in autosuggestion menus. false by default.
valueRequired 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). false by default.
values List<String>
List of of strings (which will be treated as an OR filter on the property).
valuesSuggesteds 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 This property is required. string
An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.
property This property is required. string
A metric time series dimension or property name.
applyIfExist boolean
If true, this variable will also match data that doesn't have this property at all.
description string
Variable description.
replaceOnly boolean
If true, this variable will only apply to charts that have a filter for the property.
restrictedSuggestions boolean
If true, this variable may only be set to the values listed in values_suggested and only these values will appear in autosuggestion menus. false by default.
valueRequired 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). false by default.
values string[]
List of of strings (which will be treated as an OR filter on the property).
valuesSuggesteds string[]
A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.
alias This property is required. str
An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.
property This property is required. str
A metric time series dimension or property name.
apply_if_exist bool
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 in values_suggested and only these values will appear in autosuggestion menus. false by 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). false by 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 This property is required. String
An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.
property This property is required. String
A metric time series dimension or property name.
applyIfExist Boolean
If true, this variable will also match data that doesn't have this property at all.
description String
Variable description.
replaceOnly Boolean
If true, this variable will only apply to charts that have a filter for the property.
restrictedSuggestions Boolean
If true, this variable may only be set to the values listed in values_suggested and only these values will appear in autosuggestion menus. false by default.
valueRequired 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). false by default.
values List<String>
List of of strings (which will be treated as an OR filter on the property).
valuesSuggesteds 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 signalfx Terraform Provider.
SignalFx v7.9.0 published on Wednesday, Mar 26, 2025 by Pulumi
pulumi/pulumi-signalfx