1. Pulumi Registry
  2. Datadog
  3. API Docs
  4. Dashboard
datadog logo
Datadog v4.15.0, Mar 14 23

datadog.Dashboard

Provides a Datadog dashboard resource. This can be used to create and manage Datadog dashboards.

Example Usage

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.datadog.Dashboard;
import com.pulumi.datadog.DashboardArgs;
import com.pulumi.datadog.inputs.DashboardTemplateVariableArgs;
import com.pulumi.datadog.inputs.DashboardTemplateVariablePresetArgs;
import com.pulumi.datadog.inputs.DashboardWidgetArgs;
import com.pulumi.datadog.inputs.DashboardWidgetAlertGraphDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetAlertValueDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetChangeDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetDistributionDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetCheckStatusDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetHeatmapDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetHeatmapDefinitionYaxisArgs;
import com.pulumi.datadog.inputs.DashboardWidgetHostmapDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetHostmapDefinitionRequestArgs;
import com.pulumi.datadog.inputs.DashboardWidgetHostmapDefinitionStyleArgs;
import com.pulumi.datadog.inputs.DashboardWidgetNoteDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetQueryValueDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetQueryTableDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetScatterplotDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetScatterplotDefinitionRequestArgs;
import com.pulumi.datadog.inputs.DashboardWidgetScatterplotDefinitionXaxisArgs;
import com.pulumi.datadog.inputs.DashboardWidgetScatterplotDefinitionYaxisArgs;
import com.pulumi.datadog.inputs.DashboardWidgetServicemapDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetTimeseriesDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetTimeseriesDefinitionYaxisArgs;
import com.pulumi.datadog.inputs.DashboardWidgetToplistDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetGroupDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetServiceLevelObjectiveDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetEventStreamDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetWidgetLayoutArgs;
import com.pulumi.datadog.inputs.DashboardWidgetEventTimelineDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetFreeTextDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetIframeDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetImageDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetLogStreamDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetLogStreamDefinitionSortArgs;
import com.pulumi.datadog.inputs.DashboardWidgetManageStatusDefinitionArgs;
import com.pulumi.datadog.inputs.DashboardWidgetTraceServiceDefinitionArgs;
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 orderedDashboard = new Dashboard("orderedDashboard", DashboardArgs.builder()        
            .description("Created using the Datadog provider in Terraform")
            .isReadOnly(true)
            .layoutType("ordered")
            .templateVariables(            
                DashboardTemplateVariableArgs.builder()
                    .default_("aws")
                    .name("var_1")
                    .prefix("host")
                    .build(),
                DashboardTemplateVariableArgs.builder()
                    .default_("autoscaling")
                    .name("var_2")
                    .prefix("service_name")
                    .build())
            .templateVariablePresets(DashboardTemplateVariablePresetArgs.builder()
                .name("preset_1")
                .templateVariables(                
                    DashboardTemplateVariablePresetTemplateVariableArgs.builder()
                        .name("var_1")
                        .value("host.dc")
                        .build(),
                    DashboardTemplateVariablePresetTemplateVariableArgs.builder()
                        .name("var_2")
                        .value("my_service")
                        .build())
                .build())
            .title("Ordered Layout Dashboard")
            .widgets(            
                DashboardWidgetArgs.builder()
                    .alertGraphDefinition(DashboardWidgetAlertGraphDefinitionArgs.builder()
                        .alertId("895605")
                        .liveSpan("1h")
                        .title("Widget Title")
                        .vizType("timeseries")
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .alertValueDefinition(DashboardWidgetAlertValueDefinitionArgs.builder()
                        .alertId("895605")
                        .precision(3)
                        .textAlign("center")
                        .title("Widget Title")
                        .unit("b")
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .alertValueDefinition(DashboardWidgetAlertValueDefinitionArgs.builder()
                        .alertId("895605")
                        .precision(3)
                        .textAlign("center")
                        .title("Widget Title")
                        .unit("b")
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .changeDefinition(DashboardWidgetChangeDefinitionArgs.builder()
                        .liveSpan("1h")
                        .request(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                        .title("Widget Title")
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .distributionDefinition(DashboardWidgetDistributionDefinitionArgs.builder()
                        .liveSpan("1h")
                        .request(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                        .title("Widget Title")
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .checkStatusDefinition(DashboardWidgetCheckStatusDefinitionArgs.builder()
                        .check("aws.ecs.agent_connected")
                        .groupBy(                        
                            "account",
                            "cluster")
                        .grouping("cluster")
                        .liveSpan("1h")
                        .tags(                        
                            "account:demo",
                            "cluster:awseb-ruthebdog-env-8-dn3m6u3gvk")
                        .title("Widget Title")
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .heatmapDefinition(DashboardWidgetHeatmapDefinitionArgs.builder()
                        .liveSpan("1h")
                        .request(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                        .title("Widget Title")
                        .yaxis(DashboardWidgetHeatmapDefinitionYaxisArgs.builder()
                            .includeZero(true)
                            .max(2)
                            .min(1)
                            .scale("sqrt")
                            .build())
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .hostmapDefinition(DashboardWidgetHostmapDefinitionArgs.builder()
                        .group(                        
                            "host",
                            "region")
                        .noGroupHosts(true)
                        .noMetricHosts(true)
                        .nodeType("container")
                        .request(DashboardWidgetHostmapDefinitionRequestArgs.builder()
                            .fill(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                            .size(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                            .build())
                        .scope(                        
                            "region:us-east-1",
                            "aws_account:727006795293")
                        .style(DashboardWidgetHostmapDefinitionStyleArgs.builder()
                            .fillMax("20")
                            .fillMin("10")
                            .palette("yellow_to_green")
                            .paletteFlip(true)
                            .build())
                        .title("Widget Title")
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .noteDefinition(DashboardWidgetNoteDefinitionArgs.builder()
                        .backgroundColor("pink")
                        .content("note text")
                        .fontSize("14")
                        .showTick(true)
                        .textAlign("center")
                        .tickEdge("left")
                        .tickPos("50%")
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .queryValueDefinition(DashboardWidgetQueryValueDefinitionArgs.builder()
                        .autoscale(true)
                        .customUnit("xx")
                        .liveSpan("1h")
                        .precision("4")
                        .request(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                        .textAlign("right")
                        .title("Widget Title")
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .queryTableDefinition(DashboardWidgetQueryTableDefinitionArgs.builder()
                        .liveSpan("1h")
                        .request(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                        .title("Widget Title")
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .scatterplotDefinition(DashboardWidgetScatterplotDefinitionArgs.builder()
                        .colorByGroups(                        
                            "account",
                            "apm-role-group")
                        .liveSpan("1h")
                        .request(DashboardWidgetScatterplotDefinitionRequestArgs.builder()
                            .x(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                            .y(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                            .build())
                        .title("Widget Title")
                        .xaxis(DashboardWidgetScatterplotDefinitionXaxisArgs.builder()
                            .includeZero(true)
                            .label("x")
                            .max("2000")
                            .min("1")
                            .scale("pow")
                            .build())
                        .yaxis(DashboardWidgetScatterplotDefinitionYaxisArgs.builder()
                            .includeZero(false)
                            .label("y")
                            .max("2222")
                            .min("5")
                            .scale("log")
                            .build())
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .servicemapDefinition(DashboardWidgetServicemapDefinitionArgs.builder()
                        .filters(                        
                            "env:prod",
                            "datacenter:dc1")
                        .service("master-db")
                        .title("env: prod, datacenter:dc1, service: master-db")
                        .titleAlign("left")
                        .titleSize("16")
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .timeseriesDefinition(DashboardWidgetTimeseriesDefinitionArgs.builder()
                        .event(                        
                            %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
                            %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                        .legendSize("2")
                        .liveSpan("1h")
                        .marker(                        
                            %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
                            %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                        .request(                        
                            %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
                            %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
                            %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
                            %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                        .showLegend(true)
                        .title("Widget Title")
                        .yaxis(DashboardWidgetTimeseriesDefinitionYaxisArgs.builder()
                            .includeZero(false)
                            .max(100)
                            .scale("log")
                            .build())
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .toplistDefinition(DashboardWidgetToplistDefinitionArgs.builder()
                        .request(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                        .title("Widget Title")
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .groupDefinition(DashboardWidgetGroupDefinitionArgs.builder()
                        .layoutType("ordered")
                        .title("Group Widget")
                        .widget(                        
                            %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference),
                            %!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .serviceLevelObjectiveDefinition(DashboardWidgetServiceLevelObjectiveDefinitionArgs.builder()
                        .showErrorBudget(true)
                        .sloId("56789")
                        .timeWindows(                        
                            "7d",
                            "previous_week")
                        .title("Widget Title")
                        .viewMode("overall")
                        .viewType("detail")
                        .build())
                    .build())
            .build());

        var freeDashboard = new Dashboard("freeDashboard", DashboardArgs.builder()        
            .description("Created using the Datadog provider in Terraform")
            .isReadOnly(false)
            .layoutType("free")
            .templateVariables(            
                DashboardTemplateVariableArgs.builder()
                    .default_("aws")
                    .name("var_1")
                    .prefix("host")
                    .build(),
                DashboardTemplateVariableArgs.builder()
                    .default_("autoscaling")
                    .name("var_2")
                    .prefix("service_name")
                    .build())
            .templateVariablePresets(DashboardTemplateVariablePresetArgs.builder()
                .name("preset_1")
                .templateVariables(                
                    DashboardTemplateVariablePresetTemplateVariableArgs.builder()
                        .name("var_1")
                        .value("host.dc")
                        .build(),
                    DashboardTemplateVariablePresetTemplateVariableArgs.builder()
                        .name("var_2")
                        .value("my_service")
                        .build())
                .build())
            .title("Free Layout Dashboard")
            .widgets(            
                DashboardWidgetArgs.builder()
                    .eventStreamDefinition(DashboardWidgetEventStreamDefinitionArgs.builder()
                        .eventSize("l")
                        .liveSpan("1h")
                        .query("*")
                        .title("Widget Title")
                        .titleAlign("left")
                        .titleSize(16)
                        .build())
                    .widgetLayout(DashboardWidgetWidgetLayoutArgs.builder()
                        .height(43)
                        .width(32)
                        .x(0)
                        .y(0)
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .eventTimelineDefinition(DashboardWidgetEventTimelineDefinitionArgs.builder()
                        .liveSpan("1h")
                        .query("*")
                        .title("Widget Title")
                        .titleAlign("left")
                        .titleSize(16)
                        .build())
                    .widgetLayout(DashboardWidgetWidgetLayoutArgs.builder()
                        .height(9)
                        .width(66)
                        .x(33)
                        .y(60)
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .freeTextDefinition(DashboardWidgetFreeTextDefinitionArgs.builder()
                        .color("#d00")
                        .fontSize("36")
                        .text("free text content")
                        .textAlign("left")
                        .build())
                    .widgetLayout(DashboardWidgetWidgetLayoutArgs.builder()
                        .height(20)
                        .width(34)
                        .x(33)
                        .y(0)
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .iframeDefinition(DashboardWidgetIframeDefinitionArgs.builder()
                        .url("http://google.com")
                        .build())
                    .widgetLayout(DashboardWidgetWidgetLayoutArgs.builder()
                        .height(46)
                        .width(39)
                        .x(101)
                        .y(0)
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .imageDefinition(DashboardWidgetImageDefinitionArgs.builder()
                        .margin("small")
                        .sizing("fit")
                        .url("https://images.pexels.com/photos/67636/rose-blue-flower-rose-blooms-67636.jpeg?auto=compress&cs=tinysrgb&h=350")
                        .build())
                    .widgetLayout(DashboardWidgetWidgetLayoutArgs.builder()
                        .height(20)
                        .width(30)
                        .x(69)
                        .y(0)
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .logStreamDefinition(DashboardWidgetLogStreamDefinitionArgs.builder()
                        .columns(                        
                            "core_host",
                            "core_service",
                            "tag_source")
                        .indexes("main")
                        .messageDisplay("expanded-md")
                        .query("error")
                        .showDateColumn(true)
                        .showMessageColumn(true)
                        .sort(DashboardWidgetLogStreamDefinitionSortArgs.builder()
                            .column("time")
                            .order("desc")
                            .build())
                        .build())
                    .widgetLayout(DashboardWidgetWidgetLayoutArgs.builder()
                        .height(36)
                        .width(32)
                        .x(0)
                        .y(45)
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .manageStatusDefinition(DashboardWidgetManageStatusDefinitionArgs.builder()
                        .colorPreference("text")
                        .displayFormat("countsAndList")
                        .hideZeroCounts(true)
                        .query("type:metric")
                        .showLastTriggered(false)
                        .sort("status,asc")
                        .summaryType("monitors")
                        .title("Widget Title")
                        .titleAlign("left")
                        .titleSize(16)
                        .build())
                    .widgetLayout(DashboardWidgetWidgetLayoutArgs.builder()
                        .height(40)
                        .width(30)
                        .x(101)
                        .y(48)
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .traceServiceDefinition(DashboardWidgetTraceServiceDefinitionArgs.builder()
                        .displayFormat("three_column")
                        .env("datadog.com")
                        .liveSpan("1h")
                        .service("alerting-cassandra")
                        .showBreakdown(true)
                        .showDistribution(true)
                        .showErrors(true)
                        .showHits(true)
                        .showLatency(false)
                        .showResourceList(false)
                        .sizeFormat("large")
                        .spanName("cassandra.query")
                        .title("alerting-cassandra #env:datadog.com")
                        .titleAlign("center")
                        .titleSize("13")
                        .build())
                    .widgetLayout(DashboardWidgetWidgetLayoutArgs.builder()
                        .height(38)
                        .width(66)
                        .x(33)
                        .y(21)
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .timeseriesDefinition(DashboardWidgetTimeseriesDefinitionArgs.builder()
                        .request(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                        .build())
                    .widgetLayout(DashboardWidgetWidgetLayoutArgs.builder()
                        .height(16)
                        .width(25)
                        .x(58)
                        .y(83)
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .timeseriesDefinition(DashboardWidgetTimeseriesDefinitionArgs.builder()
                        .request(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                        .build())
                    .widgetLayout(DashboardWidgetWidgetLayoutArgs.builder()
                        .height(16)
                        .width(28)
                        .x(29)
                        .y(83)
                        .build())
                    .build(),
                DashboardWidgetArgs.builder()
                    .timeseriesDefinition(DashboardWidgetTimeseriesDefinitionArgs.builder()
                        .request(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
                        .build())
                    .widgetLayout(DashboardWidgetWidgetLayoutArgs.builder()
                        .height(16)
                        .width(28)
                        .x(0)
                        .y(83)
                        .build())
                    .build())
            .build());

    }
}

Coming soon!

Coming soon!

resources:
  # Example Ordered Layout
  orderedDashboard:
    type: datadog:Dashboard
    properties:
      description: Created using the Datadog provider in Terraform
      isReadOnly: true
      layoutType: ordered
      templateVariables:
        - default: aws
          name: var_1
          prefix: host
        - default: autoscaling
          name: var_2
          prefix: service_name
      templateVariablePresets:
        - name: preset_1
          templateVariables:
            - name: var_1
              value: host.dc
            - name: var_2
              value: my_service
      title: Ordered Layout Dashboard
      widgets:
        - alertGraphDefinition:
            alertId: '895605'
            liveSpan: 1h
            title: Widget Title
            vizType: timeseries
        - alertValueDefinition:
            alertId: '895605'
            precision: 3
            textAlign: center
            title: Widget Title
            unit: b
        - alertValueDefinition:
            alertId: '895605'
            precision: 3
            textAlign: center
            title: Widget Title
            unit: b
        - changeDefinition:
            liveSpan: 1h
            request:
              - changeType: absolute
                compareTo: week_before
                increaseGood: true
                orderBy: name
                orderDir: desc
                q: avg:system.load.1{env:staging} by {account}
                showPresent: true
            title: Widget Title
        - distributionDefinition:
            liveSpan: 1h
            request:
              - q: avg:system.load.1{env:staging} by {account}
                style:
                  palette: warm
            title: Widget Title
        - checkStatusDefinition:
            check: aws.ecs.agent_connected
            groupBy:
              - account
              - cluster
            grouping: cluster
            liveSpan: 1h
            tags:
              - account:demo
              - cluster:awseb-ruthebdog-env-8-dn3m6u3gvk
            title: Widget Title
        - heatmapDefinition:
            liveSpan: 1h
            request:
              - q: avg:system.load.1{env:staging} by {account}
                style:
                  palette: warm
            title: Widget Title
            yaxis:
              includeZero: true
              max: 2
              min: 1
              scale: sqrt
        - hostmapDefinition:
            group:
              - host
              - region
            noGroupHosts: true
            noMetricHosts: true
            nodeType: container
            request:
              fill:
                - q: avg:system.load.1{*} by {host}
              size:
                - q: avg:memcache.uptime{*} by {host}
            scope:
              - region:us-east-1
              - aws_account:727006795293
            style:
              fillMax: '20'
              fillMin: '10'
              palette: yellow_to_green
              paletteFlip: true
            title: Widget Title
        - noteDefinition:
            backgroundColor: pink
            content: note text
            fontSize: '14'
            showTick: true
            textAlign: center
            tickEdge: left
            tickPos: 50%
        - queryValueDefinition:
            autoscale: true
            customUnit: xx
            liveSpan: 1h
            precision: '4'
            request:
              - aggregator: sum
                conditionalFormats:
                  - comparator: <
                    palette: white_on_green
                    value: '2'
                  - comparator: '>'
                    palette: white_on_red
                    value: '2.2'
                q: avg:system.load.1{env:staging} by {account}
            textAlign: right
            title: Widget Title
        - queryTableDefinition:
            liveSpan: 1h
            request:
              - aggregator: sum
                conditionalFormats:
                  - comparator: <
                    palette: white_on_green
                    value: '2'
                  - comparator: '>'
                    palette: white_on_red
                    value: '2.2'
                limit: '10'
                q: avg:system.load.1{env:staging} by {account}
            title: Widget Title
        - scatterplotDefinition:
            colorByGroups:
              - account
              - apm-role-group
            liveSpan: 1h
            request:
              x:
                - aggregator: max
                  q: avg:system.cpu.user{*} by {service, account}
              y:
                - aggregator: min
                  q: avg:system.mem.used{*} by {service, account}
            title: Widget Title
            xaxis:
              includeZero: true
              label: x
              max: '2000'
              min: '1'
              scale: pow
            yaxis:
              includeZero: false
              label: y
              max: '2222'
              min: '5'
              scale: log
        - servicemapDefinition:
            filters:
              - env:prod
              - datacenter:dc1
            service: master-db
            title: 'env: prod, datacenter:dc1, service: master-db'
            titleAlign: left
            titleSize: '16'
        - timeseriesDefinition:
            event:
              - q: sources:test tags:1
              - q: sources:test tags:2
            legendSize: '2'
            liveSpan: 1h
            marker:
              - displayType: error dashed
                label: ' z=6 '
                value: y = 4
              - displayType: ok solid
                label: ' x=8 '
                value: 10 < y < 999
            request:
              - displayType: line
                metadata:
                  - aliasName: Alpha
                    expression: avg:system.cpu.user{app:general} by {env}
                q: avg:system.cpu.user{app:general} by {env}
                style:
                  lineType: dashed
                  lineWidth: thin
                  palette: warm
              - displayType: area
                logQuery:
                  computeQuery:
                    aggregation: avg
                    facet: '@duration'
                    interval: 5000
                  groupBy:
                    - facet: host
                      limit: 10
                      sortQuery:
                        aggregation: avg
                        facet: '@duration'
                        order: desc
                  index: mcnulty
                  searchQuery: status:info
              - apmQuery:
                  computeQuery:
                    aggregation: avg
                    facet: '@duration'
                    interval: 5000
                  groupBy:
                    - facet: resource_name
                      limit: 50
                      sortQuery:
                        aggregation: avg
                        facet: '@string_query.interval'
                        order: desc
                  index: apm-search
                  searchQuery: type:web
                displayType: bars
              - displayType: area
                processQuery:
                  filterBy:
                    - active
                  limit: 50
                  metric: process.stat.cpu.total_pct
                  searchBy: error
            showLegend: true
            title: Widget Title
            yaxis:
              includeZero: false
              max: 100
              scale: log
        - toplistDefinition:
            request:
              - conditionalFormats:
                  - comparator: <
                    palette: white_on_green
                    value: '2'
                  - comparator: '>'
                    palette: white_on_red
                    value: '2.2'
                q: avg:system.cpu.user{app:general} by {env}
            title: Widget Title
        - groupDefinition:
            layoutType: ordered
            title: Group Widget
            widget:
              - noteDefinition:
                  backgroundColor: pink
                  content: cluster note widget
                  fontSize: '14'
                  showTick: true
                  textAlign: center
                  tickEdge: left
                  tickPos: 50%
              - alertGraphDefinition:
                  alertId: '123'
                  liveSpan: 1h
                  title: Alert Graph
                  vizType: toplist
        - serviceLevelObjectiveDefinition:
            showErrorBudget: true
            sloId: '56789'
            timeWindows:
              - 7d
              - previous_week
            title: Widget Title
            viewMode: overall
            viewType: detail
  # Example Free Layout
  freeDashboard:
    type: datadog:Dashboard
    properties:
      description: Created using the Datadog provider in Terraform
      isReadOnly: false
      layoutType: free
      templateVariables:
        - default: aws
          name: var_1
          prefix: host
        - default: autoscaling
          name: var_2
          prefix: service_name
      templateVariablePresets:
        - name: preset_1
          templateVariables:
            - name: var_1
              value: host.dc
            - name: var_2
              value: my_service
      title: Free Layout Dashboard
      widgets:
        - eventStreamDefinition:
            eventSize: l
            liveSpan: 1h
            query: '*'
            title: Widget Title
            titleAlign: left
            titleSize: 16
          widgetLayout:
            height: 43
            width: 32
            x: 0
            y: 0
        - eventTimelineDefinition:
            liveSpan: 1h
            query: '*'
            title: Widget Title
            titleAlign: left
            titleSize: 16
          widgetLayout:
            height: 9
            width: 66
            x: 33
            y: 60
        - freeTextDefinition:
            color: '#d00'
            fontSize: '36'
            text: free text content
            textAlign: left
          widgetLayout:
            height: 20
            width: 34
            x: 33
            y: 0
        - iframeDefinition:
            url: http://google.com
          widgetLayout:
            height: 46
            width: 39
            x: 101
            y: 0
        - imageDefinition:
            margin: small
            sizing: fit
            url: https://images.pexels.com/photos/67636/rose-blue-flower-rose-blooms-67636.jpeg?auto=compress&cs=tinysrgb&h=350
          widgetLayout:
            height: 20
            width: 30
            x: 69
            y: 0
        - logStreamDefinition:
            columns:
              - core_host
              - core_service
              - tag_source
            indexes:
              - main
            messageDisplay: expanded-md
            query: error
            showDateColumn: true
            showMessageColumn: true
            sort:
              column: time
              order: desc
          widgetLayout:
            height: 36
            width: 32
            x: 0
            y: 45
        - manageStatusDefinition:
            colorPreference: text
            displayFormat: countsAndList
            hideZeroCounts: true
            query: type:metric
            showLastTriggered: false
            sort: status,asc
            summaryType: monitors
            title: Widget Title
            titleAlign: left
            titleSize: 16
          widgetLayout:
            height: 40
            width: 30
            x: 101
            y: 48
        - traceServiceDefinition:
            displayFormat: three_column
            env: datadog.com
            liveSpan: 1h
            service: alerting-cassandra
            showBreakdown: true
            showDistribution: true
            showErrors: true
            showHits: true
            showLatency: false
            showResourceList: false
            sizeFormat: large
            spanName: cassandra.query
            title: 'alerting-cassandra #env:datadog.com'
            titleAlign: center
            titleSize: '13'
          widgetLayout:
            height: 38
            width: 66
            x: 33
            y: 21
        - timeseriesDefinition:
            request:
              - formula:
                  - alias: my ff query
                    formulaExpression: my_query_1 + my_query_2
                  - alias: my second ff query
                    formulaExpression: my_query_1 * my_query_2
                    limit:
                      count: 5
                      order: desc
                query:
                  - metricQuery:
                      aggregator: sum
                      dataSource: metrics
                      name: my_query_1
                      query: avg:system.cpu.user{app:general} by {env}
                  - metricQuery:
                      aggregator: sum
                      name: my_query_2
                      query: avg:system.cpu.user{app:general} by {env}
          widgetLayout:
            height: 16
            width: 25
            x: 58
            y: 83
        - timeseriesDefinition:
            request:
              - query:
                  - eventQuery:
                      compute:
                        - aggregation: count
                      dataSource: logs
                      groupBy:
                        - facet: host
                          limit: 10
                          sort:
                            aggregation: avg
                            metric: '@lambda.max_memory_used'
                      indexes:
                        - days-3
                      name: my-query
          widgetLayout:
            height: 16
            width: 28
            x: 29
            y: 83
        - timeseriesDefinition:
            request:
              - query:
                  - processQuery:
                      aggregator: sum
                      dataSource: process
                      isNormalizedCpu: true
                      limit: 10
                      metric: process.stat.cpu.total_pct
                      name: my_process_query
                      sort: asc
                      tagFilters:
                        - some_filter
                      textFilter: abc
          widgetLayout:
            height: 16
            width: 28
            x: 0
            y: 83

Create Dashboard Resource

new Dashboard(name: string, args: DashboardArgs, opts?: CustomResourceOptions);
@overload
def Dashboard(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              dashboard_lists: Optional[Sequence[int]] = None,
              description: Optional[str] = None,
              is_read_only: Optional[bool] = None,
              layout_type: Optional[str] = None,
              notify_lists: Optional[Sequence[str]] = None,
              reflow_type: Optional[str] = None,
              restricted_roles: Optional[Sequence[str]] = None,
              template_variable_presets: Optional[Sequence[DashboardTemplateVariablePresetArgs]] = None,
              template_variables: Optional[Sequence[DashboardTemplateVariableArgs]] = None,
              title: Optional[str] = None,
              url: Optional[str] = None,
              widgets: Optional[Sequence[DashboardWidgetArgs]] = None)
@overload
def Dashboard(resource_name: str,
              args: DashboardArgs,
              opts: Optional[ResourceOptions] = 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: datadog:Dashboard
properties: # The arguments to resource properties.
options: # 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.
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.

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

The Dashboard resource accepts the following input properties:

LayoutType string

The layout type of the dashboard. Valid values are ordered, free.

Title string

The title of the dashboard.

DashboardLists List<int>

A list of dashboard lists this dashboard belongs to.

Description string

The description of the dashboard.

IsReadOnly bool

Whether this dashboard is read-only. Deprecated. Prefer using restricted_roles to define which roles are required to edit the dashboard.

Deprecated:

Prefer using restricted_roles to define which roles are required to edit the dashboard.

NotifyLists List<string>

The list of handles for the users to notify when changes are made to this dashboard.

ReflowType string

The reflow type of a new dashboard layout. Set this only when layout type is ordered. If set to fixed, the dashboard expects all widgets to have a layout, and if it's set to auto, widgets should not have layouts. Valid values are auto, fixed.

RestrictedRoles List<string>

UUIDs of roles whose associated users are authorized to edit the dashboard.

TemplateVariablePresets List<DashboardTemplateVariablePresetArgs>

The list of selectable template variable presets for this dashboard.

TemplateVariables List<DashboardTemplateVariableArgs>

The list of template variables for this dashboard.

Url string

The URL of the dashboard.

Widgets List<DashboardWidgetArgs>

The list of widgets to display on the dashboard.

LayoutType string

The layout type of the dashboard. Valid values are ordered, free.

Title string

The title of the dashboard.

DashboardLists []int

A list of dashboard lists this dashboard belongs to.

Description string

The description of the dashboard.

IsReadOnly bool

Whether this dashboard is read-only. Deprecated. Prefer using restricted_roles to define which roles are required to edit the dashboard.

Deprecated:

Prefer using restricted_roles to define which roles are required to edit the dashboard.

NotifyLists []string

The list of handles for the users to notify when changes are made to this dashboard.

ReflowType string

The reflow type of a new dashboard layout. Set this only when layout type is ordered. If set to fixed, the dashboard expects all widgets to have a layout, and if it's set to auto, widgets should not have layouts. Valid values are auto, fixed.

RestrictedRoles []string

UUIDs of roles whose associated users are authorized to edit the dashboard.

TemplateVariablePresets []DashboardTemplateVariablePresetArgs

The list of selectable template variable presets for this dashboard.

TemplateVariables []DashboardTemplateVariableArgs

The list of template variables for this dashboard.

Url string

The URL of the dashboard.

Widgets []DashboardWidgetArgs

The list of widgets to display on the dashboard.

layoutType String

The layout type of the dashboard. Valid values are ordered, free.

title String

The title of the dashboard.

dashboardLists List<Integer>

A list of dashboard lists this dashboard belongs to.

description String

The description of the dashboard.

isReadOnly Boolean

Whether this dashboard is read-only. Deprecated. Prefer using restricted_roles to define which roles are required to edit the dashboard.

Deprecated:

Prefer using restricted_roles to define which roles are required to edit the dashboard.

notifyLists List<String>

The list of handles for the users to notify when changes are made to this dashboard.

reflowType String

The reflow type of a new dashboard layout. Set this only when layout type is ordered. If set to fixed, the dashboard expects all widgets to have a layout, and if it's set to auto, widgets should not have layouts. Valid values are auto, fixed.

restrictedRoles List<String>

UUIDs of roles whose associated users are authorized to edit the dashboard.

templateVariablePresets List<DashboardTemplateVariablePresetArgs>

The list of selectable template variable presets for this dashboard.

templateVariables List<DashboardTemplateVariableArgs>

The list of template variables for this dashboard.

url String

The URL of the dashboard.

widgets List<DashboardWidgetArgs>

The list of widgets to display on the dashboard.

layoutType string

The layout type of the dashboard. Valid values are ordered, free.

title string

The title of the dashboard.

dashboardLists number[]

A list of dashboard lists this dashboard belongs to.

description string

The description of the dashboard.

isReadOnly boolean

Whether this dashboard is read-only. Deprecated. Prefer using restricted_roles to define which roles are required to edit the dashboard.

Deprecated:

Prefer using restricted_roles to define which roles are required to edit the dashboard.

notifyLists string[]

The list of handles for the users to notify when changes are made to this dashboard.

reflowType string

The reflow type of a new dashboard layout. Set this only when layout type is ordered. If set to fixed, the dashboard expects all widgets to have a layout, and if it's set to auto, widgets should not have layouts. Valid values are auto, fixed.

restrictedRoles string[]

UUIDs of roles whose associated users are authorized to edit the dashboard.

templateVariablePresets DashboardTemplateVariablePresetArgs[]

The list of selectable template variable presets for this dashboard.

templateVariables DashboardTemplateVariableArgs[]

The list of template variables for this dashboard.

url string

The URL of the dashboard.

widgets DashboardWidgetArgs[]

The list of widgets to display on the dashboard.

layout_type str

The layout type of the dashboard. Valid values are ordered, free.

title str

The title of the dashboard.

dashboard_lists Sequence[int]

A list of dashboard lists this dashboard belongs to.

description str

The description of the dashboard.

is_read_only bool

Whether this dashboard is read-only. Deprecated. Prefer using restricted_roles to define which roles are required to edit the dashboard.

Deprecated:

Prefer using restricted_roles to define which roles are required to edit the dashboard.

notify_lists Sequence[str]

The list of handles for the users to notify when changes are made to this dashboard.

reflow_type str

The reflow type of a new dashboard layout. Set this only when layout type is ordered. If set to fixed, the dashboard expects all widgets to have a layout, and if it's set to auto, widgets should not have layouts. Valid values are auto, fixed.

restricted_roles Sequence[str]

UUIDs of roles whose associated users are authorized to edit the dashboard.

template_variable_presets Sequence[DashboardTemplateVariablePresetArgs]

The list of selectable template variable presets for this dashboard.

template_variables Sequence[DashboardTemplateVariableArgs]

The list of template variables for this dashboard.

url str

The URL of the dashboard.

widgets Sequence[DashboardWidgetArgs]

The list of widgets to display on the dashboard.

layoutType String

The layout type of the dashboard. Valid values are ordered, free.

title String

The title of the dashboard.

dashboardLists List<Number>

A list of dashboard lists this dashboard belongs to.

description String

The description of the dashboard.

isReadOnly Boolean

Whether this dashboard is read-only. Deprecated. Prefer using restricted_roles to define which roles are required to edit the dashboard.

Deprecated:

Prefer using restricted_roles to define which roles are required to edit the dashboard.

notifyLists List<String>

The list of handles for the users to notify when changes are made to this dashboard.

reflowType String

The reflow type of a new dashboard layout. Set this only when layout type is ordered. If set to fixed, the dashboard expects all widgets to have a layout, and if it's set to auto, widgets should not have layouts. Valid values are auto, fixed.

restrictedRoles List<String>

UUIDs of roles whose associated users are authorized to edit the dashboard.

templateVariablePresets List<Property Map>

The list of selectable template variable presets for this dashboard.

templateVariables List<Property Map>

The list of template variables for this dashboard.

url String

The URL of the dashboard.

widgets List<Property Map>

The list of widgets to display on the dashboard.

Outputs

All input properties are implicitly available as output properties. Additionally, the Dashboard resource produces the following output properties:

DashboardListsRemoveds List<int>

A list of dashboard lists this dashboard should be removed from. Internal only.

Id string

The provider-assigned unique ID for this managed resource.

DashboardListsRemoveds []int

A list of dashboard lists this dashboard should be removed from. Internal only.

Id string

The provider-assigned unique ID for this managed resource.

dashboardListsRemoveds List<Integer>

A list of dashboard lists this dashboard should be removed from. Internal only.

id String

The provider-assigned unique ID for this managed resource.

dashboardListsRemoveds number[]

A list of dashboard lists this dashboard should be removed from. Internal only.

id string

The provider-assigned unique ID for this managed resource.

dashboard_lists_removeds Sequence[int]

A list of dashboard lists this dashboard should be removed from. Internal only.

id str

The provider-assigned unique ID for this managed resource.

dashboardListsRemoveds List<Number>

A list of dashboard lists this dashboard should be removed from. Internal only.

id String

The provider-assigned unique ID for this managed resource.

Look up Existing Dashboard Resource

Get an existing Dashboard resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: DashboardState, opts?: CustomResourceOptions): Dashboard
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        dashboard_lists: Optional[Sequence[int]] = None,
        dashboard_lists_removeds: Optional[Sequence[int]] = None,
        description: Optional[str] = None,
        is_read_only: Optional[bool] = None,
        layout_type: Optional[str] = None,
        notify_lists: Optional[Sequence[str]] = None,
        reflow_type: Optional[str] = None,
        restricted_roles: Optional[Sequence[str]] = None,
        template_variable_presets: Optional[Sequence[DashboardTemplateVariablePresetArgs]] = None,
        template_variables: Optional[Sequence[DashboardTemplateVariableArgs]] = None,
        title: Optional[str] = None,
        url: Optional[str] = None,
        widgets: Optional[Sequence[DashboardWidgetArgs]] = 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)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
DashboardLists List<int>

A list of dashboard lists this dashboard belongs to.

DashboardListsRemoveds List<int>

A list of dashboard lists this dashboard should be removed from. Internal only.

Description string

The description of the dashboard.

IsReadOnly bool

Whether this dashboard is read-only. Deprecated. Prefer using restricted_roles to define which roles are required to edit the dashboard.

Deprecated:

Prefer using restricted_roles to define which roles are required to edit the dashboard.

LayoutType string

The layout type of the dashboard. Valid values are ordered, free.

NotifyLists List<string>

The list of handles for the users to notify when changes are made to this dashboard.

ReflowType string

The reflow type of a new dashboard layout. Set this only when layout type is ordered. If set to fixed, the dashboard expects all widgets to have a layout, and if it's set to auto, widgets should not have layouts. Valid values are auto, fixed.

RestrictedRoles List<string>

UUIDs of roles whose associated users are authorized to edit the dashboard.

TemplateVariablePresets List<DashboardTemplateVariablePresetArgs>

The list of selectable template variable presets for this dashboard.

TemplateVariables List<DashboardTemplateVariableArgs>

The list of template variables for this dashboard.

Title string

The title of the dashboard.

Url string

The URL of the dashboard.

Widgets List<DashboardWidgetArgs>

The list of widgets to display on the dashboard.

DashboardLists []int

A list of dashboard lists this dashboard belongs to.

DashboardListsRemoveds []int

A list of dashboard lists this dashboard should be removed from. Internal only.

Description string

The description of the dashboard.

IsReadOnly bool

Whether this dashboard is read-only. Deprecated. Prefer using restricted_roles to define which roles are required to edit the dashboard.

Deprecated:

Prefer using restricted_roles to define which roles are required to edit the dashboard.

LayoutType string

The layout type of the dashboard. Valid values are ordered, free.

NotifyLists []string

The list of handles for the users to notify when changes are made to this dashboard.

ReflowType string

The reflow type of a new dashboard layout. Set this only when layout type is ordered. If set to fixed, the dashboard expects all widgets to have a layout, and if it's set to auto, widgets should not have layouts. Valid values are auto, fixed.

RestrictedRoles []string

UUIDs of roles whose associated users are authorized to edit the dashboard.

TemplateVariablePresets []DashboardTemplateVariablePresetArgs

The list of selectable template variable presets for this dashboard.

TemplateVariables []DashboardTemplateVariableArgs

The list of template variables for this dashboard.

Title string

The title of the dashboard.

Url string

The URL of the dashboard.

Widgets []DashboardWidgetArgs

The list of widgets to display on the dashboard.

dashboardLists List<Integer>

A list of dashboard lists this dashboard belongs to.

dashboardListsRemoveds List<Integer>

A list of dashboard lists this dashboard should be removed from. Internal only.

description String

The description of the dashboard.

isReadOnly Boolean

Whether this dashboard is read-only. Deprecated. Prefer using restricted_roles to define which roles are required to edit the dashboard.

Deprecated:

Prefer using restricted_roles to define which roles are required to edit the dashboard.

layoutType String

The layout type of the dashboard. Valid values are ordered, free.

notifyLists List<String>

The list of handles for the users to notify when changes are made to this dashboard.

reflowType String

The reflow type of a new dashboard layout. Set this only when layout type is ordered. If set to fixed, the dashboard expects all widgets to have a layout, and if it's set to auto, widgets should not have layouts. Valid values are auto, fixed.

restrictedRoles List<String>

UUIDs of roles whose associated users are authorized to edit the dashboard.

templateVariablePresets List<DashboardTemplateVariablePresetArgs>

The list of selectable template variable presets for this dashboard.

templateVariables List<DashboardTemplateVariableArgs>

The list of template variables for this dashboard.

title String

The title of the dashboard.

url String

The URL of the dashboard.

widgets List<DashboardWidgetArgs>

The list of widgets to display on the dashboard.

dashboardLists number[]

A list of dashboard lists this dashboard belongs to.

dashboardListsRemoveds number[]

A list of dashboard lists this dashboard should be removed from. Internal only.

description string

The description of the dashboard.

isReadOnly boolean

Whether this dashboard is read-only. Deprecated. Prefer using restricted_roles to define which roles are required to edit the dashboard.

Deprecated:

Prefer using restricted_roles to define which roles are required to edit the dashboard.

layoutType string

The layout type of the dashboard. Valid values are ordered, free.

notifyLists string[]

The list of handles for the users to notify when changes are made to this dashboard.

reflowType string

The reflow type of a new dashboard layout. Set this only when layout type is ordered. If set to fixed, the dashboard expects all widgets to have a layout, and if it's set to auto, widgets should not have layouts. Valid values are auto, fixed.

restrictedRoles string[]

UUIDs of roles whose associated users are authorized to edit the dashboard.

templateVariablePresets DashboardTemplateVariablePresetArgs[]

The list of selectable template variable presets for this dashboard.

templateVariables DashboardTemplateVariableArgs[]

The list of template variables for this dashboard.

title string

The title of the dashboard.

url string

The URL of the dashboard.

widgets DashboardWidgetArgs[]

The list of widgets to display on the dashboard.

dashboard_lists Sequence[int]

A list of dashboard lists this dashboard belongs to.

dashboard_lists_removeds Sequence[int]

A list of dashboard lists this dashboard should be removed from. Internal only.

description str

The description of the dashboard.

is_read_only bool

Whether this dashboard is read-only. Deprecated. Prefer using restricted_roles to define which roles are required to edit the dashboard.

Deprecated:

Prefer using restricted_roles to define which roles are required to edit the dashboard.

layout_type str

The layout type of the dashboard. Valid values are ordered, free.

notify_lists Sequence[str]

The list of handles for the users to notify when changes are made to this dashboard.

reflow_type str

The reflow type of a new dashboard layout. Set this only when layout type is ordered. If set to fixed, the dashboard expects all widgets to have a layout, and if it's set to auto, widgets should not have layouts. Valid values are auto, fixed.

restricted_roles Sequence[str]

UUIDs of roles whose associated users are authorized to edit the dashboard.

template_variable_presets Sequence[DashboardTemplateVariablePresetArgs]

The list of selectable template variable presets for this dashboard.

template_variables Sequence[DashboardTemplateVariableArgs]

The list of template variables for this dashboard.

title str

The title of the dashboard.

url str

The URL of the dashboard.

widgets Sequence[DashboardWidgetArgs]

The list of widgets to display on the dashboard.

dashboardLists List<Number>

A list of dashboard lists this dashboard belongs to.

dashboardListsRemoveds List<Number>

A list of dashboard lists this dashboard should be removed from. Internal only.

description String

The description of the dashboard.

isReadOnly Boolean

Whether this dashboard is read-only. Deprecated. Prefer using restricted_roles to define which roles are required to edit the dashboard.

Deprecated:

Prefer using restricted_roles to define which roles are required to edit the dashboard.

layoutType String

The layout type of the dashboard. Valid values are ordered, free.

notifyLists List<String>

The list of handles for the users to notify when changes are made to this dashboard.

reflowType String

The reflow type of a new dashboard layout. Set this only when layout type is ordered. If set to fixed, the dashboard expects all widgets to have a layout, and if it's set to auto, widgets should not have layouts. Valid values are auto, fixed.

restrictedRoles List<String>

UUIDs of roles whose associated users are authorized to edit the dashboard.

templateVariablePresets List<Property Map>

The list of selectable template variable presets for this dashboard.

templateVariables List<Property Map>

The list of template variables for this dashboard.

title String

The title of the dashboard.

url String

The URL of the dashboard.

widgets List<Property Map>

The list of widgets to display on the dashboard.

Supporting Types

Note: There are over 200 nested types for this resource. Only the first 200 types are included in this documentation.

DashboardTemplateVariable

Name string

The name of the variable.

AvailableValues List<string>

The list of values that the template variable drop-down is be limited to

Default string

The default value for the template variable on dashboard load. Cannot be used in conjunction with defaults. Deprecated. Use defaults instead.

Deprecated:

Use defaults instead.

Defaults List<string>

One or many default values for template variables on load. If more than one default is specified, they will be unioned together with OR. Cannot be used in conjunction with default.

Prefix string

The tag prefix associated with the variable. Only tags with this prefix appear in the variable dropdown.

Name string

The name of the variable.

AvailableValues []string

The list of values that the template variable drop-down is be limited to

Default string

The default value for the template variable on dashboard load. Cannot be used in conjunction with defaults. Deprecated. Use defaults instead.

Deprecated:

Use defaults instead.

Defaults []string

One or many default values for template variables on load. If more than one default is specified, they will be unioned together with OR. Cannot be used in conjunction with default.

Prefix string

The tag prefix associated with the variable. Only tags with this prefix appear in the variable dropdown.

name String

The name of the variable.

availableValues List<String>

The list of values that the template variable drop-down is be limited to

default_ String

The default value for the template variable on dashboard load. Cannot be used in conjunction with defaults. Deprecated. Use defaults instead.

Deprecated:

Use defaults instead.

defaults List<String>

One or many default values for template variables on load. If more than one default is specified, they will be unioned together with OR. Cannot be used in conjunction with default.

prefix String

The tag prefix associated with the variable. Only tags with this prefix appear in the variable dropdown.

name string

The name of the variable.

availableValues string[]

The list of values that the template variable drop-down is be limited to

default string

The default value for the template variable on dashboard load. Cannot be used in conjunction with defaults. Deprecated. Use defaults instead.

Deprecated:

Use defaults instead.

defaults string[]

One or many default values for template variables on load. If more than one default is specified, they will be unioned together with OR. Cannot be used in conjunction with default.

prefix string

The tag prefix associated with the variable. Only tags with this prefix appear in the variable dropdown.

name str

The name of the variable.

available_values Sequence[str]

The list of values that the template variable drop-down is be limited to

default str

The default value for the template variable on dashboard load. Cannot be used in conjunction with defaults. Deprecated. Use defaults instead.

Deprecated:

Use defaults instead.

defaults Sequence[str]

One or many default values for template variables on load. If more than one default is specified, they will be unioned together with OR. Cannot be used in conjunction with default.

prefix str

The tag prefix associated with the variable. Only tags with this prefix appear in the variable dropdown.

name String

The name of the variable.

availableValues List<String>

The list of values that the template variable drop-down is be limited to

default String

The default value for the template variable on dashboard load. Cannot be used in conjunction with defaults. Deprecated. Use defaults instead.

Deprecated:

Use defaults instead.

defaults List<String>

One or many default values for template variables on load. If more than one default is specified, they will be unioned together with OR. Cannot be used in conjunction with default.

prefix String

The tag prefix associated with the variable. Only tags with this prefix appear in the variable dropdown.

DashboardTemplateVariablePreset

Name string

The name of the preset.

TemplateVariables List<DashboardTemplateVariablePresetTemplateVariable>

The template variable names and assumed values under the given preset

Name string

The name of the preset.

TemplateVariables []DashboardTemplateVariablePresetTemplateVariable

The template variable names and assumed values under the given preset

name String

The name of the preset.

templateVariables List<DashboardTemplateVariablePresetTemplateVariable>

The template variable names and assumed values under the given preset

name string

The name of the preset.

templateVariables DashboardTemplateVariablePresetTemplateVariable[]

The template variable names and assumed values under the given preset

name str

The name of the preset.

template_variables Sequence[DashboardTemplateVariablePresetTemplateVariable]

The template variable names and assumed values under the given preset

name String

The name of the preset.

templateVariables List<Property Map>

The template variable names and assumed values under the given preset

DashboardTemplateVariablePresetTemplateVariable

Name string

The name of the variable.

Value string

Deprecated:

Use values instead.

Values List<string>
Name string

The name of the variable.

Value string

Deprecated:

Use values instead.

Values []string
name String

The name of the variable.

value String

Deprecated:

Use values instead.

values List<String>
name string

The name of the variable.

value string

Deprecated:

Use values instead.

values string[]
name str

The name of the variable.

value str

Deprecated:

Use values instead.

values Sequence[str]
name String

The name of the variable.

value String

Deprecated:

Use values instead.

values List<String>

DashboardWidget

AlertGraphDefinition DashboardWidgetAlertGraphDefinition

The definition for a Alert Graph widget.

AlertValueDefinition DashboardWidgetAlertValueDefinition

The definition for a Alert Value widget.

ChangeDefinition DashboardWidgetChangeDefinition

The definition for a Change widget.

CheckStatusDefinition DashboardWidgetCheckStatusDefinition

The definition for a Check Status widget.

DistributionDefinition DashboardWidgetDistributionDefinition

The definition for a Distribution widget.

EventStreamDefinition DashboardWidgetEventStreamDefinition

The definition for a Event Stream widget.

EventTimelineDefinition DashboardWidgetEventTimelineDefinition

The definition for a Event Timeline widget.

FreeTextDefinition DashboardWidgetFreeTextDefinition

The definition for a Free Text widget.

GeomapDefinition DashboardWidgetGeomapDefinition

The definition for a Geomap widget.

GroupDefinition DashboardWidgetGroupDefinition

The definition for a Group widget.

HeatmapDefinition DashboardWidgetHeatmapDefinition

The definition for a Heatmap widget.

HostmapDefinition DashboardWidgetHostmapDefinition

The definition for a Hostmap widget.

Id int

The ID of the widget.

IframeDefinition DashboardWidgetIframeDefinition

The definition for an Iframe widget.

ImageDefinition DashboardWidgetImageDefinition

The definition for an Image widget

ListStreamDefinition DashboardWidgetListStreamDefinition

The definition for a List Stream widget.

LogStreamDefinition DashboardWidgetLogStreamDefinition

The definition for an Log Stream widget.

ManageStatusDefinition DashboardWidgetManageStatusDefinition

The definition for an Manage Status widget.

NoteDefinition DashboardWidgetNoteDefinition

The definition for a Note widget.

QueryTableDefinition DashboardWidgetQueryTableDefinition

The definition for a Query Table widget.

QueryValueDefinition DashboardWidgetQueryValueDefinition

The definition for a Query Value widget.

RunWorkflowDefinition DashboardWidgetRunWorkflowDefinition

The definition for a Run Workflow widget. NOTE: Currently in private beta. To request access, contact Support at support@datadoghq.com.

ScatterplotDefinition DashboardWidgetScatterplotDefinition

The definition for a Scatterplot widget.

ServiceLevelObjectiveDefinition DashboardWidgetServiceLevelObjectiveDefinition

The definition for a Service Level Objective widget.

ServicemapDefinition DashboardWidgetServicemapDefinition

The definition for a Service Map widget.

SloListDefinition DashboardWidgetSloListDefinition

The definition for an SLO (Service Level Objective) List widget.

SunburstDefinition DashboardWidgetSunburstDefinition

The definition for a Sunburst widget.

TimeseriesDefinition DashboardWidgetTimeseriesDefinition

The definition for a Timeseries widget.

ToplistDefinition DashboardWidgetToplistDefinition

The definition for a Toplist widget.

TopologyMapDefinition DashboardWidgetTopologyMapDefinition

The definition for a Topology Map widget.

TraceServiceDefinition DashboardWidgetTraceServiceDefinition

The definition for a Trace Service widget.

TreemapDefinition DashboardWidgetTreemapDefinition

The definition for a Treemap widget.

WidgetLayout DashboardWidgetWidgetLayout

The layout of the widget on a 'free' dashboard.

AlertGraphDefinition DashboardWidgetAlertGraphDefinition

The definition for a Alert Graph widget.

AlertValueDefinition DashboardWidgetAlertValueDefinition

The definition for a Alert Value widget.

ChangeDefinition DashboardWidgetChangeDefinition

The definition for a Change widget.

CheckStatusDefinition DashboardWidgetCheckStatusDefinition

The definition for a Check Status widget.

DistributionDefinition DashboardWidgetDistributionDefinition

The definition for a Distribution widget.

EventStreamDefinition DashboardWidgetEventStreamDefinition

The definition for a Event Stream widget.

EventTimelineDefinition DashboardWidgetEventTimelineDefinition

The definition for a Event Timeline widget.

FreeTextDefinition DashboardWidgetFreeTextDefinition

The definition for a Free Text widget.

GeomapDefinition DashboardWidgetGeomapDefinition

The definition for a Geomap widget.

GroupDefinition DashboardWidgetGroupDefinition

The definition for a Group widget.

HeatmapDefinition DashboardWidgetHeatmapDefinition

The definition for a Heatmap widget.

HostmapDefinition DashboardWidgetHostmapDefinition

The definition for a Hostmap widget.

Id int

The ID of the widget.

IframeDefinition DashboardWidgetIframeDefinition

The definition for an Iframe widget.

ImageDefinition DashboardWidgetImageDefinition

The definition for an Image widget

ListStreamDefinition DashboardWidgetListStreamDefinition

The definition for a List Stream widget.

LogStreamDefinition DashboardWidgetLogStreamDefinition

The definition for an Log Stream widget.

ManageStatusDefinition DashboardWidgetManageStatusDefinition

The definition for an Manage Status widget.

NoteDefinition DashboardWidgetNoteDefinition

The definition for a Note widget.

QueryTableDefinition DashboardWidgetQueryTableDefinition

The definition for a Query Table widget.

QueryValueDefinition DashboardWidgetQueryValueDefinition

The definition for a Query Value widget.

RunWorkflowDefinition DashboardWidgetRunWorkflowDefinition

The definition for a Run Workflow widget. NOTE: Currently in private beta. To request access, contact Support at support@datadoghq.com.

ScatterplotDefinition DashboardWidgetScatterplotDefinition

The definition for a Scatterplot widget.

ServiceLevelObjectiveDefinition DashboardWidgetServiceLevelObjectiveDefinition

The definition for a Service Level Objective widget.

ServicemapDefinition DashboardWidgetServicemapDefinition

The definition for a Service Map widget.

SloListDefinition DashboardWidgetSloListDefinition

The definition for an SLO (Service Level Objective) List widget.

SunburstDefinition DashboardWidgetSunburstDefinition

The definition for a Sunburst widget.

TimeseriesDefinition DashboardWidgetTimeseriesDefinition

The definition for a Timeseries widget.

ToplistDefinition DashboardWidgetToplistDefinition

The definition for a Toplist widget.

TopologyMapDefinition DashboardWidgetTopologyMapDefinition

The definition for a Topology Map widget.

TraceServiceDefinition DashboardWidgetTraceServiceDefinition

The definition for a Trace Service widget.

TreemapDefinition DashboardWidgetTreemapDefinition

The definition for a Treemap widget.

WidgetLayout DashboardWidgetWidgetLayout

The layout of the widget on a 'free' dashboard.

alertGraphDefinition DashboardWidgetAlertGraphDefinition

The definition for a Alert Graph widget.

alertValueDefinition DashboardWidgetAlertValueDefinition

The definition for a Alert Value widget.

changeDefinition DashboardWidgetChangeDefinition

The definition for a Change widget.

checkStatusDefinition DashboardWidgetCheckStatusDefinition

The definition for a Check Status widget.

distributionDefinition DashboardWidgetDistributionDefinition

The definition for a Distribution widget.

eventStreamDefinition DashboardWidgetEventStreamDefinition

The definition for a Event Stream widget.

eventTimelineDefinition DashboardWidgetEventTimelineDefinition

The definition for a Event Timeline widget.

freeTextDefinition DashboardWidgetFreeTextDefinition

The definition for a Free Text widget.

geomapDefinition DashboardWidgetGeomapDefinition

The definition for a Geomap widget.

groupDefinition DashboardWidgetGroupDefinition

The definition for a Group widget.

heatmapDefinition DashboardWidgetHeatmapDefinition

The definition for a Heatmap widget.

hostmapDefinition DashboardWidgetHostmapDefinition

The definition for a Hostmap widget.

id Integer

The ID of the widget.

iframeDefinition DashboardWidgetIframeDefinition

The definition for an Iframe widget.

imageDefinition DashboardWidgetImageDefinition

The definition for an Image widget

listStreamDefinition DashboardWidgetListStreamDefinition

The definition for a List Stream widget.

logStreamDefinition DashboardWidgetLogStreamDefinition

The definition for an Log Stream widget.

manageStatusDefinition DashboardWidgetManageStatusDefinition

The definition for an Manage Status widget.

noteDefinition DashboardWidgetNoteDefinition

The definition for a Note widget.

queryTableDefinition DashboardWidgetQueryTableDefinition

The definition for a Query Table widget.

queryValueDefinition DashboardWidgetQueryValueDefinition

The definition for a Query Value widget.

runWorkflowDefinition DashboardWidgetRunWorkflowDefinition

The definition for a Run Workflow widget. NOTE: Currently in private beta. To request access, contact Support at support@datadoghq.com.

scatterplotDefinition DashboardWidgetScatterplotDefinition

The definition for a Scatterplot widget.

serviceLevelObjectiveDefinition DashboardWidgetServiceLevelObjectiveDefinition

The definition for a Service Level Objective widget.

servicemapDefinition DashboardWidgetServicemapDefinition

The definition for a Service Map widget.

sloListDefinition DashboardWidgetSloListDefinition

The definition for an SLO (Service Level Objective) List widget.

sunburstDefinition DashboardWidgetSunburstDefinition

The definition for a Sunburst widget.

timeseriesDefinition DashboardWidgetTimeseriesDefinition

The definition for a Timeseries widget.

toplistDefinition DashboardWidgetToplistDefinition

The definition for a Toplist widget.

topologyMapDefinition DashboardWidgetTopologyMapDefinition

The definition for a Topology Map widget.

traceServiceDefinition DashboardWidgetTraceServiceDefinition

The definition for a Trace Service widget.

treemapDefinition DashboardWidgetTreemapDefinition

The definition for a Treemap widget.

widgetLayout DashboardWidgetWidgetLayout

The layout of the widget on a 'free' dashboard.

alertGraphDefinition DashboardWidgetAlertGraphDefinition

The definition for a Alert Graph widget.

alertValueDefinition DashboardWidgetAlertValueDefinition

The definition for a Alert Value widget.

changeDefinition DashboardWidgetChangeDefinition

The definition for a Change widget.

checkStatusDefinition DashboardWidgetCheckStatusDefinition

The definition for a Check Status widget.

distributionDefinition DashboardWidgetDistributionDefinition

The definition for a Distribution widget.

eventStreamDefinition DashboardWidgetEventStreamDefinition

The definition for a Event Stream widget.

eventTimelineDefinition DashboardWidgetEventTimelineDefinition

The definition for a Event Timeline widget.

freeTextDefinition DashboardWidgetFreeTextDefinition

The definition for a Free Text widget.

geomapDefinition DashboardWidgetGeomapDefinition

The definition for a Geomap widget.

groupDefinition DashboardWidgetGroupDefinition

The definition for a Group widget.

heatmapDefinition DashboardWidgetHeatmapDefinition

The definition for a Heatmap widget.

hostmapDefinition DashboardWidgetHostmapDefinition

The definition for a Hostmap widget.

id number

The ID of the widget.

iframeDefinition DashboardWidgetIframeDefinition

The definition for an Iframe widget.

imageDefinition DashboardWidgetImageDefinition

The definition for an Image widget

listStreamDefinition DashboardWidgetListStreamDefinition

The definition for a List Stream widget.

logStreamDefinition DashboardWidgetLogStreamDefinition

The definition for an Log Stream widget.

manageStatusDefinition DashboardWidgetManageStatusDefinition

The definition for an Manage Status widget.

noteDefinition DashboardWidgetNoteDefinition

The definition for a Note widget.

queryTableDefinition DashboardWidgetQueryTableDefinition

The definition for a Query Table widget.

queryValueDefinition DashboardWidgetQueryValueDefinition

The definition for a Query Value widget.

runWorkflowDefinition DashboardWidgetRunWorkflowDefinition

The definition for a Run Workflow widget. NOTE: Currently in private beta. To request access, contact Support at support@datadoghq.com.

scatterplotDefinition DashboardWidgetScatterplotDefinition

The definition for a Scatterplot widget.

serviceLevelObjectiveDefinition DashboardWidgetServiceLevelObjectiveDefinition

The definition for a Service Level Objective widget.

servicemapDefinition DashboardWidgetServicemapDefinition

The definition for a Service Map widget.

sloListDefinition DashboardWidgetSloListDefinition

The definition for an SLO (Service Level Objective) List widget.

sunburstDefinition DashboardWidgetSunburstDefinition

The definition for a Sunburst widget.

timeseriesDefinition DashboardWidgetTimeseriesDefinition

The definition for a Timeseries widget.

toplistDefinition DashboardWidgetToplistDefinition

The definition for a Toplist widget.

topologyMapDefinition DashboardWidgetTopologyMapDefinition

The definition for a Topology Map widget.

traceServiceDefinition DashboardWidgetTraceServiceDefinition

The definition for a Trace Service widget.

treemapDefinition DashboardWidgetTreemapDefinition

The definition for a Treemap widget.

widgetLayout DashboardWidgetWidgetLayout

The layout of the widget on a 'free' dashboard.

alert_graph_definition DashboardWidgetAlertGraphDefinition

The definition for a Alert Graph widget.

alert_value_definition DashboardWidgetAlertValueDefinition

The definition for a Alert Value widget.

change_definition DashboardWidgetChangeDefinition

The definition for a Change widget.

check_status_definition DashboardWidgetCheckStatusDefinition

The definition for a Check Status widget.

distribution_definition DashboardWidgetDistributionDefinition

The definition for a Distribution widget.

event_stream_definition DashboardWidgetEventStreamDefinition

The definition for a Event Stream widget.

event_timeline_definition DashboardWidgetEventTimelineDefinition

The definition for a Event Timeline widget.

free_text_definition DashboardWidgetFreeTextDefinition

The definition for a Free Text widget.

geomap_definition DashboardWidgetGeomapDefinition

The definition for a Geomap widget.

group_definition DashboardWidgetGroupDefinition

The definition for a Group widget.

heatmap_definition DashboardWidgetHeatmapDefinition

The definition for a Heatmap widget.

hostmap_definition DashboardWidgetHostmapDefinition

The definition for a Hostmap widget.

id int

The ID of the widget.

iframe_definition DashboardWidgetIframeDefinition

The definition for an Iframe widget.

image_definition DashboardWidgetImageDefinition

The definition for an Image widget

list_stream_definition DashboardWidgetListStreamDefinition

The definition for a List Stream widget.

log_stream_definition DashboardWidgetLogStreamDefinition

The definition for an Log Stream widget.

manage_status_definition DashboardWidgetManageStatusDefinition

The definition for an Manage Status widget.

note_definition DashboardWidgetNoteDefinition

The definition for a Note widget.

query_table_definition DashboardWidgetQueryTableDefinition

The definition for a Query Table widget.

query_value_definition DashboardWidgetQueryValueDefinition

The definition for a Query Value widget.

run_workflow_definition DashboardWidgetRunWorkflowDefinition

The definition for a Run Workflow widget. NOTE: Currently in private beta. To request access, contact Support at support@datadoghq.com.

scatterplot_definition DashboardWidgetScatterplotDefinition

The definition for a Scatterplot widget.

service_level_objective_definition DashboardWidgetServiceLevelObjectiveDefinition

The definition for a Service Level Objective widget.

servicemap_definition DashboardWidgetServicemapDefinition

The definition for a Service Map widget.

slo_list_definition DashboardWidgetSloListDefinition

The definition for an SLO (Service Level Objective) List widget.

sunburst_definition DashboardWidgetSunburstDefinition

The definition for a Sunburst widget.

timeseries_definition DashboardWidgetTimeseriesDefinition

The definition for a Timeseries widget.

toplist_definition DashboardWidgetToplistDefinition

The definition for a Toplist widget.

topology_map_definition DashboardWidgetTopologyMapDefinition

The definition for a Topology Map widget.

trace_service_definition DashboardWidgetTraceServiceDefinition

The definition for a Trace Service widget.

treemap_definition DashboardWidgetTreemapDefinition

The definition for a Treemap widget.

widget_layout DashboardWidgetWidgetLayout

The layout of the widget on a 'free' dashboard.

alertGraphDefinition Property Map

The definition for a Alert Graph widget.

alertValueDefinition Property Map

The definition for a Alert Value widget.

changeDefinition Property Map

The definition for a Change widget.

checkStatusDefinition Property Map

The definition for a Check Status widget.

distributionDefinition Property Map

The definition for a Distribution widget.

eventStreamDefinition Property Map

The definition for a Event Stream widget.

eventTimelineDefinition Property Map

The definition for a Event Timeline widget.

freeTextDefinition Property Map

The definition for a Free Text widget.

geomapDefinition Property Map

The definition for a Geomap widget.

groupDefinition Property Map

The definition for a Group widget.

heatmapDefinition Property Map

The definition for a Heatmap widget.

hostmapDefinition Property Map

The definition for a Hostmap widget.

id Number

The ID of the widget.

iframeDefinition Property Map

The definition for an Iframe widget.

imageDefinition Property Map

The definition for an Image widget

listStreamDefinition Property Map

The definition for a List Stream widget.

logStreamDefinition Property Map

The definition for an Log Stream widget.

manageStatusDefinition Property Map

The definition for an Manage Status widget.

noteDefinition Property Map

The definition for a Note widget.

queryTableDefinition Property Map

The definition for a Query Table widget.

queryValueDefinition Property Map

The definition for a Query Value widget.

runWorkflowDefinition Property Map

The definition for a Run Workflow widget. NOTE: Currently in private beta. To request access, contact Support at support@datadoghq.com.

scatterplotDefinition Property Map

The definition for a Scatterplot widget.

serviceLevelObjectiveDefinition Property Map

The definition for a Service Level Objective widget.

servicemapDefinition Property Map

The definition for a Service Map widget.

sloListDefinition Property Map

The definition for an SLO (Service Level Objective) List widget.

sunburstDefinition Property Map

The definition for a Sunburst widget.

timeseriesDefinition Property Map

The definition for a Timeseries widget.

toplistDefinition Property Map

The definition for a Toplist widget.

topologyMapDefinition Property Map

The definition for a Topology Map widget.

traceServiceDefinition Property Map

The definition for a Trace Service widget.

treemapDefinition Property Map

The definition for a Treemap widget.

widgetLayout Property Map

The layout of the widget on a 'free' dashboard.

DashboardWidgetAlertGraphDefinition

AlertId string
VizType string
LiveSpan string
Title string

The title of the dashboard.

TitleAlign string
TitleSize string
AlertId string
VizType string
LiveSpan string
Title string

The title of the dashboard.

TitleAlign string
TitleSize string
alertId String
vizType String
liveSpan String
title String

The title of the dashboard.

titleAlign String
titleSize String
alertId string
vizType string
liveSpan string
title string

The title of the dashboard.

titleAlign string
titleSize string
alert_id str
viz_type str
live_span str
title str

The title of the dashboard.

title_align str
title_size str
alertId String
vizType String
liveSpan String
title String

The title of the dashboard.

titleAlign String
titleSize String

DashboardWidgetAlertValueDefinition

AlertId string
Precision int
TextAlign string
Title string

The title of the dashboard.

TitleAlign string
TitleSize string
Unit string
AlertId string
Precision int
TextAlign string
Title string

The title of the dashboard.

TitleAlign string
TitleSize string
Unit string
alertId String
precision Integer
textAlign String
title String

The title of the dashboard.

titleAlign String
titleSize String
unit String
alertId string
precision number
textAlign string
title string

The title of the dashboard.

titleAlign string
titleSize string
unit string
alert_id str
precision int
text_align str
title str

The title of the dashboard.

title_align str
title_size str
unit str
alertId String
precision Number
textAlign String
title String

The title of the dashboard.

titleAlign String
titleSize String
unit String

DashboardWidgetChangeDefinition

IsHidden bool
Label string
Link string
OverrideLabel string
IsHidden bool
Label string
Link string
OverrideLabel string
isHidden Boolean
label String
link String
overrideLabel String
isHidden boolean
label string
link string
overrideLabel string
isHidden Boolean
label String
link String
overrideLabel String

DashboardWidgetChangeDefinitionRequest

DashboardWidgetChangeDefinitionRequestApmQuery

DashboardWidgetChangeDefinitionRequestApmQueryComputeQuery

Aggregation string
Facet string
Interval int
Aggregation string
Facet string
Interval int
aggregation String
facet String
interval Integer
aggregation string
facet string
interval number
aggregation String
facet String
interval Number

DashboardWidgetChangeDefinitionRequestApmQueryGroupBy

DashboardWidgetChangeDefinitionRequestApmQueryGroupBySortQuery

Aggregation string
Order string
Facet string
Aggregation string
Order string
Facet string
aggregation String
order String
facet String
aggregation string
order string
facet string
aggregation String
order String
facet String

DashboardWidgetChangeDefinitionRequestApmQueryMultiCompute

Aggregation string
Facet string
Interval int
Aggregation string
Facet string
Interval int
aggregation String
facet String
interval Integer
aggregation string
facet string
interval number
aggregation String
facet String
interval Number

DashboardWidgetChangeDefinitionRequestFormula

DashboardWidgetChangeDefinitionRequestFormulaConditionalFormat

Comparator string
Palette string
Value double
CustomBgColor string
CustomFgColor string
HideValue bool
ImageUrl string
Metric string
Timeframe string
Comparator string
Palette string
Value float64
CustomBgColor string
CustomFgColor string
HideValue bool
ImageUrl string
Metric string
Timeframe string
comparator String
palette String
value Double
customBgColor String
customFgColor String
hideValue Boolean
imageUrl String
metric String
timeframe String
comparator string
palette string
value number
customBgColor string
customFgColor string
hideValue boolean
imageUrl string
metric string
timeframe string
comparator String
palette String
value Number
customBgColor String
customFgColor String
hideValue Boolean
imageUrl String
metric String
timeframe String

DashboardWidgetChangeDefinitionRequestFormulaLimit

Count int
Order string
Count int
Order string
count Integer
order String
count number
order string
count int
order str
count Number
order String

DashboardWidgetChangeDefinitionRequestFormulaStyle

palette String
paletteIndex Integer
palette string
paletteIndex number
palette String
paletteIndex Number

DashboardWidgetChangeDefinitionRequestLogQuery

DashboardWidgetChangeDefinitionRequestLogQueryComputeQuery

Aggregation string
Facet string
Interval int
Aggregation string
Facet string
Interval int
aggregation String
facet String
interval Integer
aggregation string
facet string
interval number
aggregation String
facet String
interval Number

DashboardWidgetChangeDefinitionRequestLogQueryGroupBy

DashboardWidgetChangeDefinitionRequestLogQueryGroupBySortQuery

Aggregation string
Order string
Facet string
Aggregation string
Order string
Facet string
aggregation String
order String
facet String
aggregation string
order string
facet string
aggregation String
order String
facet String

DashboardWidgetChangeDefinitionRequestLogQueryMultiCompute

Aggregation string
Facet string
Interval int
Aggregation string
Facet string
Interval int
aggregation String
facet String
interval Integer
aggregation string
facet string
interval number
aggregation String
facet String
interval Number

DashboardWidgetChangeDefinitionRequestProcessQuery

Metric string
FilterBies List<string>
Limit int
SearchBy string
Metric string
FilterBies []string
Limit int
SearchBy string
metric String
filterBies List<String>
limit Integer
searchBy String
metric string
filterBies string[]
limit number
searchBy string
metric str
filter_bies Sequence[str]
limit int
search_by str
metric String
filterBies List<String>
limit Number
searchBy String

DashboardWidgetChangeDefinitionRequestQuery

DashboardWidgetChangeDefinitionRequestQueryApmDependencyStatsQuery

DataSource string
Env string
Name string
OperationName string
ResourceName string
Service string
Stat string
IsUpstream bool
PrimaryTagName string
PrimaryTagValue string
DataSource string
Env string
Name string
OperationName string
ResourceName string
Service string
Stat string
IsUpstream bool
PrimaryTagName string
PrimaryTagValue string
dataSource String
env String
name String
operationName String
resourceName String
service String
stat String
isUpstream Boolean
primaryTagName String
primaryTagValue String
dataSource string
env string
name string
operationName string
resourceName string
service string
stat string
isUpstream boolean
primaryTagName string
primaryTagValue string
dataSource String
env String
name String
operationName String
resourceName String
service String
stat String
isUpstream Boolean
primaryTagName String
primaryTagValue String

DashboardWidgetChangeDefinitionRequestQueryApmResourceStatsQuery

DataSource string
Env string
Name string
Service string
Stat string
GroupBies List<string>
OperationName string
PrimaryTagName string
PrimaryTagValue string
ResourceName string
DataSource string
Env string
Name string
Service string
Stat string
GroupBies []string
OperationName string
PrimaryTagName string
PrimaryTagValue string
ResourceName string
dataSource String
env String
name String
service String
stat String
groupBies List<String>
operationName String
primaryTagName String
primaryTagValue String
resourceName String
dataSource string
env string
name string
service string
stat string
groupBies string[]
operationName string
primaryTagName string
primaryTagValue string
resourceName string
dataSource String
env String
name String
service String
stat String
groupBies List<String>
operationName String
primaryTagName String
primaryTagValue String
resourceName String

DashboardWidgetChangeDefinitionRequestQueryEventQuery

DashboardWidgetChangeDefinitionRequestQueryEventQueryCompute

Aggregation string
Interval int
Metric string
Aggregation string
Interval int
Metric string
aggregation String
interval Integer
metric String
aggregation string
interval number
metric string
aggregation String
interval Number
metric String

DashboardWidgetChangeDefinitionRequestQueryEventQueryGroupBy

DashboardWidgetChangeDefinitionRequestQueryEventQueryGroupBySort

Aggregation string
Metric string
Order string
Aggregation string
Metric string
Order string
aggregation String
metric String
order String
aggregation string
metric string
order string
aggregation String
metric String
order String

DashboardWidgetChangeDefinitionRequestQueryEventQuerySearch

Query string
Query string
query String
query string
query str
query String

DashboardWidgetChangeDefinitionRequestQueryMetricQuery

Name string
Query string
Aggregator string
DataSource string
Name string
Query string
Aggregator string
DataSource string
name String
query String
aggregator String
dataSource String
name string
query string
aggregator string
dataSource string
name String
query String
aggregator String
dataSource String

DashboardWidgetChangeDefinitionRequestQueryProcessQuery

DataSource string
Metric string
Name string
Aggregator string
IsNormalizedCpu bool
Limit int
Sort string
TagFilters List<string>
TextFilter string
DataSource string
Metric string
Name string
Aggregator string
IsNormalizedCpu bool
Limit int
Sort string
TagFilters []string
TextFilter string
dataSource String
metric String
name String
aggregator String
isNormalizedCpu Boolean
limit Integer
sort String
tagFilters List<String>
textFilter String
dataSource string
metric string
name string
aggregator string
isNormalizedCpu boolean
limit number
sort string
tagFilters string[]
textFilter string
dataSource String
metric String
name String
aggregator String
isNormalizedCpu Boolean
limit Number
sort String
tagFilters List<String>
textFilter String

DashboardWidgetChangeDefinitionRequestRumQuery

DashboardWidgetChangeDefinitionRequestRumQueryComputeQuery

Aggregation string
Facet string
Interval int
Aggregation string
Facet string
Interval int
aggregation String
facet String
interval Integer
aggregation string
facet string
interval number
aggregation String
facet String
interval Number

DashboardWidgetChangeDefinitionRequestRumQueryGroupBy

DashboardWidgetChangeDefinitionRequestRumQueryGroupBySortQuery

Aggregation string
Order string
Facet string
Aggregation string
Order string
Facet string
aggregation String
order String
facet String
aggregation string
order string
facet string
aggregation String
order String
facet String

DashboardWidgetChangeDefinitionRequestRumQueryMultiCompute

Aggregation string
Facet string
Interval int
Aggregation string
Facet string
Interval int
aggregation String
facet String
interval Integer
aggregation string
facet string
interval number
aggregation String
facet String
interval Number

DashboardWidgetChangeDefinitionRequestSecurityQuery

DashboardWidgetChangeDefinitionRequestSecurityQueryComputeQuery

Aggregation string
Facet string
Interval int
Aggregation string
Facet string
Interval int
aggregation String
facet String
interval Integer
aggregation string
facet string
interval number
aggregation String
facet String
interval Number

DashboardWidgetChangeDefinitionRequestSecurityQueryGroupBy

DashboardWidgetChangeDefinitionRequestSecurityQueryGroupBySortQuery

Aggregation string
Order string
Facet string
Aggregation string
Order string
Facet string
aggregation String
order String
facet String
aggregation string
order string
facet string
aggregation String
order String
facet String

DashboardWidgetChangeDefinitionRequestSecurityQueryMultiCompute

Aggregation string
Facet string
Interval int
Aggregation string
Facet string
Interval int
aggregation String
facet String
interval Integer
aggregation string
facet string
interval number
aggregation String
facet String
interval Number

DashboardWidgetCheckStatusDefinition

Check string
Grouping string
Group string
GroupBies List<string>
LiveSpan string
Tags List<string>
Title string

The title of the dashboard.

TitleAlign string
TitleSize string
Check string
Grouping string
Group string
GroupBies []string
LiveSpan string
Tags []string
Title string

The title of the dashboard.

TitleAlign string
TitleSize string
check String
grouping String
group String
groupBies List<String>
liveSpan String
tags List<String>
title String

The title of the dashboard.

titleAlign String
titleSize String
check string
grouping string
group string
groupBies string[]
liveSpan string
tags string[]
title string

The title of the dashboard.

titleAlign string
titleSize string
check str
grouping str
group str
group_bies Sequence[str]
live_span str
tags Sequence[str]
title str

The title of the dashboard.

title_align str
title_size str
check String
grouping String
group String
groupBies List<String>
liveSpan String
tags List<String>
title String

The title of the dashboard.

titleAlign String
titleSize String

DashboardWidgetDistributionDefinition

legendSize string
liveSpan string
requests DashboardWidgetDistributionDefinitionRequest[]
showLegend boolean
title string

The title of the dashboard.

titleAlign string
titleSize string
legendSize String
liveSpan String
requests List<Property Map>
showLegend Boolean
title String

The title of the dashboard.

titleAlign String
titleSize String

DashboardWidgetDistributionDefinitionRequest

DashboardWidgetDistributionDefinitionRequestApmQuery

DashboardWidgetDistributionDefinitionRequestApmQueryComputeQuery

Aggregation string
Facet string
Interval int
Aggregation string
Facet string
Interval int
aggregation String
facet String
interval Integer
aggregation string
facet string
interval number
aggregation String
facet String
interval Number

DashboardWidgetDistributionDefinitionRequestApmQueryGroupBy

DashboardWidgetDistributionDefinitionRequestApmQueryGroupBySortQuery

Aggregation string
Order string
Facet string
Aggregation string
Order string
Facet string
aggregation String
order String
facet String
aggregation string
order string
facet string
aggregation String
order String
facet String

DashboardWidgetDistributionDefinitionRequestApmQueryMultiCompute

Aggregation string
Facet string
Interval int
Aggregation string
Facet string
Interval int
aggregation String
facet String
interval Integer
aggregation string
facet string
interval number
aggregation String
facet String
interval Number

DashboardWidgetDistributionDefinitionRequestApmStatsQuery

env String
name String
primaryTag String
rowType String
service String
columns List<Property Map>
resource String

DashboardWidgetDistributionDefinitionRequestApmStatsQueryColumn

Name string
Alias string
CellDisplayMode string
Order string
Name string
Alias string
CellDisplayMode string
Order string
name String
alias String
cellDisplayMode String
order String
name string
alias string
cellDisplayMode string
order string
name String
alias String
cellDisplayMode String
order String

DashboardWidgetDistributionDefinitionRequestLogQuery

DashboardWidgetDistributionDefinitionRequestLogQueryComputeQuery

Aggregation string
Facet string
Interval int
Aggregation string
Facet string
Interval int
aggregation String
facet String
interval Integer
aggregation string
facet string
interval number
aggregation String
facet String
interval Number

DashboardWidgetDistributionDefinitionRequestLogQueryGroupBy

DashboardWidgetDistributionDefinitionRequestLogQueryGroupBySortQuery

Aggregation string
Order string
Facet string
Aggregation string
Order string
Facet string
aggregation String
order String
facet String
aggregation string
order string
facet string
aggregation String
order String
facet String

DashboardWidgetDistributionDefinitionRequestLogQueryMultiCompute

Aggregation string
Facet string
Interval int
Aggregation string
Facet string
Interval int
aggregation String
facet String
interval Integer
aggregation string
facet string
interval number
aggregation String
facet String
interval Number

DashboardWidgetDistributionDefinitionRequestProcessQuery

Metric string
FilterBies List<string>
Limit int
SearchBy string
Metric string
FilterBies []string
Limit int
SearchBy string
metric String
filterBies List<String>
limit Integer
searchBy String
metric string
filterBies string[]
limit number
searchBy string
metric str
filter_bies Sequence[str]
limit int
search_by str
metric String
filterBies List<String>
limit Number
searchBy String

DashboardWidgetDistributionDefinitionRequestRumQuery

DashboardWidgetDistributionDefinitionRequestRumQueryComputeQuery

Aggregation string
Facet string
Interval int
Aggregation string
Facet string
Interval int
aggregation String
facet String
interval Integer
aggregation string
facet string
interval number
aggregation String
facet String
interval Number

DashboardWidgetDistributionDefinitionRequestRumQueryGroupBy

DashboardWidgetDistributionDefinitionRequestRumQueryGroupBySortQuery

Aggregation string
Order string
Facet string
Aggregation string
Order string
Facet string
aggregation String
order String
facet String
aggregation string
order string
facet string
aggregation String
order String
facet String

DashboardWidgetDistributionDefinitionRequestRumQueryMultiCompute

Aggregation string
Facet string
Interval int
Aggregation string
Facet string
Interval int
aggregation String
facet String
interval Integer
aggregation string
facet string
interval number
aggregation String
facet String
interval Number

DashboardWidgetDistributionDefinitionRequestSecurityQuery