Docs Home
Wavefront v3.1.6 published on Thursday, Oct 31, 2024 by Pulumi
wavefront.DashboardJson
Explore with Pulumi AI
Provides a Wavefront Dashboard JSON resource. This allows dashboards to be created, updated, and deleted.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as wavefront from "@pulumi/wavefront";
const testDashboardJson = new wavefront.DashboardJson("test_dashboard_json", {dashboardJson: `{
"acl": {
"canModify": [
"group-uuid",
"role-uuid"
],
"canView": [
"group-uuid",
"role-uuid"
]
},
"name": "Terraform Test Dashboard Json",
"description": "a",
"eventFilterType": "BYCHART",
"eventQuery": "",
"defaultTimeWindow": "",
"url": "tftestimport",
"displayDescription": false,
"displaySectionTableOfContents": true,
"displayQueryParameters": false,
"sections": [
{
"name": "section 1",
"rows": [
{
"charts": [
{
"name": "chart 1",
"sources": [
{
"name": "source 1",
"query": "ts()",
"scatterPlotSource": "Y",
"querybuilderEnabled": false,
"sourceDescription": ""
}
],
"units": "someunit",
"base": 0,
"noDefaultEvents": false,
"interpolatePoints": false,
"includeObsoleteMetrics": false,
"description": "This is chart 1, showing something",
"chartSettings": {
"type": "markdown-widget",
"max": 100,
"expectedDataSpacing": 120,
"windowing": "full",
"windowSize": 10,
"autoColumnTags": false,
"columnTags": "deprecated",
"tagMode": "all",
"numTags": 2,
"customTags": [
"tag1",
"tag2"
],
"groupBySource": true,
"y1Max": 100,
"y1Units": "units",
"y0ScaleSIBy1024": true,
"y1ScaleSIBy1024": true,
"y0UnitAutoscaling": true,
"y1UnitAutoscaling": true,
"fixedLegendEnabled": true,
"fixedLegendUseRawStats": true,
"fixedLegendPosition": "RIGHT",
"fixedLegendDisplayStats": [
"stat1",
"stat2"
],
"fixedLegendFilterSort": "TOP",
"fixedLegendFilterLimit": 1,
"fixedLegendFilterField": "CURRENT",
"plainMarkdownContent": "markdown content"
},
"chartAttributes": {
"dashboardLinks": {
"*": {
"variables": {
"xxx": "xxx"
},
"destination": "/dashboards/xxxx"
}
}
},
"summarization": "MEAN"
}
],
"heightFactor": 50
}
]
}
],
"parameterDetails": {
"param": {
"hideFromView": false,
"description": null,
"allowAll": null,
"tagKey": null,
"queryValue": null,
"dynamicFieldType": null,
"reverseDynSort": null,
"parameterType": "SIMPLE",
"label": "test",
"defaultValue": "Label",
"valuesToReadableStrings": {
"Label": "test"
},
"selectedLabel": "Label",
"value": "test"
}
},
"tags": {
"customerTags": [
"terraform"
]
}
}
`});
import pulumi
import pulumi_wavefront as wavefront
test_dashboard_json = wavefront.DashboardJson("test_dashboard_json", dashboard_json="""{
"acl": {
"canModify": [
"group-uuid",
"role-uuid"
],
"canView": [
"group-uuid",
"role-uuid"
]
},
"name": "Terraform Test Dashboard Json",
"description": "a",
"eventFilterType": "BYCHART",
"eventQuery": "",
"defaultTimeWindow": "",
"url": "tftestimport",
"displayDescription": false,
"displaySectionTableOfContents": true,
"displayQueryParameters": false,
"sections": [
{
"name": "section 1",
"rows": [
{
"charts": [
{
"name": "chart 1",
"sources": [
{
"name": "source 1",
"query": "ts()",
"scatterPlotSource": "Y",
"querybuilderEnabled": false,
"sourceDescription": ""
}
],
"units": "someunit",
"base": 0,
"noDefaultEvents": false,
"interpolatePoints": false,
"includeObsoleteMetrics": false,
"description": "This is chart 1, showing something",
"chartSettings": {
"type": "markdown-widget",
"max": 100,
"expectedDataSpacing": 120,
"windowing": "full",
"windowSize": 10,
"autoColumnTags": false,
"columnTags": "deprecated",
"tagMode": "all",
"numTags": 2,
"customTags": [
"tag1",
"tag2"
],
"groupBySource": true,
"y1Max": 100,
"y1Units": "units",
"y0ScaleSIBy1024": true,
"y1ScaleSIBy1024": true,
"y0UnitAutoscaling": true,
"y1UnitAutoscaling": true,
"fixedLegendEnabled": true,
"fixedLegendUseRawStats": true,
"fixedLegendPosition": "RIGHT",
"fixedLegendDisplayStats": [
"stat1",
"stat2"
],
"fixedLegendFilterSort": "TOP",
"fixedLegendFilterLimit": 1,
"fixedLegendFilterField": "CURRENT",
"plainMarkdownContent": "markdown content"
},
"chartAttributes": {
"dashboardLinks": {
"*": {
"variables": {
"xxx": "xxx"
},
"destination": "/dashboards/xxxx"
}
}
},
"summarization": "MEAN"
}
],
"heightFactor": 50
}
]
}
],
"parameterDetails": {
"param": {
"hideFromView": false,
"description": null,
"allowAll": null,
"tagKey": null,
"queryValue": null,
"dynamicFieldType": null,
"reverseDynSort": null,
"parameterType": "SIMPLE",
"label": "test",
"defaultValue": "Label",
"valuesToReadableStrings": {
"Label": "test"
},
"selectedLabel": "Label",
"value": "test"
}
},
"tags": {
"customerTags": [
"terraform"
]
}
}
""")
package main
import (
"github.com/pulumi/pulumi-wavefront/sdk/v3/go/wavefront"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := wavefront.NewDashboardJson(ctx, "test_dashboard_json", &wavefront.DashboardJsonArgs{
DashboardJson: pulumi.String(`{
"acl": {
"canModify": [
"group-uuid",
"role-uuid"
],
"canView": [
"group-uuid",
"role-uuid"
]
},
"name": "Terraform Test Dashboard Json",
"description": "a",
"eventFilterType": "BYCHART",
"eventQuery": "",
"defaultTimeWindow": "",
"url": "tftestimport",
"displayDescription": false,
"displaySectionTableOfContents": true,
"displayQueryParameters": false,
"sections": [
{
"name": "section 1",
"rows": [
{
"charts": [
{
"name": "chart 1",
"sources": [
{
"name": "source 1",
"query": "ts()",
"scatterPlotSource": "Y",
"querybuilderEnabled": false,
"sourceDescription": ""
}
],
"units": "someunit",
"base": 0,
"noDefaultEvents": false,
"interpolatePoints": false,
"includeObsoleteMetrics": false,
"description": "This is chart 1, showing something",
"chartSettings": {
"type": "markdown-widget",
"max": 100,
"expectedDataSpacing": 120,
"windowing": "full",
"windowSize": 10,
"autoColumnTags": false,
"columnTags": "deprecated",
"tagMode": "all",
"numTags": 2,
"customTags": [
"tag1",
"tag2"
],
"groupBySource": true,
"y1Max": 100,
"y1Units": "units",
"y0ScaleSIBy1024": true,
"y1ScaleSIBy1024": true,
"y0UnitAutoscaling": true,
"y1UnitAutoscaling": true,
"fixedLegendEnabled": true,
"fixedLegendUseRawStats": true,
"fixedLegendPosition": "RIGHT",
"fixedLegendDisplayStats": [
"stat1",
"stat2"
],
"fixedLegendFilterSort": "TOP",
"fixedLegendFilterLimit": 1,
"fixedLegendFilterField": "CURRENT",
"plainMarkdownContent": "markdown content"
},
"chartAttributes": {
"dashboardLinks": {
"*": {
"variables": {
"xxx": "xxx"
},
"destination": "/dashboards/xxxx"
}
}
},
"summarization": "MEAN"
}
],
"heightFactor": 50
}
]
}
],
"parameterDetails": {
"param": {
"hideFromView": false,
"description": null,
"allowAll": null,
"tagKey": null,
"queryValue": null,
"dynamicFieldType": null,
"reverseDynSort": null,
"parameterType": "SIMPLE",
"label": "test",
"defaultValue": "Label",
"valuesToReadableStrings": {
"Label": "test"
},
"selectedLabel": "Label",
"value": "test"
}
},
"tags": {
"customerTags": [
"terraform"
]
}
}
`),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Wavefront = Pulumi.Wavefront;
return await Deployment.RunAsync(() =>
{
var testDashboardJson = new Wavefront.DashboardJson("test_dashboard_json", new()
{
JSON = @"{
""acl"": {
""canModify"": [
""group-uuid"",
""role-uuid""
],
""canView"": [
""group-uuid"",
""role-uuid""
]
},
""name"": ""Terraform Test Dashboard Json"",
""description"": ""a"",
""eventFilterType"": ""BYCHART"",
""eventQuery"": """",
""defaultTimeWindow"": """",
""url"": ""tftestimport"",
""displayDescription"": false,
""displaySectionTableOfContents"": true,
""displayQueryParameters"": false,
""sections"": [
{
""name"": ""section 1"",
""rows"": [
{
""charts"": [
{
""name"": ""chart 1"",
""sources"": [
{
""name"": ""source 1"",
""query"": ""ts()"",
""scatterPlotSource"": ""Y"",
""querybuilderEnabled"": false,
""sourceDescription"": """"
}
],
""units"": ""someunit"",
""base"": 0,
""noDefaultEvents"": false,
""interpolatePoints"": false,
""includeObsoleteMetrics"": false,
""description"": ""This is chart 1, showing something"",
""chartSettings"": {
""type"": ""markdown-widget"",
""max"": 100,
""expectedDataSpacing"": 120,
""windowing"": ""full"",
""windowSize"": 10,
""autoColumnTags"": false,
""columnTags"": ""deprecated"",
""tagMode"": ""all"",
""numTags"": 2,
""customTags"": [
""tag1"",
""tag2""
],
""groupBySource"": true,
""y1Max"": 100,
""y1Units"": ""units"",
""y0ScaleSIBy1024"": true,
""y1ScaleSIBy1024"": true,
""y0UnitAutoscaling"": true,
""y1UnitAutoscaling"": true,
""fixedLegendEnabled"": true,
""fixedLegendUseRawStats"": true,
""fixedLegendPosition"": ""RIGHT"",
""fixedLegendDisplayStats"": [
""stat1"",
""stat2""
],
""fixedLegendFilterSort"": ""TOP"",
""fixedLegendFilterLimit"": 1,
""fixedLegendFilterField"": ""CURRENT"",
""plainMarkdownContent"": ""markdown content""
},
""chartAttributes"": {
""dashboardLinks"": {
""*"": {
""variables"": {
""xxx"": ""xxx""
},
""destination"": ""/dashboards/xxxx""
}
}
},
""summarization"": ""MEAN""
}
],
""heightFactor"": 50
}
]
}
],
""parameterDetails"": {
""param"": {
""hideFromView"": false,
""description"": null,
""allowAll"": null,
""tagKey"": null,
""queryValue"": null,
""dynamicFieldType"": null,
""reverseDynSort"": null,
""parameterType"": ""SIMPLE"",
""label"": ""test"",
""defaultValue"": ""Label"",
""valuesToReadableStrings"": {
""Label"": ""test""
},
""selectedLabel"": ""Label"",
""value"": ""test""
}
},
""tags"": {
""customerTags"": [
""terraform""
]
}
}
",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.wavefront.DashboardJson;
import com.pulumi.wavefront.DashboardJsonArgs;
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 testDashboardJson = new DashboardJson("testDashboardJson", DashboardJsonArgs.builder()
.dashboardJson("""
{
"acl": {
"canModify": [
"group-uuid",
"role-uuid"
],
"canView": [
"group-uuid",
"role-uuid"
]
},
"name": "Terraform Test Dashboard Json",
"description": "a",
"eventFilterType": "BYCHART",
"eventQuery": "",
"defaultTimeWindow": "",
"url": "tftestimport",
"displayDescription": false,
"displaySectionTableOfContents": true,
"displayQueryParameters": false,
"sections": [
{
"name": "section 1",
"rows": [
{
"charts": [
{
"name": "chart 1",
"sources": [
{
"name": "source 1",
"query": "ts()",
"scatterPlotSource": "Y",
"querybuilderEnabled": false,
"sourceDescription": ""
}
],
"units": "someunit",
"base": 0,
"noDefaultEvents": false,
"interpolatePoints": false,
"includeObsoleteMetrics": false,
"description": "This is chart 1, showing something",
"chartSettings": {
"type": "markdown-widget",
"max": 100,
"expectedDataSpacing": 120,
"windowing": "full",
"windowSize": 10,
"autoColumnTags": false,
"columnTags": "deprecated",
"tagMode": "all",
"numTags": 2,
"customTags": [
"tag1",
"tag2"
],
"groupBySource": true,
"y1Max": 100,
"y1Units": "units",
"y0ScaleSIBy1024": true,
"y1ScaleSIBy1024": true,
"y0UnitAutoscaling": true,
"y1UnitAutoscaling": true,
"fixedLegendEnabled": true,
"fixedLegendUseRawStats": true,
"fixedLegendPosition": "RIGHT",
"fixedLegendDisplayStats": [
"stat1",
"stat2"
],
"fixedLegendFilterSort": "TOP",
"fixedLegendFilterLimit": 1,
"fixedLegendFilterField": "CURRENT",
"plainMarkdownContent": "markdown content"
},
"chartAttributes": {
"dashboardLinks": {
"*": {
"variables": {
"xxx": "xxx"
},
"destination": "/dashboards/xxxx"
}
}
},
"summarization": "MEAN"
}
],
"heightFactor": 50
}
]
}
],
"parameterDetails": {
"param": {
"hideFromView": false,
"description": null,
"allowAll": null,
"tagKey": null,
"queryValue": null,
"dynamicFieldType": null,
"reverseDynSort": null,
"parameterType": "SIMPLE",
"label": "test",
"defaultValue": "Label",
"valuesToReadableStrings": {
"Label": "test"
},
"selectedLabel": "Label",
"value": "test"
}
},
"tags": {
"customerTags": [
"terraform"
]
}
}
""")
.build());
}
}
resources:
testDashboardJson:
type: wavefront:DashboardJson
name: test_dashboard_json
properties:
dashboardJson: |
{
"acl": {
"canModify": [
"group-uuid",
"role-uuid"
],
"canView": [
"group-uuid",
"role-uuid"
]
},
"name": "Terraform Test Dashboard Json",
"description": "a",
"eventFilterType": "BYCHART",
"eventQuery": "",
"defaultTimeWindow": "",
"url": "tftestimport",
"displayDescription": false,
"displaySectionTableOfContents": true,
"displayQueryParameters": false,
"sections": [
{
"name": "section 1",
"rows": [
{
"charts": [
{
"name": "chart 1",
"sources": [
{
"name": "source 1",
"query": "ts()",
"scatterPlotSource": "Y",
"querybuilderEnabled": false,
"sourceDescription": ""
}
],
"units": "someunit",
"base": 0,
"noDefaultEvents": false,
"interpolatePoints": false,
"includeObsoleteMetrics": false,
"description": "This is chart 1, showing something",
"chartSettings": {
"type": "markdown-widget",
"max": 100,
"expectedDataSpacing": 120,
"windowing": "full",
"windowSize": 10,
"autoColumnTags": false,
"columnTags": "deprecated",
"tagMode": "all",
"numTags": 2,
"customTags": [
"tag1",
"tag2"
],
"groupBySource": true,
"y1Max": 100,
"y1Units": "units",
"y0ScaleSIBy1024": true,
"y1ScaleSIBy1024": true,
"y0UnitAutoscaling": true,
"y1UnitAutoscaling": true,
"fixedLegendEnabled": true,
"fixedLegendUseRawStats": true,
"fixedLegendPosition": "RIGHT",
"fixedLegendDisplayStats": [
"stat1",
"stat2"
],
"fixedLegendFilterSort": "TOP",
"fixedLegendFilterLimit": 1,
"fixedLegendFilterField": "CURRENT",
"plainMarkdownContent": "markdown content"
},
"chartAttributes": {
"dashboardLinks": {
"*": {
"variables": {
"xxx": "xxx"
},
"destination": "/dashboards/xxxx"
}
}
},
"summarization": "MEAN"
}
],
"heightFactor": 50
}
]
}
],
"parameterDetails": {
"param": {
"hideFromView": false,
"description": null,
"allowAll": null,
"tagKey": null,
"queryValue": null,
"dynamicFieldType": null,
"reverseDynSort": null,
"parameterType": "SIMPLE",
"label": "test",
"defaultValue": "Label",
"valuesToReadableStrings": {
"Label": "test"
},
"selectedLabel": "Label",
"value": "test"
}
},
"tags": {
"customerTags": [
"terraform"
]
}
}
*Note: ** If there are dynamic variables in the Wavefront dashboard json, then these variables must be present in a separate file as mentioned in the section below.
Create DashboardJson Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new DashboardJson(name: string, args: DashboardJsonArgs, opts?: CustomResourceOptions);@overload
def DashboardJson(resource_name: str,
args: DashboardJsonArgs,
opts: Optional[ResourceOptions] = None)
@overload
def DashboardJson(resource_name: str,
opts: Optional[ResourceOptions] = None,
dashboard_json: Optional[str] = None)func NewDashboardJson(ctx *Context, name string, args DashboardJsonArgs, opts ...ResourceOption) (*DashboardJson, error)public DashboardJson(string name, DashboardJsonArgs args, CustomResourceOptions? opts = null)
public DashboardJson(String name, DashboardJsonArgs args)
public DashboardJson(String name, DashboardJsonArgs args, CustomResourceOptions options)
type: wavefront:DashboardJson
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args DashboardJsonArgs
- 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 DashboardJsonArgs
- 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 DashboardJsonArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args DashboardJsonArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args DashboardJsonArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var dashboardJsonResource = new Wavefront.DashboardJson("dashboardJsonResource", new()
{
JSON = "string",
});
example, err := wavefront.NewDashboardJson(ctx, "dashboardJsonResource", &wavefront.DashboardJsonArgs{
DashboardJson: pulumi.String("string"),
})
var dashboardJsonResource = new DashboardJson("dashboardJsonResource", DashboardJsonArgs.builder()
.dashboardJson("string")
.build());
dashboard_json_resource = wavefront.DashboardJson("dashboardJsonResource", dashboard_json="string")
const dashboardJsonResource = new wavefront.DashboardJson("dashboardJsonResource", {dashboardJson: "string"});
type: wavefront:DashboardJson
properties:
dashboardJson: string
DashboardJson Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DashboardJson resource accepts the following input properties:
- JSON string
- See the Wavefront API Documentation for instructions on how to get to your API documentation for more details.
- Dashboard
Json string - See the Wavefront API Documentation for instructions on how to get to your API documentation for more details.
- dashboard
Json String - See the Wavefront API Documentation for instructions on how to get to your API documentation for more details.
- dashboard
Json string - See the Wavefront API Documentation for instructions on how to get to your API documentation for more details.
- dashboard_
json str - See the Wavefront API Documentation for instructions on how to get to your API documentation for more details.
- dashboard
Json String - See the Wavefront API Documentation for instructions on how to get to your API documentation for more details.
Outputs
All input properties are implicitly available as output properties. Additionally, the DashboardJson resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing DashboardJson Resource
Get an existing DashboardJson 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?: DashboardJsonState, opts?: CustomResourceOptions): DashboardJson@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
dashboard_json: Optional[str] = None) -> DashboardJsonfunc GetDashboardJson(ctx *Context, name string, id IDInput, state *DashboardJsonState, opts ...ResourceOption) (*DashboardJson, error)public static DashboardJson Get(string name, Input<string> id, DashboardJsonState? state, CustomResourceOptions? opts = null)public static DashboardJson get(String name, Output<String> id, DashboardJsonState 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.
- JSON string
- See the Wavefront API Documentation for instructions on how to get to your API documentation for more details.
- Dashboard
Json string - See the Wavefront API Documentation for instructions on how to get to your API documentation for more details.
- dashboard
Json String - See the Wavefront API Documentation for instructions on how to get to your API documentation for more details.
- dashboard
Json string - See the Wavefront API Documentation for instructions on how to get to your API documentation for more details.
- dashboard_
json str - See the Wavefront API Documentation for instructions on how to get to your API documentation for more details.
- dashboard
Json String - See the Wavefront API Documentation for instructions on how to get to your API documentation for more details.
Import
Dashboard JSON can be imported by using the id, e.g.:
$ pulumi import wavefront:index/dashboardJson:DashboardJson dashboard_json tftestimport
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Wavefront pulumi/pulumi-wavefront
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
wavefrontTerraform Provider.