-
Notifications
You must be signed in to change notification settings - Fork 6
/
dashboard.ts
229 lines (220 loc) · 13 KB
/
dashboard.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
// *** WARNING: this file was generated by the Pulumi Terraform Bridge (tfgen) Tool. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "./types/input";
import * as outputs from "./types/output";
import * as utilities from "./utilities";
/**
* Use this resource to create and manage New Relic dashboards.
*
* ## Attribute Refence
*
* In addition to all arguments above, the following attributes are exported:
*
* * `dashboardUrl` - The URL for viewing the dashboard.
*
* ### Nested `widget` blocks
*
* All nested `widget` blocks support the following common arguments:
*
* * `title` - (Required) A title for the widget.
* * `visualization` - (Required) How the widget visualizes data. Valid values are `billboard`, `gauge`, `billboardComparison`, `facetBarChart`, `facetedLineChart`, `facetPieChart`, `facetTable`, `facetedAreaChart`, `heatmap`, `attributeSheet`, `singleEvent`, `histogram`, `funnel`, `rawJson`, `eventFeed`, `eventTable`, `uniquesList`, `lineChart`, `comparisonLineChart`, `markdown`, and `metricLineChart`.
* * `row` - (Required) Row position of widget from top left, starting at `1`.
* * `column` - (Required) Column position of widget from top left, starting at `1`.
* * `width` - (Optional) Width of the widget. Valid values are `1` to `3` inclusive. Defaults to `1`.
* * `height` - (Optional) Height of the widget. Valid values are `1` to `3` inclusive. Defaults to `1`.
* * `notes` - (Optional) Description of the widget.
*
* Each `visualization` type supports an additional set of arguments:
*
* * `billboard`, `billboardComparison`:
* * `nrql` - (Required) Valid NRQL query string. See [Writing NRQL Queries](https://docs.newrelic.com/docs/insights/nrql-new-relic-query-language/using-nrql/introduction-nrql) for help.
* * `thresholdRed` - (Optional) Threshold above which the displayed value will be styled with a red color.
* * `thresholdYellow` - (Optional) Threshold above which the displayed value will be styled with a yellow color.
* * `gauge`:
* * `nrql` - (Required) Valid NRQL query string. See [Writing NRQL Queries](https://docs.newrelic.com/docs/insights/nrql-new-relic-query-language/using-nrql/introduction-nrql) for help.
* * `thresholdRed` - (Required) Threshold above which the displayed value will be styled with a red color.
* * `thresholdYellow` - (Optional) Threshold above which the displayed value will be styled with a yellow color.
* * `facetBarChart`, `facetPieChart`, `facetTable`, `facetedAreaChart`, `facetedLineChart`, or `heatmap`:
* * `nrql` - (Required) Valid NRQL query string. See [Writing NRQL Queries](https://docs.newrelic.com/docs/insights/nrql-new-relic-query-language/using-nrql/introduction-nrql) for help.
* * `drilldownDashboardId` - (Optional) The ID of a dashboard to link to from the widget's facets.
* * `attributeSheet`, `comparisonLineChart`, `eventFeed`, `eventTable`, `funnel`, `histogram`, `lineChart`, `rawJson`, `singleEvent`, or `uniquesList`:
* * `nrql` - (Required) Valid NRQL query string. See [Writing NRQL Queries](https://docs.newrelic.com/docs/insights/nrql-new-relic-query-language/using-nrql/introduction-nrql) for help.
* * `markdown`:
* * `source` - (Required) The markdown source to be rendered in the widget.
* * `metricLineChart`:
* * `entityIds` - (Required) A collection of entity ids to display data for. These are typically application IDs.
* * `metric` - (Required) A nested block that describes a metric. Nested `metric` blocks support the following arguments:
* * `name` - (Required) The metric name to display.
* * `values` - (Required) The metric values to display.
* * `duration` - (Required) The duration, in ms, of the time window represented in the chart.
* * `endTime` - (Optional) The end time of the time window represented in the chart in epoch time. When not set, the time window will end at the current time.
* * `facet` - (Optional) Can be set to "host" to facet the metric data by host.
* * `limit` - (Optional) The limit of distinct data series to display.
* * `applicationBreakdown`:
* * `entityIds` - (Required) A collection of entity IDs to display data. These are typically application IDs.
*
*
* ### Nested `filter` block
*
* The optional filter block supports the following arguments:
* * `eventTypes` - (Optional) A list of event types to enable filtering for.
* * `attributes` - (Optional) A list of attributes belonging to the specified event types to enable filtering for.
*
* > This content is derived from https://github.com/terraform-providers/terraform-provider-newrelic/blob/master/website/docs/r/dashboard.html.markdown.
*/
export class Dashboard extends pulumi.CustomResource {
/**
* Get an existing Dashboard resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
*/
public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DashboardState, opts?: pulumi.CustomResourceOptions): Dashboard {
return new Dashboard(name, <any>state, { ...opts, id: id });
}
/** @internal */
public static readonly __pulumiType = 'newrelic:index/dashboard:Dashboard';
/**
* Returns true if the given object is an instance of Dashboard. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
public static isInstance(obj: any): obj is Dashboard {
if (obj === undefined || obj === null) {
return false;
}
return obj['__pulumiType'] === Dashboard.__pulumiType;
}
/**
* The URL for viewing the dashboard.
*/
public /*out*/ readonly dashboardUrl!: pulumi.Output<string>;
/**
* Determines who can edit the dashboard in an account. Valid values are `all`, `editableByAll`, `editableByOwner`, or `readOnly`. Defaults to `editableByAll`.
*/
public readonly editable!: pulumi.Output<string | undefined>;
/**
* A nested block that describes a dashboard filter. Exactly one nested `filter` block is allowed. See Nested filter block below for details.
*/
public readonly filter!: pulumi.Output<outputs.DashboardFilter | undefined>;
/**
* The icon for the dashboard. Valid values are `adjust`, `archive`, `bar-chart`, `bell`, `bolt`, `bug`, `bullhorn`, `bullseye`, `clock-o`, `cloud`, `cog`, `comments-o`, `crosshairs`, `dashboard`, `envelope`, `fire`, `flag`, `flask`, `globe`, `heart`, `leaf`, `legal`, `life-ring`, `line-chart`, `magic`, `mobile`, `money`, `none`, `paper-plane`, `pie-chart`, `puzzle-piece`, `road`, `rocket`, `shopping-cart`, `sitemap`, `sliders`, `tablet`, `thumbs-down`, `thumbs-up`, `trophy`, `usd`, `user`, and `users`. Defaults to `bar-chart`.
*/
public readonly icon!: pulumi.Output<string | undefined>;
/**
* The title of the dashboard.
*/
public readonly title!: pulumi.Output<string>;
/**
* Determines who can see the dashboard in an account. Valid values are `all` or `owner`. Defaults to `all`.
*/
public readonly visibility!: pulumi.Output<string | undefined>;
/**
* A nested block that describes a visualization. Up to 300 `widget` blocks are allowed in a dashboard definition. See Nested widget blocks below for details.
*/
public readonly widgets!: pulumi.Output<outputs.DashboardWidget[] | undefined>;
/**
* Create a Dashboard resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DashboardArgs, opts?: pulumi.CustomResourceOptions)
constructor(name: string, argsOrState?: DashboardArgs | DashboardState, opts?: pulumi.CustomResourceOptions) {
let inputs: pulumi.Inputs = {};
if (opts && opts.id) {
const state = argsOrState as DashboardState | undefined;
inputs["dashboardUrl"] = state ? state.dashboardUrl : undefined;
inputs["editable"] = state ? state.editable : undefined;
inputs["filter"] = state ? state.filter : undefined;
inputs["icon"] = state ? state.icon : undefined;
inputs["title"] = state ? state.title : undefined;
inputs["visibility"] = state ? state.visibility : undefined;
inputs["widgets"] = state ? state.widgets : undefined;
} else {
const args = argsOrState as DashboardArgs | undefined;
if (!args || args.title === undefined) {
throw new Error("Missing required property 'title'");
}
inputs["editable"] = args ? args.editable : undefined;
inputs["filter"] = args ? args.filter : undefined;
inputs["icon"] = args ? args.icon : undefined;
inputs["title"] = args ? args.title : undefined;
inputs["visibility"] = args ? args.visibility : undefined;
inputs["widgets"] = args ? args.widgets : undefined;
inputs["dashboardUrl"] = undefined /*out*/;
}
if (!opts) {
opts = {}
}
if (!opts.version) {
opts.version = utilities.getVersion();
}
super(Dashboard.__pulumiType, name, inputs, opts);
}
}
/**
* Input properties used for looking up and filtering Dashboard resources.
*/
export interface DashboardState {
/**
* The URL for viewing the dashboard.
*/
readonly dashboardUrl?: pulumi.Input<string>;
/**
* Determines who can edit the dashboard in an account. Valid values are `all`, `editableByAll`, `editableByOwner`, or `readOnly`. Defaults to `editableByAll`.
*/
readonly editable?: pulumi.Input<string>;
/**
* A nested block that describes a dashboard filter. Exactly one nested `filter` block is allowed. See Nested filter block below for details.
*/
readonly filter?: pulumi.Input<inputs.DashboardFilter>;
/**
* The icon for the dashboard. Valid values are `adjust`, `archive`, `bar-chart`, `bell`, `bolt`, `bug`, `bullhorn`, `bullseye`, `clock-o`, `cloud`, `cog`, `comments-o`, `crosshairs`, `dashboard`, `envelope`, `fire`, `flag`, `flask`, `globe`, `heart`, `leaf`, `legal`, `life-ring`, `line-chart`, `magic`, `mobile`, `money`, `none`, `paper-plane`, `pie-chart`, `puzzle-piece`, `road`, `rocket`, `shopping-cart`, `sitemap`, `sliders`, `tablet`, `thumbs-down`, `thumbs-up`, `trophy`, `usd`, `user`, and `users`. Defaults to `bar-chart`.
*/
readonly icon?: pulumi.Input<string>;
/**
* The title of the dashboard.
*/
readonly title?: pulumi.Input<string>;
/**
* Determines who can see the dashboard in an account. Valid values are `all` or `owner`. Defaults to `all`.
*/
readonly visibility?: pulumi.Input<string>;
/**
* A nested block that describes a visualization. Up to 300 `widget` blocks are allowed in a dashboard definition. See Nested widget blocks below for details.
*/
readonly widgets?: pulumi.Input<pulumi.Input<inputs.DashboardWidget>[]>;
}
/**
* The set of arguments for constructing a Dashboard resource.
*/
export interface DashboardArgs {
/**
* Determines who can edit the dashboard in an account. Valid values are `all`, `editableByAll`, `editableByOwner`, or `readOnly`. Defaults to `editableByAll`.
*/
readonly editable?: pulumi.Input<string>;
/**
* A nested block that describes a dashboard filter. Exactly one nested `filter` block is allowed. See Nested filter block below for details.
*/
readonly filter?: pulumi.Input<inputs.DashboardFilter>;
/**
* The icon for the dashboard. Valid values are `adjust`, `archive`, `bar-chart`, `bell`, `bolt`, `bug`, `bullhorn`, `bullseye`, `clock-o`, `cloud`, `cog`, `comments-o`, `crosshairs`, `dashboard`, `envelope`, `fire`, `flag`, `flask`, `globe`, `heart`, `leaf`, `legal`, `life-ring`, `line-chart`, `magic`, `mobile`, `money`, `none`, `paper-plane`, `pie-chart`, `puzzle-piece`, `road`, `rocket`, `shopping-cart`, `sitemap`, `sliders`, `tablet`, `thumbs-down`, `thumbs-up`, `trophy`, `usd`, `user`, and `users`. Defaults to `bar-chart`.
*/
readonly icon?: pulumi.Input<string>;
/**
* The title of the dashboard.
*/
readonly title: pulumi.Input<string>;
/**
* Determines who can see the dashboard in an account. Valid values are `all` or `owner`. Defaults to `all`.
*/
readonly visibility?: pulumi.Input<string>;
/**
* A nested block that describes a visualization. Up to 300 `widget` blocks are allowed in a dashboard definition. See Nested widget blocks below for details.
*/
readonly widgets?: pulumi.Input<pulumi.Input<inputs.DashboardWidget>[]>;
}