@pulumi/signalfx 7.1.4 → 7.1.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. package/alertMutingRule.d.ts +27 -33
  2. package/alertMutingRule.js +2 -18
  3. package/alertMutingRule.js.map +1 -1
  4. package/aws/externalIntegration.d.ts +7 -19
  5. package/aws/externalIntegration.js +0 -12
  6. package/aws/externalIntegration.js.map +1 -1
  7. package/aws/integration.d.ts +68 -135
  8. package/aws/integration.js +0 -37
  9. package/aws/integration.js.map +1 -1
  10. package/aws/tokenIntegration.d.ts +5 -16
  11. package/aws/tokenIntegration.js +0 -11
  12. package/aws/tokenIntegration.js.map +1 -1
  13. package/azure/integration.d.ts +39 -95
  14. package/azure/integration.js +0 -26
  15. package/azure/integration.js.map +1 -1
  16. package/dashboard.d.ts +62 -62
  17. package/dashboardGroup.d.ts +21 -54
  18. package/dashboardGroup.js +0 -33
  19. package/dashboardGroup.js.map +1 -1
  20. package/dataLink.d.ts +12 -46
  21. package/dataLink.js +0 -28
  22. package/dataLink.js.map +1 -1
  23. package/detector.d.ts +55 -114
  24. package/detector.js +0 -51
  25. package/detector.js.map +1 -1
  26. package/eventFeedChart.d.ts +20 -38
  27. package/eventFeedChart.js +0 -18
  28. package/eventFeedChart.js.map +1 -1
  29. package/gcp/integration.d.ts +30 -61
  30. package/gcp/integration.js +0 -19
  31. package/gcp/integration.js.map +1 -1
  32. package/heatmapChart.d.ts +44 -78
  33. package/heatmapChart.js +0 -34
  34. package/heatmapChart.js.map +1 -1
  35. package/jira/integration.d.ts +21 -48
  36. package/jira/integration.js +0 -21
  37. package/jira/integration.js.map +1 -1
  38. package/listChart.d.ts +62 -109
  39. package/listChart.js +0 -44
  40. package/listChart.js.map +1 -1
  41. package/log/timeline.d.ts +23 -42
  42. package/log/timeline.js +0 -19
  43. package/log/timeline.js.map +1 -1
  44. package/log/view.d.ts +29 -50
  45. package/log/view.js +0 -21
  46. package/log/view.js.map +1 -1
  47. package/metricRuleset.d.ts +9 -31
  48. package/metricRuleset.js +0 -22
  49. package/metricRuleset.js.map +1 -1
  50. package/opsgenie/integration.d.ts +12 -25
  51. package/opsgenie/integration.js +0 -13
  52. package/opsgenie/integration.js.map +1 -1
  53. package/orgToken.d.ts +36 -47
  54. package/orgToken.js +0 -29
  55. package/orgToken.js.map +1 -1
  56. package/package.json +2 -2
  57. package/pagerduty/getIntegration.d.ts +12 -20
  58. package/pagerduty/getIntegration.js +0 -20
  59. package/pagerduty/getIntegration.js.map +1 -1
  60. package/pagerduty/integration.d.ts +9 -20
  61. package/pagerduty/integration.js +0 -11
  62. package/pagerduty/integration.js.map +1 -1
  63. package/servicenow/integration.d.ts +15 -44
  64. package/servicenow/integration.js +0 -17
  65. package/servicenow/integration.js.map +1 -1
  66. package/singleValueChart.d.ts +38 -73
  67. package/singleValueChart.js +0 -35
  68. package/singleValueChart.js.map +1 -1
  69. package/slack/integration.d.ts +9 -21
  70. package/slack/integration.js +0 -12
  71. package/slack/integration.js.map +1 -1
  72. package/slo.d.ts +12 -52
  73. package/slo.js +0 -37
  74. package/slo.js.map +1 -1
  75. package/tableChart.d.ts +14 -30
  76. package/tableChart.js +0 -16
  77. package/tableChart.js.map +1 -1
  78. package/team.d.ts +29 -50
  79. package/team.js +0 -21
  80. package/team.js.map +1 -1
  81. package/textChart.d.ts +11 -26
  82. package/textChart.js +0 -15
  83. package/textChart.js.map +1 -1
  84. package/timeChart.d.ts +92 -146
  85. package/timeChart.js +0 -66
  86. package/timeChart.js.map +1 -1
  87. package/types/input.d.ts +211 -182
  88. package/types/output.d.ts +211 -182
  89. package/victorops/integration.d.ts +9 -21
  90. package/victorops/integration.js +0 -12
  91. package/victorops/integration.js.map +1 -1
  92. package/webhookIntegration.d.ts +36 -28
  93. package/webhookIntegration.js +4 -16
  94. package/webhookIntegration.js.map +1 -1
package/types/input.d.ts CHANGED
@@ -2,146 +2,159 @@ import * as pulumi from "@pulumi/pulumi";
2
2
  import * as inputs from "../types/input";
3
3
  export interface AlertMutingRuleFilter {
4
4
  /**
5
- * (false by default) whether this filter should be a "not" filter
5
+ * Determines if this is a "not" filter. Defaults to `false`.
6
6
  */
7
7
  negated?: pulumi.Input<boolean>;
8
8
  /**
9
- * the property to filter by
9
+ * The property to filter.
10
10
  */
11
11
  property: pulumi.Input<string>;
12
12
  /**
13
- * the value of the property to filter by
13
+ * The property value to filter.
14
14
  */
15
15
  propertyValue: pulumi.Input<string>;
16
16
  }
17
+ export interface AlertMutingRuleRecurrence {
18
+ /**
19
+ * The unit of the period. Can be days (d) or weeks (w).
20
+ */
21
+ unit: pulumi.Input<string>;
22
+ /**
23
+ * The amount of time, expressed as an integer, applicable to the unit specified.
24
+ */
25
+ value: pulumi.Input<number>;
26
+ }
17
27
  export interface DashboardChart {
18
28
  /**
19
- * ID of the chart to display
29
+ * ID of the chart to display.
20
30
  */
21
31
  chartId: pulumi.Input<string>;
22
32
  /**
23
- * The column to show the chart in (zero-based); this value always represents the leftmost column of the chart. (between 0 and 11)
33
+ * The column to show the chart in (zero-based); this value always represents the leftmost column of the chart (between `0` and `11`).
24
34
  */
25
35
  column?: pulumi.Input<number>;
26
36
  /**
27
- * How many rows the chart should take up. (greater than or equal to 1)
37
+ * How many rows the chart should take up (greater than or equal to `1`). `1` by default.
28
38
  */
29
39
  height?: pulumi.Input<number>;
30
40
  /**
31
- * The row to show the chart in (zero-based); if height > 1, this value represents the topmost row of the chart. (greater than or equal to 0)
41
+ * The row to show the chart in (zero-based); if `height > 1`, this value represents the topmost row of the chart (greater than or equal to `0`).
32
42
  */
33
43
  row?: pulumi.Input<number>;
34
44
  /**
35
- * How many columns (out of a total of 12, one-based) the chart should take up. (between 1 and 12)
45
+ * How many columns (out of a total of 12) the chart should take up (between `1` and `12`). `12` by default.
36
46
  */
37
47
  width?: pulumi.Input<number>;
38
48
  }
39
49
  export interface DashboardColumn {
40
50
  /**
41
- * Charts to use for the column
51
+ * List of IDs of the charts to display.
42
52
  */
43
53
  chartIds: pulumi.Input<pulumi.Input<string>[]>;
44
54
  /**
45
- * The column to show the chart in (zero-based); this value always represents the leftmost column of the chart. (between 0 and 11)
55
+ * Column number for the layout.
46
56
  */
47
57
  column?: pulumi.Input<number>;
48
58
  /**
49
- * How many rows each chart should take up. (greater than or equal to 1)
59
+ * How many rows every chart should take up (greater than or equal to 1). 1 by default.
50
60
  */
51
61
  height?: pulumi.Input<number>;
52
62
  /**
53
- * Number of columns (out of a total of 12) each chart should take up. (between 1 and 12)
63
+ * How many columns (out of a total of `12`) every chart should take up (between `1` and `12`). `12` by default.
54
64
  */
55
65
  width?: pulumi.Input<number>;
56
66
  }
57
67
  export interface DashboardEventOverlay {
58
68
  /**
59
- * Color to use
69
+ * Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
60
70
  */
61
71
  color?: pulumi.Input<string>;
62
72
  /**
63
- * The text displaying in the dropdown menu used to select this event overlay as an active overlay for the dashboard.
73
+ * Text shown in the dropdown when selecting this overlay from the menu.
64
74
  */
65
75
  label?: pulumi.Input<string>;
66
76
  /**
67
- * (false by default) Whether a vertical line should be displayed in the plot at the time the event occurs
77
+ * Show a vertical line for the event. `false` by default.
68
78
  */
69
79
  line?: pulumi.Input<boolean>;
70
80
  /**
71
- * Search term used to define events
81
+ * Search term used to choose the events shown in the overlay.
72
82
  */
73
83
  signal: pulumi.Input<string>;
84
+ /**
85
+ * Each element specifies a filter to use against the signal specified in the `signal`.
86
+ */
74
87
  sources?: pulumi.Input<pulumi.Input<inputs.DashboardEventOverlaySource>[]>;
75
88
  /**
76
- * Source for this event's data. Can be "eventTimeSeries" (default) or "detectorEvents".
89
+ * Can be set to `eventTimeSeries` (the default) to refer to externally reported events, or `detectorEvents` to refer to events from detector triggers.
77
90
  */
78
91
  type?: pulumi.Input<string>;
79
92
  }
80
93
  export interface DashboardEventOverlaySource {
81
94
  /**
82
- * (false by default) Whether this filter should be a "not" filter
95
+ * If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to `false`.
83
96
  */
84
97
  negated?: pulumi.Input<boolean>;
85
98
  /**
86
- * A metric time series dimension or property name
99
+ * The name of a dimension to filter against.
87
100
  */
88
101
  property: pulumi.Input<string>;
89
102
  /**
90
- * List of strings (which will be treated as an OR filter on the property)
103
+ * A list of values to be used with the `property`, they will be combined via `OR`.
91
104
  */
92
105
  values: pulumi.Input<pulumi.Input<string>[]>;
93
106
  }
94
107
  export interface DashboardFilter {
95
108
  /**
96
- * If true, this filter will also match data that does not have the specified property
109
+ * If true, this filter will also match data that doesn't have this property at all.
97
110
  */
98
111
  applyIfExist?: pulumi.Input<boolean>;
99
112
  /**
100
- * (false by default) Whether this filter should be a "not" filter
113
+ * Whether this filter should be a not filter. `false` by default.
101
114
  */
102
115
  negated?: pulumi.Input<boolean>;
103
116
  /**
104
- * A metric time series dimension or property name
117
+ * A metric time series dimension or property name.
105
118
  */
106
119
  property: pulumi.Input<string>;
107
120
  /**
108
- * List of strings (which will be treated as an OR filter on the property)
121
+ * List of of strings (which will be treated as an OR filter on the property).
109
122
  */
110
123
  values: pulumi.Input<pulumi.Input<string>[]>;
111
124
  }
112
125
  export interface DashboardGrid {
113
126
  /**
114
- * Charts to use for the grid
127
+ * List of IDs of the charts to display.
115
128
  */
116
129
  chartIds: pulumi.Input<pulumi.Input<string>[]>;
117
130
  /**
118
- * How many rows each chart should take up. (greater than or equal to 1)
131
+ * How many rows every chart should take up (greater than or equal to `1`). `1` by default.
119
132
  */
120
133
  height?: pulumi.Input<number>;
121
134
  /**
122
- * Number of columns (out of a total of 12, one-based) each chart should take up. (between 1 and 12)
135
+ * How many columns (out of a total of 12) every chart should take up (between `1` and `12`). `12` by default.
123
136
  */
124
137
  width?: pulumi.Input<number>;
125
138
  }
126
139
  export interface DashboardGroupDashboard {
127
140
  /**
128
- * Unique identifier of an association between a dashboard group and a dashboard
141
+ * The ID of the association between the dashboard group and the dashboard
129
142
  */
130
143
  configId?: pulumi.Input<string>;
131
144
  /**
132
- * The label used in the publish statement that displays the plot (metric time series data) you want to customize
145
+ * The dashboard id to mirror
133
146
  */
134
147
  dashboardId: pulumi.Input<string>;
135
148
  /**
136
- * String that provides a description override for a mirrored dashboard
149
+ * The description that will override the original dashboards's description.
137
150
  */
138
151
  descriptionOverride?: pulumi.Input<string>;
139
152
  /**
140
- * Filter to apply to each chart in the dashboard
153
+ * The description that will override the original dashboards's description.
141
154
  */
142
155
  filterOverrides?: pulumi.Input<pulumi.Input<inputs.DashboardGroupDashboardFilterOverride>[]>;
143
156
  /**
144
- * String that provides a name override for a mirrored dashboard
157
+ * The name that will override the original dashboards's name.
145
158
  */
146
159
  nameOverride?: pulumi.Input<string>;
147
160
  /**
@@ -151,15 +164,15 @@ export interface DashboardGroupDashboard {
151
164
  }
152
165
  export interface DashboardGroupDashboardFilterOverride {
153
166
  /**
154
- * (false by default) Whether this filter should be a "not" filter
167
+ * If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to `false`.
155
168
  */
156
169
  negated?: pulumi.Input<boolean>;
157
170
  /**
158
- * A metric time series dimension or property name
171
+ * A metric time series dimension or property name.
159
172
  */
160
173
  property: pulumi.Input<string>;
161
174
  /**
162
- * List of strings (which will be treated as an OR filter on the property)
175
+ * (Optional) List of of strings (which will be treated as an OR filter on the property).
163
176
  */
164
177
  values: pulumi.Input<pulumi.Input<string>[]>;
165
178
  }
@@ -200,108 +213,111 @@ export interface DashboardGroupImportQualifierFilter {
200
213
  }
201
214
  export interface DashboardGroupPermission {
202
215
  /**
203
- * Actions level, possible values: READ, WRITE
216
+ * Action the user, team, or organization can take with the dashboard group. List of values (value can be "READ" or "WRITE").
204
217
  */
205
218
  actions?: pulumi.Input<pulumi.Input<string>[]>;
206
219
  /**
207
- * ID of the principal with access
220
+ * ID of the user, team, or organization for which you're granting permissions.
208
221
  */
209
222
  principalId: pulumi.Input<string>;
210
223
  /**
211
- * Type of principal, possible values: ORG, TEAM, USER
224
+ * Clarify whether this permission configuration is for a user, a team, or an organization. Value can be one of "USER", "TEAM", or "ORG".
212
225
  */
213
226
  principalType: pulumi.Input<string>;
214
227
  }
215
228
  export interface DashboardPermissions {
216
229
  /**
217
- * The custom access control list for this dashboard
230
+ * List of read and write permission configurations to specify which user, team, and organization can view and/or edit your dashboard. Use the `permissions.parent` instead if you want to inherit permissions.
218
231
  */
219
232
  acls?: pulumi.Input<pulumi.Input<inputs.DashboardPermissionsAcl>[]>;
220
233
  /**
221
- * The ID of the dashboard group that this dashboard inherits permissions from
234
+ * ID of the dashboard group you want your dashboard to inherit permissions from. Use the `permissions.acl` instead if you want to specify various read and write permission configurations.
222
235
  */
223
236
  parent?: pulumi.Input<string>;
224
237
  }
225
238
  export interface DashboardPermissionsAcl {
226
239
  /**
227
- * Actions level, possible values: READ, WRITE
240
+ * Action the user, team, or organization can take with the dashboard. List of values (value can be "READ" or "WRITE").
228
241
  */
229
242
  actions?: pulumi.Input<pulumi.Input<string>[]>;
230
243
  /**
231
- * ID of the principal with access
244
+ * ID of the user, team, or organization for which you're granting permissions.
232
245
  */
233
246
  principalId: pulumi.Input<string>;
234
247
  /**
235
- * Type of principal, possible values: ORG, TEAM, USER
248
+ * Clarify whether this permission configuration is for a user, a team, or an organization. Value can be one of "USER", "TEAM", or "ORG".
236
249
  */
237
250
  principalType: pulumi.Input<string>;
238
251
  }
239
252
  export interface DashboardSelectedEventOverlay {
240
253
  /**
241
- * Search term used to define events
254
+ * Search term used to choose the events shown in the overlay.
242
255
  */
243
256
  signal: pulumi.Input<string>;
257
+ /**
258
+ * Each element specifies a filter to use against the signal specified in the `signal`.
259
+ */
244
260
  sources?: pulumi.Input<pulumi.Input<inputs.DashboardSelectedEventOverlaySource>[]>;
245
261
  /**
246
- * Source for this event's data. Can be "eventTimeSeries" (default) or "detectorEvents".
262
+ * Can be set to `eventTimeSeries` (the default) to refer to externally reported events, or `detectorEvents` to refer to events from detector triggers.
247
263
  */
248
264
  type?: pulumi.Input<string>;
249
265
  }
250
266
  export interface DashboardSelectedEventOverlaySource {
251
267
  /**
252
- * (false by default) Whether this filter should be a "not" filter
268
+ * If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to `false`.
253
269
  */
254
270
  negated?: pulumi.Input<boolean>;
255
271
  /**
256
- * A metric time series dimension or property name
272
+ * The name of a dimension to filter against.
257
273
  */
258
274
  property: pulumi.Input<string>;
259
275
  /**
260
- * List of strings (which will be treated as an OR filter on the property)
276
+ * A list of values to be used with the `property`, they will be combined via `OR`.
261
277
  */
262
278
  values: pulumi.Input<pulumi.Input<string>[]>;
263
279
  }
264
280
  export interface DashboardVariable {
265
281
  /**
266
- * An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard
282
+ * An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.
267
283
  */
268
284
  alias: pulumi.Input<string>;
269
285
  /**
270
- * If true, this variable will also match data that does not have the specified property
286
+ * If true, this variable will also match data that doesn't have this property at all.
271
287
  */
272
288
  applyIfExist?: pulumi.Input<boolean>;
273
289
  /**
274
- * Variable description
290
+ * Variable description.
275
291
  */
276
292
  description?: pulumi.Input<string>;
277
293
  /**
278
- * A metric time series dimension or property name
294
+ * A metric time series dimension or property name.
279
295
  */
280
296
  property: pulumi.Input<string>;
281
297
  /**
282
- * If true, this variable will only apply to charts with a filter on the named property.
298
+ * If `true`, this variable will only apply to charts that have a filter for the property.
283
299
  */
284
300
  replaceOnly?: pulumi.Input<boolean>;
285
301
  /**
286
- * If true, this variable may only be set to the values listed in preferredSuggestions. and only these values will appear in autosuggestion menus. false by default
302
+ * If `true`, this variable may only be set to the values listed in `valuesSuggested` and only these values will appear in autosuggestion menus. `false` by default.
287
303
  */
288
304
  restrictedSuggestions?: pulumi.Input<boolean>;
289
305
  /**
290
- * Determines whether a value is required for this variable (and therefore whether it will be possible to view this dashboard without this filter applied). false by default
306
+ * Determines whether a value is required for this variable (and therefore whether it will be possible to view this dashboard without this filter applied). `false` by default.
291
307
  */
292
308
  valueRequired?: pulumi.Input<boolean>;
293
309
  /**
294
- * List of strings (which will be treated as an OR filter on the property)
310
+ * List of of strings (which will be treated as an OR filter on the property).
295
311
  */
296
312
  values?: pulumi.Input<pulumi.Input<string>[]>;
297
313
  /**
298
- * A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable
314
+ * A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.
299
315
  */
300
316
  valuesSuggesteds?: pulumi.Input<pulumi.Input<string>[]>;
301
317
  }
302
318
  export interface DataLinkTargetExternalUrl {
303
319
  /**
304
- * The minimum time window for a search sent to an external site. Depends on the value set for `timeFormat`.
320
+ * The [minimum time window](https://dev.splunk.com/observability/docs/administration/datalinks/) for a search sent to an external site. Defaults to `6000`
305
321
  */
306
322
  minimumTimeWindow?: pulumi.Input<string>;
307
323
  /**
@@ -309,17 +325,17 @@ export interface DataLinkTargetExternalUrl {
309
325
  */
310
326
  name: pulumi.Input<string>;
311
327
  /**
312
- * Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different
328
+ * Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different.
313
329
  */
314
330
  propertyKeyMapping?: pulumi.Input<{
315
331
  [key: string]: pulumi.Input<string>;
316
332
  }>;
317
333
  /**
318
- * Designates the format of minimumTimeWindow in the same data link target object.
334
+ * [Designates the format](https://dev.splunk.com/observability/docs/administration/datalinks/) of `minimumTimeWindow` in the same data link target object. Must be one of `"ISO8601"`, `"EpochSeconds"` or `"Epoch"` (which is milliseconds). Defaults to `"ISO8601"`.
319
335
  */
320
336
  timeFormat?: pulumi.Input<string>;
321
337
  /**
322
- * URL string for a Splunk instance or external system data link target.
338
+ * URL string for a Splunk instance or external system data link target. [See the supported template variables](https://dev.splunk.com/observability/docs/administration/datalinks/).
323
339
  */
324
340
  url: pulumi.Input<string>;
325
341
  }
@@ -333,7 +349,7 @@ export interface DataLinkTargetSignalfxDashboard {
333
349
  */
334
350
  dashboardId: pulumi.Input<string>;
335
351
  /**
336
- * Flag that designates a target as the default for a data link object.
352
+ * Flag that designates a target as the default for a data link object. `true` by default
337
353
  */
338
354
  isDefault?: pulumi.Input<boolean>;
339
355
  /**
@@ -347,7 +363,7 @@ export interface DataLinkTargetSplunk {
347
363
  */
348
364
  name: pulumi.Input<string>;
349
365
  /**
350
- * Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different
366
+ * Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different.
351
367
  */
352
368
  propertyKeyMapping?: pulumi.Input<{
353
369
  [key: string]: pulumi.Input<string>;
@@ -355,45 +371,45 @@ export interface DataLinkTargetSplunk {
355
371
  }
356
372
  export interface DetectorRule {
357
373
  /**
358
- * Description of the rule
374
+ * Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.
359
375
  */
360
376
  description?: pulumi.Input<string>;
361
377
  /**
362
- * A detect label which matches a detect label within the program text
378
+ * A detect label which matches a detect label within `programText`.
363
379
  */
364
380
  detectLabel: pulumi.Input<string>;
365
381
  /**
366
- * (default: false) When true, notifications and events will not be generated for the detect label
382
+ * When true, notifications and events will not be generated for the detect label. `false` by default.
367
383
  */
368
384
  disabled?: pulumi.Input<boolean>;
369
385
  /**
370
- * List of strings specifying where notifications will be sent when an incident occurs. See https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info
386
+ * List of strings specifying where notifications will be sent when an incident occurs. See [Create A Single Detector](https://dev.splunk.com/observability/reference/api/detectors/latest) for more info.
371
387
  */
372
388
  notifications?: pulumi.Input<pulumi.Input<string>[]>;
373
389
  /**
374
- * Custom notification message body when an alert is triggered. See https://developers.signalfx.com/v2/reference#detector-model for more info
390
+ * Custom notification message body when an alert is triggered. See [Set Up Detectors to Trigger Alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/create-detectors-for-alerts.html) for more info.
375
391
  */
376
392
  parameterizedBody?: pulumi.Input<string>;
377
393
  /**
378
- * Custom notification message subject when an alert is triggered. See https://developers.signalfx.com/v2/reference#detector-model for more info
394
+ * Custom notification message subject when an alert is triggered. See [Set Up Detectors to Trigger Alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/create-detectors-for-alerts.html) for more info.
379
395
  */
380
396
  parameterizedSubject?: pulumi.Input<string>;
381
397
  /**
382
- * URL of page to consult when an alert is triggered
398
+ * URL of page to consult when an alert is triggered. This can be used with custom notification messages.
383
399
  */
384
400
  runbookUrl?: pulumi.Input<string>;
385
401
  /**
386
- * The severity of the rule, must be one of: Critical, Warning, Major, Minor, Info
402
+ * The severity of the rule, must be one of: `"Critical"`, `"Major"`, `"Minor"`, `"Warning"`, `"Info"`.
387
403
  */
388
404
  severity: pulumi.Input<string>;
389
405
  /**
390
- * Plain text suggested first course of action, such as a command to execute.
406
+ * Plain text suggested first course of action, such as a command line to execute. This can be used with custom notification messages.
391
407
  */
392
408
  tip?: pulumi.Input<string>;
393
409
  }
394
410
  export interface DetectorVizOption {
395
411
  /**
396
- * Color to use
412
+ * Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
397
413
  */
398
414
  color?: pulumi.Input<string>;
399
415
  /**
@@ -401,11 +417,15 @@ export interface DetectorVizOption {
401
417
  */
402
418
  displayName?: pulumi.Input<string>;
403
419
  /**
404
- * The label used in the publish statement that displays the plot (metric time series data) you want to customize
420
+ * Label used in the publish statement that displays the plot (metric time series data) you want to customize.
405
421
  */
406
422
  label: pulumi.Input<string>;
407
423
  /**
408
- * An arbitrary prefix to display with the value of this plot
424
+ * , `valueSuffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
425
+ *
426
+ * **Notes**
427
+ *
428
+ * Use both `maxDelay` in your detector configuration and an `extrapolation` policy in your program text to reduce false positives and false negatives.
409
429
  */
410
430
  valuePrefix?: pulumi.Input<string>;
411
431
  /**
@@ -413,7 +433,7 @@ export interface DetectorVizOption {
413
433
  */
414
434
  valueSuffix?: pulumi.Input<string>;
415
435
  /**
416
- * A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
436
+ * A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). Values values are `Bit, Kilobit, Megabit, Gigabit, Terabit, Petabit, Exabit, Zettabit, Yottabit, Byte, Kibibyte, Mebibyte, Gibibyte (note: this was previously typoed as Gigibyte), Tebibyte, Pebibyte, Exbibyte, Zebibyte, Yobibyte, Nanosecond, Microsecond, Millisecond, Second, Minute, Hour, Day, Week`.
417
437
  */
418
438
  valueUnit?: pulumi.Input<string>;
419
439
  }
@@ -423,33 +443,33 @@ export interface HeatmapChartColorRange {
423
443
  */
424
444
  color: pulumi.Input<string>;
425
445
  /**
426
- * The maximum value within the coloring range
446
+ * The maximum value within the coloring range.
427
447
  */
428
448
  maxValue?: pulumi.Input<number>;
429
449
  /**
430
- * The minimum value within the coloring range
450
+ * The minimum value within the coloring range.
431
451
  */
432
452
  minValue?: pulumi.Input<number>;
433
453
  }
434
454
  export interface HeatmapChartColorScale {
435
455
  /**
436
- * The color to use. Must be one of gray, blue, light_blue, navy, dark_orange, orange, dark_yellow, magenta, cerise, pink, violet, purple, gray_blue, dark_green, green, aquamarine, red, yellow, vivid_yellow, light_green, or lime_green.
456
+ * The color range to use. Hex values are not supported here. Must be one of gray, blue, light_blue, navy, dark_orange, orange, dark_yellow, magenta, cerise, pink, violet, purple, gray_blue, dark_green, green, aquamarine, red, yellow, vivid_yellow, light_green, or lime_green.
437
457
  */
438
458
  color: pulumi.Input<string>;
439
459
  /**
440
- * Indicates the lower threshold non-inclusive value for this range
460
+ * Indicates the lower threshold non-inclusive value for this range.
441
461
  */
442
462
  gt?: pulumi.Input<number>;
443
463
  /**
444
- * Indicates the lower threshold inclusive value for this range
464
+ * Indicates the lower threshold inclusive value for this range.
445
465
  */
446
466
  gte?: pulumi.Input<number>;
447
467
  /**
448
- * Indicates the upper threshold non-inculsive value for this range
468
+ * Indicates the upper threshold non-inclusive value for this range.
449
469
  */
450
470
  lt?: pulumi.Input<number>;
451
471
  /**
452
- * Indicates the upper threshold inclusive value for this range
472
+ * Indicates the upper threshold inclusive value for this range.
453
473
  */
454
474
  lte?: pulumi.Input<number>;
455
475
  }
@@ -459,35 +479,35 @@ export interface ListChartColorScale {
459
479
  */
460
480
  color: pulumi.Input<string>;
461
481
  /**
462
- * Indicates the lower threshold non-inclusive value for this range
482
+ * Indicates the lower threshold non-inclusive value for this range.
463
483
  */
464
484
  gt?: pulumi.Input<number>;
465
485
  /**
466
- * Indicates the lower threshold inclusive value for this range
486
+ * Indicates the lower threshold inclusive value for this range.
467
487
  */
468
488
  gte?: pulumi.Input<number>;
469
489
  /**
470
- * Indicates the upper threshold non-inculsive value for this range
490
+ * Indicates the upper threshold non-inculsive value for this range.
471
491
  */
472
492
  lt?: pulumi.Input<number>;
473
493
  /**
474
- * Indicates the upper threshold inclusive value for this range
494
+ * Indicates the upper threshold inclusive value for this range.
475
495
  */
476
496
  lte?: pulumi.Input<number>;
477
497
  }
478
498
  export interface ListChartLegendOptionsField {
479
499
  /**
480
- * (true by default) Determines if this property is displayed in the data table.
500
+ * True or False depending on if you want the property to be shown or hidden.
481
501
  */
482
502
  enabled?: pulumi.Input<boolean>;
483
503
  /**
484
- * The name of a property to hide or show in the data table.
504
+ * The name of the property to display. Note the special values of `sfMetric` (corresponding with the API's `Plot Name`) which shows the label of the time series `publish()` and `sf_originatingMetric` (corresponding with the API's `metric (sf metric)`) that shows the [name of the metric](https://dev.splunk.com/observability/docs/signalflow/functions/data_function/) for the time series being displayed.
485
505
  */
486
506
  property: pulumi.Input<string>;
487
507
  }
488
508
  export interface ListChartVizOption {
489
509
  /**
490
- * Color to use
510
+ * The color to use. Must be one of gray, blue, light_blue, navy, dark_orange, orange, dark_yellow, magenta, cerise, pink, violet, purple, gray_blue, dark_green, green, aquamarine, red, yellow, vivid_yellow, light_green, or lime_green.
491
511
  */
492
512
  color?: pulumi.Input<string>;
493
513
  /**
@@ -495,11 +515,11 @@ export interface ListChartVizOption {
495
515
  */
496
516
  displayName?: pulumi.Input<string>;
497
517
  /**
498
- * The label used in the publish statement that displays the plot (metric time series data) you want to customize
518
+ * Label used in the publish statement that displays the plot (metric time series data) you want to customize.
499
519
  */
500
520
  label: pulumi.Input<string>;
501
521
  /**
502
- * An arbitrary prefix to display with the value of this plot
522
+ * , `valueSuffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
503
523
  */
504
524
  valuePrefix?: pulumi.Input<string>;
505
525
  /**
@@ -507,73 +527,73 @@ export interface ListChartVizOption {
507
527
  */
508
528
  valueSuffix?: pulumi.Input<string>;
509
529
  /**
510
- * A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
530
+ * A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). Values values are `Bit, Kilobit, Megabit, Gigabit, Terabit, Petabit, Exabit, Zettabit, Yottabit, Byte, Kibibyte, Mebibyte, Gibibyte (note: this was previously typoed as Gigibyte), Tebibyte, Pebibyte, Exbibyte, Zebibyte, Yobibyte, Nanosecond, Microsecond, Millisecond, Second, Minute, Hour, Day, Week`.
511
531
  */
512
532
  valueUnit?: pulumi.Input<string>;
513
533
  }
514
534
  export interface MetricRulesetAggregationRule {
515
535
  /**
516
- * The aggregator for this rule
536
+ * Aggregator object
517
537
  */
518
538
  aggregators: pulumi.Input<pulumi.Input<inputs.MetricRulesetAggregationRuleAggregator>[]>;
519
539
  /**
520
- * Status of this aggregation rule
540
+ * When false, this rule will not generate aggregated MTSs
521
541
  */
522
542
  enabled: pulumi.Input<boolean>;
523
543
  /**
524
- * The matcher for this rule
544
+ * Matcher object
525
545
  */
526
546
  matchers: pulumi.Input<pulumi.Input<inputs.MetricRulesetAggregationRuleMatcher>[]>;
527
547
  /**
528
- * Name of this aggregation rule
548
+ * name of the aggregation rule
529
549
  */
530
550
  name?: pulumi.Input<string>;
531
551
  }
532
552
  export interface MetricRulesetAggregationRuleAggregator {
533
553
  /**
534
- * List of dimensions to keep or drop in aggregated metric
554
+ * List of dimensions to either be kept or dropped in the new aggregated MTSs
535
555
  */
536
556
  dimensions: pulumi.Input<pulumi.Input<string>[]>;
537
557
  /**
538
- * Flag specifying to keep or drop given dimensions
558
+ * when true, the specified dimensions will be dropped from the aggregated MTSs
539
559
  */
540
560
  dropDimensions: pulumi.Input<boolean>;
541
561
  /**
542
- * The aggregated metric name
562
+ * name of the new aggregated metric
543
563
  */
544
564
  outputName: pulumi.Input<string>;
545
565
  /**
546
- * The type of the aggregator
566
+ * Type of aggregator. Must always be "rollup"
547
567
  */
548
568
  type: pulumi.Input<string>;
549
569
  }
550
570
  export interface MetricRulesetAggregationRuleMatcher {
551
571
  /**
552
- * List of filters to match on
572
+ * List of filters to filter the set of input MTSs
553
573
  */
554
574
  filters?: pulumi.Input<pulumi.Input<inputs.MetricRulesetAggregationRuleMatcherFilter>[]>;
555
575
  /**
556
- * The type of the matcher
576
+ * Type of matcher. Must always be "dimension"
557
577
  */
558
578
  type: pulumi.Input<string>;
559
579
  }
560
580
  export interface MetricRulesetAggregationRuleMatcherFilter {
561
581
  /**
562
- * Flag specifying equals or not equals
582
+ * When true, this filter will match all values not matching the property_values
563
583
  */
564
584
  not: pulumi.Input<boolean>;
565
585
  /**
566
- * Name of dimension to match
586
+ * Name of the dimension
567
587
  */
568
588
  property: pulumi.Input<string>;
569
589
  /**
570
- * List of property values to match
590
+ * Value of the dimension
571
591
  */
572
592
  propertyValues: pulumi.Input<pulumi.Input<string>[]>;
573
593
  }
574
594
  export interface MetricRulesetRoutingRule {
575
595
  /**
576
- * Destination to send the input metric
596
+ * end destination of the input metric. Must be `RealTime` or `Drop`
577
597
  */
578
598
  destination: pulumi.Input<string>;
579
599
  }
@@ -589,11 +609,11 @@ export interface OrgTokenDpmLimits {
589
609
  }
590
610
  export interface OrgTokenHostOrUsageLimits {
591
611
  /**
592
- * Max number of containers that can use this token
612
+ * Max number of Docker containers that can use this token
593
613
  */
594
614
  containerLimit?: pulumi.Input<number>;
595
615
  /**
596
- * Notification threshold for containers
616
+ * Notification threshold for Docker containers
597
617
  */
598
618
  containerNotificationThreshold?: pulumi.Input<number>;
599
619
  /**
@@ -605,11 +625,11 @@ export interface OrgTokenHostOrUsageLimits {
605
625
  */
606
626
  customMetricsNotificationThreshold?: pulumi.Input<number>;
607
627
  /**
608
- * Max number of high-res metrics that can be sent with this token
628
+ * Max number of hi-res metrics that can be sent with this toke
609
629
  */
610
630
  highResMetricsLimit?: pulumi.Input<number>;
611
631
  /**
612
- * Notification threshold for high-res metrics
632
+ * Notification threshold for hi-res metrics
613
633
  */
614
634
  highResMetricsNotificationThreshold?: pulumi.Input<number>;
615
635
  /**
@@ -627,25 +647,25 @@ export interface SingleValueChartColorScale {
627
647
  */
628
648
  color: pulumi.Input<string>;
629
649
  /**
630
- * Indicates the lower threshold non-inclusive value for this range
650
+ * Indicates the lower threshold non-inclusive value for this range.
631
651
  */
632
652
  gt?: pulumi.Input<number>;
633
653
  /**
634
- * Indicates the lower threshold inclusive value for this range
654
+ * Indicates the lower threshold inclusive value for this range.
635
655
  */
636
656
  gte?: pulumi.Input<number>;
637
657
  /**
638
- * Indicates the upper threshold non-inculsive value for this range
658
+ * Indicates the upper threshold non-inculsive value for this range.
639
659
  */
640
660
  lt?: pulumi.Input<number>;
641
661
  /**
642
- * Indicates the upper threshold inclusive value for this range
662
+ * Indicates the upper threshold inclusive value for this range.
643
663
  */
644
664
  lte?: pulumi.Input<number>;
645
665
  }
646
666
  export interface SingleValueChartVizOption {
647
667
  /**
648
- * Color to use
668
+ * The color to use. Must be one of gray, blue, light_blue, navy, dark_orange, orange, dark_yellow, magenta, cerise, pink, violet, purple, gray_blue, dark_green, green, aquamarine, red, yellow, vivid_yellow, light_green, or lime_green.
649
669
  */
650
670
  color?: pulumi.Input<string>;
651
671
  /**
@@ -653,11 +673,11 @@ export interface SingleValueChartVizOption {
653
673
  */
654
674
  displayName?: pulumi.Input<string>;
655
675
  /**
656
- * The label used in the publish statement that displays the plot (metric time series data) you want to customize
676
+ * Label used in the publish statement that displays the plot (metric time series data) you want to customize.
657
677
  */
658
678
  label: pulumi.Input<string>;
659
679
  /**
660
- * An arbitrary prefix to display with the value of this plot
680
+ * , `valueSuffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
661
681
  */
662
682
  valuePrefix?: pulumi.Input<string>;
663
683
  /**
@@ -665,39 +685,39 @@ export interface SingleValueChartVizOption {
665
685
  */
666
686
  valueSuffix?: pulumi.Input<string>;
667
687
  /**
668
- * A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
688
+ * A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). Values values are `Bit, Kilobit, Megabit, Gigabit, Terabit, Petabit, Exabit, Zettabit, Yottabit, Byte, Kibibyte, Mebibyte, Gibibyte (note: this was previously typoed as Gigibyte), Tebibyte, Pebibyte, Exbibyte, Zebibyte, Yobibyte, Nanosecond, Microsecond, Millisecond, Second, Minute, Hour, Day, Week`.
669
689
  */
670
690
  valueUnit?: pulumi.Input<string>;
671
691
  }
672
692
  export interface SloInput {
673
693
  /**
674
- * Label used in `programText` that refers to the data block which contains the stream of successful events
694
+ * Label used in `"programText"` that refers to the data block which contains the stream of successful events
675
695
  */
676
696
  goodEventsLabel?: pulumi.Input<string>;
677
697
  /**
678
- * Signalflow program text for the SLO. More info at "https://dev.splunk.com/observability/docs/signalflow". We require this Signalflow program text to contain at least 2 data blocks - one for the total stream and one for the good stream, whose labels are specified by goodEventsLabel and totalEventsLabel
698
+ * SignalFlow program and arguments text strings that define the streams used as successful event count and total event count
679
699
  */
680
700
  programText: pulumi.Input<string>;
681
701
  /**
682
- * Label used in `programText` that refers to the data block which contains the stream of total events
702
+ * Label used in `"programText"` that refers to the data block which contains the stream of total events
683
703
  */
684
704
  totalEventsLabel?: pulumi.Input<string>;
685
705
  }
686
706
  export interface SloTarget {
687
707
  /**
688
- * SLO alert rules
708
+ * List of alert rules you want to set for this SLO target. An SLO alert rule of type BREACH is always required.
689
709
  */
690
710
  alertRules: pulumi.Input<pulumi.Input<inputs.SloTargetAlertRule>[]>;
691
711
  /**
692
- * (Required for `RollingWindow` type) Compliance period of this SLO. This value must be within the range of 1d (1 days) to 30d (30 days), inclusive.
712
+ * Compliance period of this SLO. This value must be within the range of 1d (1 days) to 30d (30 days), inclusive.
693
713
  */
694
714
  compliancePeriod?: pulumi.Input<string>;
695
715
  /**
696
- * (Optional for `CalendarWindow` type) It can be used to change the cycle start time. For example, you can specify sunday as the start of the week (instead of the default monday)
716
+ * It can be used to change the cycle start time. For example, you can specify sunday as the start of the week (instead of the default monday)
697
717
  */
698
718
  cycleStart?: pulumi.Input<string>;
699
719
  /**
700
- * (Required for `CalendarWindow` type) The cycle type of the calendar window, e.g. week, month.
720
+ * The cycle type of the calendar window, e.g. week, month.
701
721
  */
702
722
  cycleType?: pulumi.Input<string>;
703
723
  /**
@@ -705,39 +725,39 @@ export interface SloTarget {
705
725
  */
706
726
  slo: pulumi.Input<number>;
707
727
  /**
708
- * SLO target type can be the following type: `RollingWindow`
728
+ * SLO target type can be the following type: `"RollingWindow"`, `"CalendarWindow"`
709
729
  */
710
730
  type: pulumi.Input<string>;
711
731
  }
712
732
  export interface SloTargetAlertRule {
713
733
  /**
714
- * Set of rules used for alerting
734
+ * Set of rules used for alerting.
715
735
  */
716
736
  rules: pulumi.Input<pulumi.Input<inputs.SloTargetAlertRuleRule>[]>;
717
737
  /**
718
- * SLO alert rule type
738
+ * SLO alert rule can be one of the following types: BREACH, ERROR_BUDGET_LEFT, BURN_RATE. Within an SLO object, you can only specify one SLO alertRule per type. For example, you can't specify two alertRule of type BREACH. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
719
739
  */
720
740
  type: pulumi.Input<string>;
721
741
  }
722
742
  export interface SloTargetAlertRuleRule {
723
743
  /**
724
- * Description of the rule
744
+ * Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.
725
745
  */
726
746
  description?: pulumi.Input<string>;
727
747
  /**
728
- * (default: false) When true, notifications and events will not be generated for the detect label
748
+ * When true, notifications and events will not be generated for the detect label. `false` by default.
729
749
  */
730
750
  disabled?: pulumi.Input<boolean>;
731
751
  /**
732
- * List of strings specifying where notifications will be sent when an incident occurs. See https://developers.signalfx.com/v2/docs/detector-model#notifications-models for more info
752
+ * List of strings specifying where notifications will be sent when an incident occurs. See [Create SLO](https://dev.splunk.com/observability/reference/api/slo/latest#endpoint-create-new-slo) for more info.
733
753
  */
734
754
  notifications?: pulumi.Input<pulumi.Input<string>[]>;
735
755
  /**
736
- * Custom notification message body when an alert is triggered. See https://developers.signalfx.com/v2/reference#detector-model for more info
756
+ * Custom notification message body when an alert is triggered. See [Alert message](https://docs.splunk.com/observability/en/alerts-detectors-notifications/create-detectors-for-alerts.html#alert-messages) for more info.
737
757
  */
738
758
  parameterizedBody?: pulumi.Input<string>;
739
759
  /**
740
- * Custom notification message subject when an alert is triggered. See https://developers.signalfx.com/v2/reference#detector-model for more info
760
+ * Custom notification message subject when an alert is triggered. See [Alert message](https://docs.splunk.com/observability/en/alerts-detectors-notifications/create-detectors-for-alerts.html#alert-messages) for more info.
741
761
  */
742
762
  parameterizedSubject?: pulumi.Input<string>;
743
763
  /**
@@ -745,53 +765,53 @@ export interface SloTargetAlertRuleRule {
745
765
  */
746
766
  parameters?: pulumi.Input<inputs.SloTargetAlertRuleRuleParameters>;
747
767
  /**
748
- * URL of page to consult when an alert is triggered
768
+ * URL of page to consult when an alert is triggered. This can be used with custom notification messages.
749
769
  */
750
770
  runbookUrl?: pulumi.Input<string>;
751
771
  /**
752
- * The severity of the rule, must be one of: Critical, Warning, Major, Minor, Info
772
+ * The severity of the rule, must be one of: `"Critical"`, `"Major"`, `"Minor"`, `"Warning"`, `"Info"`.
753
773
  */
754
774
  severity: pulumi.Input<string>;
755
775
  /**
756
- * Plain text suggested first course of action, such as a command to execute.
776
+ * Plain text suggested first course of action, such as a command line to execute. This can be used with custom notification messages.
757
777
  */
758
778
  tip?: pulumi.Input<string>;
759
779
  }
760
780
  export interface SloTargetAlertRuleRuleParameters {
761
781
  /**
762
- * Burn rate threshold 1 used in burn rate alert calculation. This value must be between 0 and 100/(100-SLO target). Note: BURN_RATE alert rules use the burnRateThreshold1 parameter.
782
+ * Burn rate threshold 1 used in burn rate alert calculation. This value must be between 0 and 100/(100-SLO target). Note: `"BURN_RATE"` alert rules use the `"burnRateThreshold1"` parameter. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
763
783
  */
764
784
  burnRateThreshold1?: pulumi.Input<number>;
765
785
  /**
766
- * Burn rate threshold 2 used in burn rate alert calculation. This value must be between 0 and 100/(100-SLO target). Note: BURN_RATE alert rules use the burnRateThreshold2 parameter.
786
+ * Burn rate threshold 2 used in burn rate alert calculation. This value must be between 0 and 100/(100-SLO target). Note: `"BURN_RATE"` alert rules use the `"burnRateThreshold2"` parameter. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
767
787
  */
768
788
  burnRateThreshold2?: pulumi.Input<number>;
769
789
  /**
770
- * Duration that indicates how long the alert condition is met before the alert is triggered. The value must be positive and smaller than the compliance period of the SLO target. Note: BREACH and ERROR_BUDGET_LEFT alert rules use the fireLasting parameter
790
+ * Duration that indicates how long the alert condition is met before the alert is triggered. The value must be positive and smaller than the compliance period of the SLO target. Note: `"BREACH"` and `"ERROR_BUDGET_LEFT"` alert rules use the fireLasting parameter. Default: `"5m"`
771
791
  */
772
792
  fireLasting?: pulumi.Input<string>;
773
793
  /**
774
- * Long window 1 used in burn rate alert calculation. This value must be longer than shortWindow1` and shorter than 90 days. Note: BURN_RATE alert rules use the longWindow1 parameter.
794
+ * Long window 1 used in burn rate alert calculation. This value must be longer than `"shortWindow1"` and shorter than 90 days. Note: `"BURN_RATE"` alert rules use the `"longWindow1"` parameter. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
775
795
  */
776
796
  longWindow1?: pulumi.Input<string>;
777
797
  /**
778
- * Long window 2 used in burn rate alert calculation. This value must be longer than shortWindow2` and shorter than 90 days. Note: BURN_RATE alert rules use the longWindow2 parameter.
798
+ * Long window 2 used in burn rate alert calculation. This value must be longer than `"shortWindow2"` and shorter than 90 days. Note: `"BURN_RATE"` alert rules use the `"longWindow2"` parameter. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
779
799
  */
780
800
  longWindow2?: pulumi.Input<string>;
781
801
  /**
782
- * Error budget must be equal to or smaller than this percentage for the alert to be triggered. Note: ERROR_BUDGET_LEFT alert rules use the percentErrorBudgetLeft parameter.
802
+ * Error budget must be equal to or smaller than this percentage for the alert to be triggered. Note: `"ERROR_BUDGET_LEFT"` alert rules use the `"percentErrorBudgetLeft"` parameter. Default: `100`
783
803
  */
784
804
  percentErrorBudgetLeft?: pulumi.Input<number>;
785
805
  /**
786
- * Percentage of the fireLasting duration that the alert condition is met before the alert is triggered. Note: BREACH and ERROR_BUDGET_LEFT alert rules use the percentOfLasting parameter
806
+ * Percentage of the `"fireLasting"` duration that the alert condition is met before the alert is triggered. Note: `"BREACH"` and `"ERROR_BUDGET_LEFT"` alert rules use the `"percentOfLasting"` parameter. Default: `100`
787
807
  */
788
808
  percentOfLasting?: pulumi.Input<number>;
789
809
  /**
790
- * Short window 1 used in burn rate alert calculation. This value must be longer than 1/30 of long_window_1. Note: BURN_RATE alert rules use the shortWindow1 parameter.
810
+ * Short window 1 used in burn rate alert calculation. This value must be longer than 1/30 of `"longWindow1"`. Note: `"BURN_RATE"` alert rules use the `"shortWindow1"` parameter. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
791
811
  */
792
812
  shortWindow1?: pulumi.Input<string>;
793
813
  /**
794
- * Short window 2 used in burn rate alert calculation. This value must be longer than 1/30 of long_window_2. Note: BURN_RATE alert rules use the shortWindow2 parameter.
814
+ * Short window 2 used in burn rate alert calculation. This value must be longer than 1/30 of `"longWindow2"`. Note: `"BURN_RATE"` alert rules use the `"shortWindow2"` parameter. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
795
815
  */
796
816
  shortWindow2?: pulumi.Input<string>;
797
817
  }
@@ -823,31 +843,31 @@ export interface TableChartVizOption {
823
843
  }
824
844
  export interface TimeChartAxisLeft {
825
845
  /**
826
- * A line to draw as a high watermark
846
+ * A line to draw as a high watermark.
827
847
  */
828
848
  highWatermark?: pulumi.Input<number>;
829
849
  /**
830
- * A label to attach to the high watermark line
850
+ * A label to attach to the high watermark line.
831
851
  */
832
852
  highWatermarkLabel?: pulumi.Input<string>;
833
853
  /**
834
- * Label of the left axis
854
+ * Label of the left axis.
835
855
  */
836
856
  label?: pulumi.Input<string>;
837
857
  /**
838
- * A line to draw as a low watermark
858
+ * A line to draw as a low watermark.
839
859
  */
840
860
  lowWatermark?: pulumi.Input<number>;
841
861
  /**
842
- * A label to attach to the low watermark line
862
+ * A label to attach to the low watermark line.
843
863
  */
844
864
  lowWatermarkLabel?: pulumi.Input<string>;
845
865
  /**
846
- * The maximum value for the left axis
866
+ * The maximum value for the left axis.
847
867
  */
848
868
  maxValue?: pulumi.Input<number>;
849
869
  /**
850
- * The minimum value for the left axis
870
+ * The minimum value for the left axis.
851
871
  */
852
872
  minValue?: pulumi.Input<number>;
853
873
  watermarks?: pulumi.Input<pulumi.Input<inputs.TimeChartAxisLeftWatermark>[]>;
@@ -864,31 +884,31 @@ export interface TimeChartAxisLeftWatermark {
864
884
  }
865
885
  export interface TimeChartAxisRight {
866
886
  /**
867
- * A line to draw as a high watermark
887
+ * A line to draw as a high watermark.
868
888
  */
869
889
  highWatermark?: pulumi.Input<number>;
870
890
  /**
871
- * A label to attach to the high watermark line
891
+ * A label to attach to the high watermark line.
872
892
  */
873
893
  highWatermarkLabel?: pulumi.Input<string>;
874
894
  /**
875
- * Label of the right axis
895
+ * Label of the right axis.
876
896
  */
877
897
  label?: pulumi.Input<string>;
878
898
  /**
879
- * A line to draw as a low watermark
899
+ * A line to draw as a low watermark.
880
900
  */
881
901
  lowWatermark?: pulumi.Input<number>;
882
902
  /**
883
- * A label to attach to the low watermark line
903
+ * A label to attach to the low watermark line.
884
904
  */
885
905
  lowWatermarkLabel?: pulumi.Input<string>;
886
906
  /**
887
- * The maximum value for the right axis
907
+ * The maximum value for the right axis.
888
908
  */
889
909
  maxValue?: pulumi.Input<number>;
890
910
  /**
891
- * The minimum value for the right axis
911
+ * The minimum value for the right axis.
892
912
  */
893
913
  minValue?: pulumi.Input<number>;
894
914
  watermarks?: pulumi.Input<pulumi.Input<inputs.TimeChartAxisRightWatermark>[]>;
@@ -905,7 +925,7 @@ export interface TimeChartAxisRightWatermark {
905
925
  }
906
926
  export interface TimeChartEventOption {
907
927
  /**
908
- * Color to use
928
+ * Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
909
929
  */
910
930
  color?: pulumi.Input<string>;
911
931
  /**
@@ -913,33 +933,33 @@ export interface TimeChartEventOption {
913
933
  */
914
934
  displayName?: pulumi.Input<string>;
915
935
  /**
916
- * The label used in the publish statement that displays the events you want to customize
936
+ * Label used in the publish statement that displays the event query you want to customize.
917
937
  */
918
938
  label: pulumi.Input<string>;
919
939
  }
920
940
  export interface TimeChartHistogramOption {
921
941
  /**
922
- * Base color theme to use for the graph.
942
+ * Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine, red, gold, greenyellow, chartreuse, jade
923
943
  */
924
944
  colorTheme?: pulumi.Input<string>;
925
945
  }
926
946
  export interface TimeChartLegendOptionsField {
927
947
  /**
928
- * (true by default) Determines if this property is displayed in the data table.
948
+ * True or False depending on if you want the property to be shown or hidden.
929
949
  */
930
950
  enabled?: pulumi.Input<boolean>;
931
951
  /**
932
- * The name of a property to hide or show in the data table.
952
+ * The name of the property to display. Note the special values of `plotLabel` (corresponding with the API's `sfMetric`) which shows the label of the time series `publish()` and `metric` (corresponding with the API's `sf_originatingMetric`) that shows the name of the metric for the time series being displayed.
933
953
  */
934
954
  property: pulumi.Input<string>;
935
955
  }
936
956
  export interface TimeChartVizOption {
937
957
  /**
938
- * The Y-axis associated with values for this plot. Must be either "right" or "left". Defaults to "left".
958
+ * Y-axis associated with values for this plot. Must be either `right` or `left`.
939
959
  */
940
960
  axis?: pulumi.Input<string>;
941
961
  /**
942
- * Color to use
962
+ * Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
943
963
  */
944
964
  color?: pulumi.Input<string>;
945
965
  /**
@@ -947,15 +967,15 @@ export interface TimeChartVizOption {
947
967
  */
948
968
  displayName?: pulumi.Input<string>;
949
969
  /**
950
- * The label used in the publish statement that displays the plot (metric time series data) you want to customize
970
+ * Label used in the publish statement that displays the plot (metric time series data) you want to customize.
951
971
  */
952
972
  label: pulumi.Input<string>;
953
973
  /**
954
- * (Chart plotType by default) The visualization style to use. Must be "LineChart", "AreaChart", "ColumnChart", or "Histogram"
974
+ * The visualization style to use. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Chart level `plotType` by default.
955
975
  */
956
976
  plotType?: pulumi.Input<string>;
957
977
  /**
958
- * An arbitrary prefix to display with the value of this plot
978
+ * , `valueSuffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
959
979
  */
960
980
  valuePrefix?: pulumi.Input<string>;
961
981
  /**
@@ -963,30 +983,36 @@ export interface TimeChartVizOption {
963
983
  */
964
984
  valueSuffix?: pulumi.Input<string>;
965
985
  /**
966
- * A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
986
+ * A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes). Values values are `Bit, Kilobit, Megabit, Gigabit, Terabit, Petabit, Exabit, Zettabit, Yottabit, Byte, Kibibyte, Mebibyte, Gibibyte (note: this was previously typoed as Gigibyte), Tebibyte, Pebibyte, Exbibyte, Zebibyte, Yobibyte, Nanosecond, Microsecond, Millisecond, Second, Minute, Hour, Day, Week`.
967
987
  */
968
988
  valueUnit?: pulumi.Input<string>;
969
989
  }
970
990
  export interface WebhookIntegrationHeader {
991
+ /**
992
+ * The key of the header to send
993
+ */
971
994
  headerKey: pulumi.Input<string>;
995
+ /**
996
+ * The value of the header to send
997
+ */
972
998
  headerValue: pulumi.Input<string>;
973
999
  }
974
1000
  export declare namespace aws {
975
1001
  interface IntegrationCustomNamespaceSyncRule {
976
1002
  /**
977
- * Controls the Splunk Observability default behavior for processing data from an AWS namespace. Splunk Observability ignores this property unless you specify the `filterAction` and `filterSource` properties. If you do specify them, use this property to control how Splunk Observability treats data that doesn't match the filter. The available actions are one of "Include" or "Exclude".
1003
+ * Controls the Splunk Observability Cloud default behavior for processing data from an AWS namespace. Splunk Observability Cloud ignores this property unless you specify the `filterAction` and `filterSource` properties. If you do specify them, use this property to control how Splunk Observability Cloud treats data that doesn't match the filter. The available actions are one of `"Include"` or `"Exclude"`.
978
1004
  */
979
1005
  defaultAction?: pulumi.Input<string>;
980
1006
  /**
981
- * Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
1007
+ * Controls how Splunk Observability Cloud processes data from a custom AWS namespace. The available actions are one of `"Include"` or `"Exclude"`.
982
1008
  */
983
1009
  filterAction?: pulumi.Input<string>;
984
1010
  /**
985
- * Expression that selects the data that Splunk Observability should sync for the custom namespace associated with this sync rule. The expression uses the syntax defined for the SignalFlow `filter()` function; it can be any valid SignalFlow filter expression.
1011
+ * Expression that selects the data that Splunk Observability Cloud should sync for the custom namespace associated with this sync rule. The expression uses the syntax defined for the SignalFlow `filter()` function; it can be any valid SignalFlow filter expression.
986
1012
  */
987
1013
  filterSource?: pulumi.Input<string>;
988
1014
  /**
989
- * An AWS custom namespace having custom AWS metrics that you want to sync with Splunk Observability. See the AWS documentation on publishing metrics for more information.
1015
+ * An AWS custom namespace having custom AWS metrics that you want to sync with Splunk Observability Cloud. See the AWS documentation on publishing metrics for more information.
990
1016
  */
991
1017
  namespace: pulumi.Input<string>;
992
1018
  }
@@ -1006,19 +1032,19 @@ export declare namespace aws {
1006
1032
  }
1007
1033
  interface IntegrationNamespaceSyncRule {
1008
1034
  /**
1009
- * Controls the Splunk Observability default behavior for processing data from an AWS namespace. Splunk Observability ignores this property unless you specify the `filterAction` and `filterSource` properties. If you do specify them, use this property to control how Splunk Observability treats data that doesn't match the filter. The available actions are one of "Include" or "Exclude".
1035
+ * Controls the Splunk Observability Cloud default behavior for processing data from an AWS namespace. Splunk Observability Cloud ignores this property unless you specify the `filterAction` and `filterSource` properties. If you do specify them, use this property to control how Splunk Observability Cloud treats data that doesn't match the filter. The available actions are one of `"Include"` or `"Exclude"`.
1010
1036
  */
1011
1037
  defaultAction?: pulumi.Input<string>;
1012
1038
  /**
1013
- * Controls how Splunk Observability processes data from a custom AWS namespace. The available actions are one of "Include" or "Exclude".
1039
+ * Controls how Splunk Observability Cloud processes data from a custom AWS namespace. The available actions are one of `"Include"` or `"Exclude"`.
1014
1040
  */
1015
1041
  filterAction?: pulumi.Input<string>;
1016
1042
  /**
1017
- * Expression that selects the data that Splunk Observability should sync for the custom namespace associated with this sync rule. The expression uses the syntax defined for the SignalFlow `filter()` function; it can be any valid SignalFlow filter expression.
1043
+ * Expression that selects the data that Splunk Observability Cloud should sync for the custom namespace associated with this sync rule. The expression uses the syntax defined for the SignalFlow `filter()` function; it can be any valid SignalFlow filter expression.
1018
1044
  */
1019
1045
  filterSource?: pulumi.Input<string>;
1020
1046
  /**
1021
- * An AWS namespace having custom AWS metrics that you want to sync with Splunk Observability. See the AWS documentation on publishing metrics for more information.
1047
+ * An AWS custom namespace having custom AWS metrics that you want to sync with Splunk Observability Cloud. See `services` field description below for additional information.
1022
1048
  */
1023
1049
  namespace: pulumi.Input<string>;
1024
1050
  }
@@ -1026,15 +1052,18 @@ export declare namespace aws {
1026
1052
  export declare namespace azure {
1027
1053
  interface IntegrationCustomNamespacesPerService {
1028
1054
  /**
1029
- * The namespaces to sync
1055
+ * The additional namespaces.
1030
1056
  */
1031
1057
  namespaces: pulumi.Input<pulumi.Input<string>[]>;
1032
1058
  /**
1033
- * The name of the service
1059
+ * The name of the service.
1034
1060
  */
1035
1061
  service: pulumi.Input<string>;
1036
1062
  }
1037
1063
  interface IntegrationResourceFilterRule {
1064
+ /**
1065
+ * Expression that selects the data that Splunk Observability Cloud should sync for the resource associated with this sync rule. The expression uses the syntax defined for the SignalFlow `filter()` function. The source of each filter rule must be in the form filter('key', 'value'). You can join multiple filter statements using the and and or operators. Referenced keys are limited to tags and must start with the azure_tag_ prefix.
1066
+ */
1038
1067
  filterSource: pulumi.Input<string>;
1039
1068
  }
1040
1069
  }
@@ -1047,7 +1076,7 @@ export declare namespace gcp {
1047
1076
  export declare namespace log {
1048
1077
  interface ViewColumn {
1049
1078
  /**
1050
- * Name of the column
1079
+ * Name of the log view.
1051
1080
  */
1052
1081
  name: pulumi.Input<string>;
1053
1082
  }