pulumi-signalfx 7.2.0a1709367777__py3-none-any.whl → 7.6.0a1736835428__py3-none-any.whl
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.
- pulumi_signalfx/__init__.py +9 -0
- pulumi_signalfx/_inputs.py +1976 -339
- pulumi_signalfx/_utilities.py +41 -5
- pulumi_signalfx/alert_muting_rule.py +110 -86
- pulumi_signalfx/aws/_inputs.py +85 -16
- pulumi_signalfx/aws/external_integration.py +20 -275
- pulumi_signalfx/aws/integration.py +222 -367
- pulumi_signalfx/aws/outputs.py +21 -16
- pulumi_signalfx/aws/token_integration.py +46 -65
- pulumi_signalfx/azure/_inputs.py +41 -4
- pulumi_signalfx/azure/integration.py +144 -259
- pulumi_signalfx/azure/outputs.py +15 -4
- pulumi_signalfx/config/__init__.pyi +22 -0
- pulumi_signalfx/config/vars.py +28 -0
- pulumi_signalfx/dashboard.py +171 -186
- pulumi_signalfx/dashboard_group.py +131 -198
- pulumi_signalfx/data_link.py +76 -141
- pulumi_signalfx/detector.py +264 -369
- pulumi_signalfx/event_feed_chart.py +51 -82
- pulumi_signalfx/gcp/_inputs.py +51 -0
- pulumi_signalfx/gcp/integration.py +224 -192
- pulumi_signalfx/gcp/outputs.py +44 -0
- pulumi_signalfx/get_dimension_values.py +47 -24
- pulumi_signalfx/heatmap_chart.py +165 -228
- pulumi_signalfx/jira/integration.py +70 -119
- pulumi_signalfx/list_chart.py +219 -315
- pulumi_signalfx/log/_inputs.py +33 -2
- pulumi_signalfx/log/outputs.py +7 -2
- pulumi_signalfx/log/timeline.py +64 -99
- pulumi_signalfx/log/view.py +134 -173
- pulumi_signalfx/metric_ruleset.py +217 -70
- pulumi_signalfx/opsgenie/integration.py +41 -60
- pulumi_signalfx/org_token.py +97 -128
- pulumi_signalfx/outputs.py +661 -339
- pulumi_signalfx/pagerduty/get_integration.py +22 -21
- pulumi_signalfx/pagerduty/integration.py +34 -49
- pulumi_signalfx/provider.py +99 -0
- pulumi_signalfx/pulumi-plugin.json +2 -1
- pulumi_signalfx/servicenow/integration.py +52 -107
- pulumi_signalfx/single_value_chart.py +113 -178
- pulumi_signalfx/slack/integration.py +30 -47
- pulumi_signalfx/slo.py +99 -197
- pulumi_signalfx/slo_chart.py +197 -0
- pulumi_signalfx/table_chart.py +50 -75
- pulumi_signalfx/team.py +74 -109
- pulumi_signalfx/text_chart.py +64 -89
- pulumi_signalfx/time_chart.py +271 -400
- pulumi_signalfx/victorops/integration.py +30 -47
- pulumi_signalfx/webhook_integration.py +154 -75
- {pulumi_signalfx-7.2.0a1709367777.dist-info → pulumi_signalfx-7.6.0a1736835428.dist-info}/METADATA +7 -6
- pulumi_signalfx-7.6.0a1736835428.dist-info/RECORD +65 -0
- {pulumi_signalfx-7.2.0a1709367777.dist-info → pulumi_signalfx-7.6.0a1736835428.dist-info}/WHEEL +1 -1
- pulumi_signalfx-7.2.0a1709367777.dist-info/RECORD +0 -64
- {pulumi_signalfx-7.2.0a1709367777.dist-info → pulumi_signalfx-7.6.0a1736835428.dist-info}/top_level.txt +0 -0
pulumi_signalfx/outputs.py
CHANGED
|
@@ -4,14 +4,20 @@
|
|
|
4
4
|
|
|
5
5
|
import copy
|
|
6
6
|
import warnings
|
|
7
|
+
import sys
|
|
7
8
|
import pulumi
|
|
8
9
|
import pulumi.runtime
|
|
9
10
|
from typing import Any, Mapping, Optional, Sequence, Union, overload
|
|
11
|
+
if sys.version_info >= (3, 11):
|
|
12
|
+
from typing import NotRequired, TypedDict, TypeAlias
|
|
13
|
+
else:
|
|
14
|
+
from typing_extensions import NotRequired, TypedDict, TypeAlias
|
|
10
15
|
from . import _utilities
|
|
11
16
|
from . import outputs
|
|
12
17
|
|
|
13
18
|
__all__ = [
|
|
14
19
|
'AlertMutingRuleFilter',
|
|
20
|
+
'AlertMutingRuleRecurrence',
|
|
15
21
|
'DashboardChart',
|
|
16
22
|
'DashboardColumn',
|
|
17
23
|
'DashboardEventOverlay',
|
|
@@ -43,6 +49,10 @@ __all__ = [
|
|
|
43
49
|
'MetricRulesetAggregationRuleAggregator',
|
|
44
50
|
'MetricRulesetAggregationRuleMatcher',
|
|
45
51
|
'MetricRulesetAggregationRuleMatcherFilter',
|
|
52
|
+
'MetricRulesetExceptionRule',
|
|
53
|
+
'MetricRulesetExceptionRuleMatcher',
|
|
54
|
+
'MetricRulesetExceptionRuleMatcherFilter',
|
|
55
|
+
'MetricRulesetExceptionRuleRestoration',
|
|
46
56
|
'MetricRulesetRoutingRule',
|
|
47
57
|
'OrgTokenDpmLimits',
|
|
48
58
|
'OrgTokenHostOrUsageLimits',
|
|
@@ -89,9 +99,9 @@ class AlertMutingRuleFilter(dict):
|
|
|
89
99
|
property_value: str,
|
|
90
100
|
negated: Optional[bool] = None):
|
|
91
101
|
"""
|
|
92
|
-
:param str property:
|
|
93
|
-
:param str property_value:
|
|
94
|
-
:param bool negated:
|
|
102
|
+
:param str property: The property to filter.
|
|
103
|
+
:param str property_value: The property value to filter.
|
|
104
|
+
:param bool negated: Determines if this is a "not" filter. Defaults to `false`.
|
|
95
105
|
"""
|
|
96
106
|
pulumi.set(__self__, "property", property)
|
|
97
107
|
pulumi.set(__self__, "property_value", property_value)
|
|
@@ -102,7 +112,7 @@ class AlertMutingRuleFilter(dict):
|
|
|
102
112
|
@pulumi.getter(name="propertyValue")
|
|
103
113
|
def property_value(self) -> str:
|
|
104
114
|
"""
|
|
105
|
-
|
|
115
|
+
The property value to filter.
|
|
106
116
|
"""
|
|
107
117
|
return pulumi.get(self, "property_value")
|
|
108
118
|
|
|
@@ -110,7 +120,7 @@ class AlertMutingRuleFilter(dict):
|
|
|
110
120
|
@pulumi.getter
|
|
111
121
|
def negated(self) -> Optional[bool]:
|
|
112
122
|
"""
|
|
113
|
-
|
|
123
|
+
Determines if this is a "not" filter. Defaults to `false`.
|
|
114
124
|
"""
|
|
115
125
|
return pulumi.get(self, "negated")
|
|
116
126
|
|
|
@@ -118,11 +128,40 @@ class AlertMutingRuleFilter(dict):
|
|
|
118
128
|
@pulumi.getter
|
|
119
129
|
def property(self) -> str:
|
|
120
130
|
"""
|
|
121
|
-
|
|
131
|
+
The property to filter.
|
|
122
132
|
"""
|
|
123
133
|
return pulumi.get(self, "property")
|
|
124
134
|
|
|
125
135
|
|
|
136
|
+
@pulumi.output_type
|
|
137
|
+
class AlertMutingRuleRecurrence(dict):
|
|
138
|
+
def __init__(__self__, *,
|
|
139
|
+
unit: str,
|
|
140
|
+
value: int):
|
|
141
|
+
"""
|
|
142
|
+
:param str unit: The unit of the period. Can be days (d) or weeks (w).
|
|
143
|
+
:param int value: The amount of time, expressed as an integer, applicable to the unit specified.
|
|
144
|
+
"""
|
|
145
|
+
pulumi.set(__self__, "unit", unit)
|
|
146
|
+
pulumi.set(__self__, "value", value)
|
|
147
|
+
|
|
148
|
+
@property
|
|
149
|
+
@pulumi.getter
|
|
150
|
+
def unit(self) -> str:
|
|
151
|
+
"""
|
|
152
|
+
The unit of the period. Can be days (d) or weeks (w).
|
|
153
|
+
"""
|
|
154
|
+
return pulumi.get(self, "unit")
|
|
155
|
+
|
|
156
|
+
@property
|
|
157
|
+
@pulumi.getter
|
|
158
|
+
def value(self) -> int:
|
|
159
|
+
"""
|
|
160
|
+
The amount of time, expressed as an integer, applicable to the unit specified.
|
|
161
|
+
"""
|
|
162
|
+
return pulumi.get(self, "value")
|
|
163
|
+
|
|
164
|
+
|
|
126
165
|
@pulumi.output_type
|
|
127
166
|
class DashboardChart(dict):
|
|
128
167
|
@staticmethod
|
|
@@ -149,11 +188,11 @@ class DashboardChart(dict):
|
|
|
149
188
|
row: Optional[int] = None,
|
|
150
189
|
width: Optional[int] = None):
|
|
151
190
|
"""
|
|
152
|
-
:param str chart_id: ID of the chart to display
|
|
153
|
-
:param int column: The column to show the chart in (zero-based); this value always represents the leftmost column of the chart
|
|
154
|
-
:param int height: How many rows the chart should take up
|
|
155
|
-
:param int row: The row to show the chart in (zero-based); if height > 1
|
|
156
|
-
:param int width: How many columns (out of a total of 12
|
|
191
|
+
:param str chart_id: ID of the chart to display.
|
|
192
|
+
:param int column: The column to show the chart in (zero-based); this value always represents the leftmost column of the chart (between `0` and `11`).
|
|
193
|
+
:param int height: How many rows the chart should take up (greater than or equal to `1`). `1` by default.
|
|
194
|
+
:param int row: 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`).
|
|
195
|
+
:param int width: How many columns (out of a total of 12) the chart should take up (between `1` and `12`). `12` by default.
|
|
157
196
|
"""
|
|
158
197
|
pulumi.set(__self__, "chart_id", chart_id)
|
|
159
198
|
if column is not None:
|
|
@@ -169,7 +208,7 @@ class DashboardChart(dict):
|
|
|
169
208
|
@pulumi.getter(name="chartId")
|
|
170
209
|
def chart_id(self) -> str:
|
|
171
210
|
"""
|
|
172
|
-
ID of the chart to display
|
|
211
|
+
ID of the chart to display.
|
|
173
212
|
"""
|
|
174
213
|
return pulumi.get(self, "chart_id")
|
|
175
214
|
|
|
@@ -177,7 +216,7 @@ class DashboardChart(dict):
|
|
|
177
216
|
@pulumi.getter
|
|
178
217
|
def column(self) -> Optional[int]:
|
|
179
218
|
"""
|
|
180
|
-
The column to show the chart in (zero-based); this value always represents the leftmost column of the chart
|
|
219
|
+
The column to show the chart in (zero-based); this value always represents the leftmost column of the chart (between `0` and `11`).
|
|
181
220
|
"""
|
|
182
221
|
return pulumi.get(self, "column")
|
|
183
222
|
|
|
@@ -185,7 +224,7 @@ class DashboardChart(dict):
|
|
|
185
224
|
@pulumi.getter
|
|
186
225
|
def height(self) -> Optional[int]:
|
|
187
226
|
"""
|
|
188
|
-
How many rows the chart should take up
|
|
227
|
+
How many rows the chart should take up (greater than or equal to `1`). `1` by default.
|
|
189
228
|
"""
|
|
190
229
|
return pulumi.get(self, "height")
|
|
191
230
|
|
|
@@ -193,7 +232,7 @@ class DashboardChart(dict):
|
|
|
193
232
|
@pulumi.getter
|
|
194
233
|
def row(self) -> Optional[int]:
|
|
195
234
|
"""
|
|
196
|
-
The row to show the chart in (zero-based); if height > 1
|
|
235
|
+
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`).
|
|
197
236
|
"""
|
|
198
237
|
return pulumi.get(self, "row")
|
|
199
238
|
|
|
@@ -201,7 +240,7 @@ class DashboardChart(dict):
|
|
|
201
240
|
@pulumi.getter
|
|
202
241
|
def width(self) -> Optional[int]:
|
|
203
242
|
"""
|
|
204
|
-
How many columns (out of a total of 12
|
|
243
|
+
How many columns (out of a total of 12) the chart should take up (between `1` and `12`). `12` by default.
|
|
205
244
|
"""
|
|
206
245
|
return pulumi.get(self, "width")
|
|
207
246
|
|
|
@@ -231,10 +270,10 @@ class DashboardColumn(dict):
|
|
|
231
270
|
height: Optional[int] = None,
|
|
232
271
|
width: Optional[int] = None):
|
|
233
272
|
"""
|
|
234
|
-
:param Sequence[str] chart_ids:
|
|
235
|
-
:param int column:
|
|
236
|
-
:param int height: How many rows
|
|
237
|
-
:param int width:
|
|
273
|
+
:param Sequence[str] chart_ids: List of IDs of the charts to display.
|
|
274
|
+
:param int column: Column number for the layout.
|
|
275
|
+
:param int height: How many rows every chart should take up (greater than or equal to 1). 1 by default.
|
|
276
|
+
:param int width: How many columns (out of a total of `12`) every chart should take up (between `1` and `12`). `12` by default.
|
|
238
277
|
"""
|
|
239
278
|
pulumi.set(__self__, "chart_ids", chart_ids)
|
|
240
279
|
if column is not None:
|
|
@@ -248,7 +287,7 @@ class DashboardColumn(dict):
|
|
|
248
287
|
@pulumi.getter(name="chartIds")
|
|
249
288
|
def chart_ids(self) -> Sequence[str]:
|
|
250
289
|
"""
|
|
251
|
-
|
|
290
|
+
List of IDs of the charts to display.
|
|
252
291
|
"""
|
|
253
292
|
return pulumi.get(self, "chart_ids")
|
|
254
293
|
|
|
@@ -256,7 +295,7 @@ class DashboardColumn(dict):
|
|
|
256
295
|
@pulumi.getter
|
|
257
296
|
def column(self) -> Optional[int]:
|
|
258
297
|
"""
|
|
259
|
-
|
|
298
|
+
Column number for the layout.
|
|
260
299
|
"""
|
|
261
300
|
return pulumi.get(self, "column")
|
|
262
301
|
|
|
@@ -264,7 +303,7 @@ class DashboardColumn(dict):
|
|
|
264
303
|
@pulumi.getter
|
|
265
304
|
def height(self) -> Optional[int]:
|
|
266
305
|
"""
|
|
267
|
-
How many rows
|
|
306
|
+
How many rows every chart should take up (greater than or equal to 1). 1 by default.
|
|
268
307
|
"""
|
|
269
308
|
return pulumi.get(self, "height")
|
|
270
309
|
|
|
@@ -272,7 +311,7 @@ class DashboardColumn(dict):
|
|
|
272
311
|
@pulumi.getter
|
|
273
312
|
def width(self) -> Optional[int]:
|
|
274
313
|
"""
|
|
275
|
-
|
|
314
|
+
How many columns (out of a total of `12`) every chart should take up (between `1` and `12`). `12` by default.
|
|
276
315
|
"""
|
|
277
316
|
return pulumi.get(self, "width")
|
|
278
317
|
|
|
@@ -287,11 +326,12 @@ class DashboardEventOverlay(dict):
|
|
|
287
326
|
sources: Optional[Sequence['outputs.DashboardEventOverlaySource']] = None,
|
|
288
327
|
type: Optional[str] = None):
|
|
289
328
|
"""
|
|
290
|
-
:param str signal: Search term used to
|
|
291
|
-
:param str color: Color to use
|
|
292
|
-
:param str label:
|
|
293
|
-
:param bool line:
|
|
294
|
-
:param
|
|
329
|
+
:param str signal: Search term used to choose the events shown in the overlay.
|
|
330
|
+
:param str color: Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
331
|
+
:param str label: Text shown in the dropdown when selecting this overlay from the menu.
|
|
332
|
+
:param bool line: Show a vertical line for the event. `false` by default.
|
|
333
|
+
:param Sequence['DashboardEventOverlaySourceArgs'] sources: Each element specifies a filter to use against the signal specified in the `signal`.
|
|
334
|
+
:param str type: Can be set to `eventTimeSeries` (the default) to refer to externally reported events, or `detectorEvents` to refer to events from detector triggers.
|
|
295
335
|
"""
|
|
296
336
|
pulumi.set(__self__, "signal", signal)
|
|
297
337
|
if color is not None:
|
|
@@ -309,7 +349,7 @@ class DashboardEventOverlay(dict):
|
|
|
309
349
|
@pulumi.getter
|
|
310
350
|
def signal(self) -> str:
|
|
311
351
|
"""
|
|
312
|
-
Search term used to
|
|
352
|
+
Search term used to choose the events shown in the overlay.
|
|
313
353
|
"""
|
|
314
354
|
return pulumi.get(self, "signal")
|
|
315
355
|
|
|
@@ -317,7 +357,7 @@ class DashboardEventOverlay(dict):
|
|
|
317
357
|
@pulumi.getter
|
|
318
358
|
def color(self) -> Optional[str]:
|
|
319
359
|
"""
|
|
320
|
-
Color to use
|
|
360
|
+
Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
321
361
|
"""
|
|
322
362
|
return pulumi.get(self, "color")
|
|
323
363
|
|
|
@@ -325,7 +365,7 @@ class DashboardEventOverlay(dict):
|
|
|
325
365
|
@pulumi.getter
|
|
326
366
|
def label(self) -> Optional[str]:
|
|
327
367
|
"""
|
|
328
|
-
|
|
368
|
+
Text shown in the dropdown when selecting this overlay from the menu.
|
|
329
369
|
"""
|
|
330
370
|
return pulumi.get(self, "label")
|
|
331
371
|
|
|
@@ -333,20 +373,23 @@ class DashboardEventOverlay(dict):
|
|
|
333
373
|
@pulumi.getter
|
|
334
374
|
def line(self) -> Optional[bool]:
|
|
335
375
|
"""
|
|
336
|
-
|
|
376
|
+
Show a vertical line for the event. `false` by default.
|
|
337
377
|
"""
|
|
338
378
|
return pulumi.get(self, "line")
|
|
339
379
|
|
|
340
380
|
@property
|
|
341
381
|
@pulumi.getter
|
|
342
382
|
def sources(self) -> Optional[Sequence['outputs.DashboardEventOverlaySource']]:
|
|
383
|
+
"""
|
|
384
|
+
Each element specifies a filter to use against the signal specified in the `signal`.
|
|
385
|
+
"""
|
|
343
386
|
return pulumi.get(self, "sources")
|
|
344
387
|
|
|
345
388
|
@property
|
|
346
389
|
@pulumi.getter
|
|
347
390
|
def type(self) -> Optional[str]:
|
|
348
391
|
"""
|
|
349
|
-
|
|
392
|
+
Can be set to `eventTimeSeries` (the default) to refer to externally reported events, or `detectorEvents` to refer to events from detector triggers.
|
|
350
393
|
"""
|
|
351
394
|
return pulumi.get(self, "type")
|
|
352
395
|
|
|
@@ -358,9 +401,9 @@ class DashboardEventOverlaySource(dict):
|
|
|
358
401
|
values: Sequence[str],
|
|
359
402
|
negated: Optional[bool] = None):
|
|
360
403
|
"""
|
|
361
|
-
:param str property:
|
|
362
|
-
:param Sequence[str] values:
|
|
363
|
-
:param bool negated:
|
|
404
|
+
:param str property: The name of a dimension to filter against.
|
|
405
|
+
:param Sequence[str] values: A list of values to be used with the `property`, they will be combined via `OR`.
|
|
406
|
+
:param bool negated: If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to `false`.
|
|
364
407
|
"""
|
|
365
408
|
pulumi.set(__self__, "property", property)
|
|
366
409
|
pulumi.set(__self__, "values", values)
|
|
@@ -371,7 +414,7 @@ class DashboardEventOverlaySource(dict):
|
|
|
371
414
|
@pulumi.getter
|
|
372
415
|
def values(self) -> Sequence[str]:
|
|
373
416
|
"""
|
|
374
|
-
|
|
417
|
+
A list of values to be used with the `property`, they will be combined via `OR`.
|
|
375
418
|
"""
|
|
376
419
|
return pulumi.get(self, "values")
|
|
377
420
|
|
|
@@ -379,7 +422,7 @@ class DashboardEventOverlaySource(dict):
|
|
|
379
422
|
@pulumi.getter
|
|
380
423
|
def negated(self) -> Optional[bool]:
|
|
381
424
|
"""
|
|
382
|
-
|
|
425
|
+
If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to `false`.
|
|
383
426
|
"""
|
|
384
427
|
return pulumi.get(self, "negated")
|
|
385
428
|
|
|
@@ -387,7 +430,7 @@ class DashboardEventOverlaySource(dict):
|
|
|
387
430
|
@pulumi.getter
|
|
388
431
|
def property(self) -> str:
|
|
389
432
|
"""
|
|
390
|
-
|
|
433
|
+
The name of a dimension to filter against.
|
|
391
434
|
"""
|
|
392
435
|
return pulumi.get(self, "property")
|
|
393
436
|
|
|
@@ -417,10 +460,10 @@ class DashboardFilter(dict):
|
|
|
417
460
|
apply_if_exist: Optional[bool] = None,
|
|
418
461
|
negated: Optional[bool] = None):
|
|
419
462
|
"""
|
|
420
|
-
:param str property: A metric time series dimension or property name
|
|
421
|
-
:param Sequence[str] values: List of strings (which will be treated as an OR filter on the property)
|
|
422
|
-
:param bool apply_if_exist: If true, this filter will also match data that
|
|
423
|
-
:param bool negated:
|
|
463
|
+
:param str property: A metric time series dimension or property name.
|
|
464
|
+
:param Sequence[str] values: List of of strings (which will be treated as an OR filter on the property).
|
|
465
|
+
:param bool apply_if_exist: If true, this filter will also match data that doesn't have this property at all.
|
|
466
|
+
:param bool negated: Whether this filter should be a not filter. `false` by default.
|
|
424
467
|
"""
|
|
425
468
|
pulumi.set(__self__, "property", property)
|
|
426
469
|
pulumi.set(__self__, "values", values)
|
|
@@ -433,7 +476,7 @@ class DashboardFilter(dict):
|
|
|
433
476
|
@pulumi.getter
|
|
434
477
|
def values(self) -> Sequence[str]:
|
|
435
478
|
"""
|
|
436
|
-
List of strings (which will be treated as an OR filter on the property)
|
|
479
|
+
List of of strings (which will be treated as an OR filter on the property).
|
|
437
480
|
"""
|
|
438
481
|
return pulumi.get(self, "values")
|
|
439
482
|
|
|
@@ -441,7 +484,7 @@ class DashboardFilter(dict):
|
|
|
441
484
|
@pulumi.getter(name="applyIfExist")
|
|
442
485
|
def apply_if_exist(self) -> Optional[bool]:
|
|
443
486
|
"""
|
|
444
|
-
If true, this filter will also match data that
|
|
487
|
+
If true, this filter will also match data that doesn't have this property at all.
|
|
445
488
|
"""
|
|
446
489
|
return pulumi.get(self, "apply_if_exist")
|
|
447
490
|
|
|
@@ -449,7 +492,7 @@ class DashboardFilter(dict):
|
|
|
449
492
|
@pulumi.getter
|
|
450
493
|
def negated(self) -> Optional[bool]:
|
|
451
494
|
"""
|
|
452
|
-
|
|
495
|
+
Whether this filter should be a not filter. `false` by default.
|
|
453
496
|
"""
|
|
454
497
|
return pulumi.get(self, "negated")
|
|
455
498
|
|
|
@@ -457,7 +500,7 @@ class DashboardFilter(dict):
|
|
|
457
500
|
@pulumi.getter
|
|
458
501
|
def property(self) -> str:
|
|
459
502
|
"""
|
|
460
|
-
A metric time series dimension or property name
|
|
503
|
+
A metric time series dimension or property name.
|
|
461
504
|
"""
|
|
462
505
|
return pulumi.get(self, "property")
|
|
463
506
|
|
|
@@ -486,9 +529,9 @@ class DashboardGrid(dict):
|
|
|
486
529
|
height: Optional[int] = None,
|
|
487
530
|
width: Optional[int] = None):
|
|
488
531
|
"""
|
|
489
|
-
:param Sequence[str] chart_ids:
|
|
490
|
-
:param int height: How many rows
|
|
491
|
-
:param int width:
|
|
532
|
+
:param Sequence[str] chart_ids: List of IDs of the charts to display.
|
|
533
|
+
:param int height: How many rows every chart should take up (greater than or equal to `1`). `1` by default.
|
|
534
|
+
:param int width: How many columns (out of a total of 12) every chart should take up (between `1` and `12`). `12` by default.
|
|
492
535
|
"""
|
|
493
536
|
pulumi.set(__self__, "chart_ids", chart_ids)
|
|
494
537
|
if height is not None:
|
|
@@ -500,7 +543,7 @@ class DashboardGrid(dict):
|
|
|
500
543
|
@pulumi.getter(name="chartIds")
|
|
501
544
|
def chart_ids(self) -> Sequence[str]:
|
|
502
545
|
"""
|
|
503
|
-
|
|
546
|
+
List of IDs of the charts to display.
|
|
504
547
|
"""
|
|
505
548
|
return pulumi.get(self, "chart_ids")
|
|
506
549
|
|
|
@@ -508,7 +551,7 @@ class DashboardGrid(dict):
|
|
|
508
551
|
@pulumi.getter
|
|
509
552
|
def height(self) -> Optional[int]:
|
|
510
553
|
"""
|
|
511
|
-
How many rows
|
|
554
|
+
How many rows every chart should take up (greater than or equal to `1`). `1` by default.
|
|
512
555
|
"""
|
|
513
556
|
return pulumi.get(self, "height")
|
|
514
557
|
|
|
@@ -516,7 +559,7 @@ class DashboardGrid(dict):
|
|
|
516
559
|
@pulumi.getter
|
|
517
560
|
def width(self) -> Optional[int]:
|
|
518
561
|
"""
|
|
519
|
-
|
|
562
|
+
How many columns (out of a total of 12) every chart should take up (between `1` and `12`). `12` by default.
|
|
520
563
|
"""
|
|
521
564
|
return pulumi.get(self, "width")
|
|
522
565
|
|
|
@@ -558,11 +601,11 @@ class DashboardGroupDashboard(dict):
|
|
|
558
601
|
name_override: Optional[str] = None,
|
|
559
602
|
variable_overrides: Optional[Sequence['outputs.DashboardGroupDashboardVariableOverride']] = None):
|
|
560
603
|
"""
|
|
561
|
-
:param str dashboard_id: The
|
|
562
|
-
:param str config_id:
|
|
563
|
-
:param str description_override:
|
|
564
|
-
:param Sequence['DashboardGroupDashboardFilterOverrideArgs'] filter_overrides:
|
|
565
|
-
:param str name_override:
|
|
604
|
+
:param str dashboard_id: The dashboard id to mirror
|
|
605
|
+
:param str config_id: The ID of the association between the dashboard group and the dashboard
|
|
606
|
+
:param str description_override: The description that will override the original dashboards's description.
|
|
607
|
+
:param Sequence['DashboardGroupDashboardFilterOverrideArgs'] filter_overrides: The description that will override the original dashboards's description.
|
|
608
|
+
:param str name_override: The name that will override the original dashboards's name.
|
|
566
609
|
:param Sequence['DashboardGroupDashboardVariableOverrideArgs'] variable_overrides: Dashboard variable to apply to each chart in the dashboard
|
|
567
610
|
"""
|
|
568
611
|
pulumi.set(__self__, "dashboard_id", dashboard_id)
|
|
@@ -581,7 +624,7 @@ class DashboardGroupDashboard(dict):
|
|
|
581
624
|
@pulumi.getter(name="dashboardId")
|
|
582
625
|
def dashboard_id(self) -> str:
|
|
583
626
|
"""
|
|
584
|
-
The
|
|
627
|
+
The dashboard id to mirror
|
|
585
628
|
"""
|
|
586
629
|
return pulumi.get(self, "dashboard_id")
|
|
587
630
|
|
|
@@ -589,7 +632,7 @@ class DashboardGroupDashboard(dict):
|
|
|
589
632
|
@pulumi.getter(name="configId")
|
|
590
633
|
def config_id(self) -> Optional[str]:
|
|
591
634
|
"""
|
|
592
|
-
|
|
635
|
+
The ID of the association between the dashboard group and the dashboard
|
|
593
636
|
"""
|
|
594
637
|
return pulumi.get(self, "config_id")
|
|
595
638
|
|
|
@@ -597,7 +640,7 @@ class DashboardGroupDashboard(dict):
|
|
|
597
640
|
@pulumi.getter(name="descriptionOverride")
|
|
598
641
|
def description_override(self) -> Optional[str]:
|
|
599
642
|
"""
|
|
600
|
-
|
|
643
|
+
The description that will override the original dashboards's description.
|
|
601
644
|
"""
|
|
602
645
|
return pulumi.get(self, "description_override")
|
|
603
646
|
|
|
@@ -605,7 +648,7 @@ class DashboardGroupDashboard(dict):
|
|
|
605
648
|
@pulumi.getter(name="filterOverrides")
|
|
606
649
|
def filter_overrides(self) -> Optional[Sequence['outputs.DashboardGroupDashboardFilterOverride']]:
|
|
607
650
|
"""
|
|
608
|
-
|
|
651
|
+
The description that will override the original dashboards's description.
|
|
609
652
|
"""
|
|
610
653
|
return pulumi.get(self, "filter_overrides")
|
|
611
654
|
|
|
@@ -613,7 +656,7 @@ class DashboardGroupDashboard(dict):
|
|
|
613
656
|
@pulumi.getter(name="nameOverride")
|
|
614
657
|
def name_override(self) -> Optional[str]:
|
|
615
658
|
"""
|
|
616
|
-
|
|
659
|
+
The name that will override the original dashboards's name.
|
|
617
660
|
"""
|
|
618
661
|
return pulumi.get(self, "name_override")
|
|
619
662
|
|
|
@@ -633,9 +676,9 @@ class DashboardGroupDashboardFilterOverride(dict):
|
|
|
633
676
|
values: Sequence[str],
|
|
634
677
|
negated: Optional[bool] = None):
|
|
635
678
|
"""
|
|
636
|
-
:param str property: A metric time series dimension or property name
|
|
637
|
-
:param Sequence[str] values: List of strings (which will be treated as an OR filter on the property)
|
|
638
|
-
:param bool negated:
|
|
679
|
+
:param str property: A metric time series dimension or property name.
|
|
680
|
+
:param Sequence[str] values: (Optional) List of of strings (which will be treated as an OR filter on the property).
|
|
681
|
+
:param bool negated: If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to `false`.
|
|
639
682
|
"""
|
|
640
683
|
pulumi.set(__self__, "property", property)
|
|
641
684
|
pulumi.set(__self__, "values", values)
|
|
@@ -646,7 +689,7 @@ class DashboardGroupDashboardFilterOverride(dict):
|
|
|
646
689
|
@pulumi.getter
|
|
647
690
|
def values(self) -> Sequence[str]:
|
|
648
691
|
"""
|
|
649
|
-
List of strings (which will be treated as an OR filter on the property)
|
|
692
|
+
(Optional) List of of strings (which will be treated as an OR filter on the property).
|
|
650
693
|
"""
|
|
651
694
|
return pulumi.get(self, "values")
|
|
652
695
|
|
|
@@ -654,7 +697,7 @@ class DashboardGroupDashboardFilterOverride(dict):
|
|
|
654
697
|
@pulumi.getter
|
|
655
698
|
def negated(self) -> Optional[bool]:
|
|
656
699
|
"""
|
|
657
|
-
|
|
700
|
+
If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to `false`.
|
|
658
701
|
"""
|
|
659
702
|
return pulumi.get(self, "negated")
|
|
660
703
|
|
|
@@ -662,7 +705,7 @@ class DashboardGroupDashboardFilterOverride(dict):
|
|
|
662
705
|
@pulumi.getter
|
|
663
706
|
def property(self) -> str:
|
|
664
707
|
"""
|
|
665
|
-
A metric time series dimension or property name
|
|
708
|
+
A metric time series dimension or property name.
|
|
666
709
|
"""
|
|
667
710
|
return pulumi.get(self, "property")
|
|
668
711
|
|
|
@@ -820,9 +863,9 @@ class DashboardGroupPermission(dict):
|
|
|
820
863
|
principal_type: str,
|
|
821
864
|
actions: Optional[Sequence[str]] = None):
|
|
822
865
|
"""
|
|
823
|
-
:param str principal_id: ID of the
|
|
824
|
-
:param str principal_type:
|
|
825
|
-
:param Sequence[str] actions:
|
|
866
|
+
:param str principal_id: ID of the user, team, or organization for which you're granting permissions.
|
|
867
|
+
:param str principal_type: Clarify whether this permission configuration is for a user, a team, or an organization. Value can be one of "USER", "TEAM", or "ORG".
|
|
868
|
+
:param Sequence[str] actions: Action the user, team, or organization can take with the dashboard group. List of values (value can be "READ" or "WRITE").
|
|
826
869
|
"""
|
|
827
870
|
pulumi.set(__self__, "principal_id", principal_id)
|
|
828
871
|
pulumi.set(__self__, "principal_type", principal_type)
|
|
@@ -833,7 +876,7 @@ class DashboardGroupPermission(dict):
|
|
|
833
876
|
@pulumi.getter(name="principalId")
|
|
834
877
|
def principal_id(self) -> str:
|
|
835
878
|
"""
|
|
836
|
-
ID of the
|
|
879
|
+
ID of the user, team, or organization for which you're granting permissions.
|
|
837
880
|
"""
|
|
838
881
|
return pulumi.get(self, "principal_id")
|
|
839
882
|
|
|
@@ -841,7 +884,7 @@ class DashboardGroupPermission(dict):
|
|
|
841
884
|
@pulumi.getter(name="principalType")
|
|
842
885
|
def principal_type(self) -> str:
|
|
843
886
|
"""
|
|
844
|
-
|
|
887
|
+
Clarify whether this permission configuration is for a user, a team, or an organization. Value can be one of "USER", "TEAM", or "ORG".
|
|
845
888
|
"""
|
|
846
889
|
return pulumi.get(self, "principal_type")
|
|
847
890
|
|
|
@@ -849,7 +892,7 @@ class DashboardGroupPermission(dict):
|
|
|
849
892
|
@pulumi.getter
|
|
850
893
|
def actions(self) -> Optional[Sequence[str]]:
|
|
851
894
|
"""
|
|
852
|
-
|
|
895
|
+
Action the user, team, or organization can take with the dashboard group. List of values (value can be "READ" or "WRITE").
|
|
853
896
|
"""
|
|
854
897
|
return pulumi.get(self, "actions")
|
|
855
898
|
|
|
@@ -860,8 +903,8 @@ class DashboardPermissions(dict):
|
|
|
860
903
|
acls: Optional[Sequence['outputs.DashboardPermissionsAcl']] = None,
|
|
861
904
|
parent: Optional[str] = None):
|
|
862
905
|
"""
|
|
863
|
-
:param Sequence['DashboardPermissionsAclArgs'] acls:
|
|
864
|
-
:param str parent:
|
|
906
|
+
:param Sequence['DashboardPermissionsAclArgs'] acls: 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.
|
|
907
|
+
:param str parent: 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.
|
|
865
908
|
"""
|
|
866
909
|
if acls is not None:
|
|
867
910
|
pulumi.set(__self__, "acls", acls)
|
|
@@ -872,7 +915,7 @@ class DashboardPermissions(dict):
|
|
|
872
915
|
@pulumi.getter
|
|
873
916
|
def acls(self) -> Optional[Sequence['outputs.DashboardPermissionsAcl']]:
|
|
874
917
|
"""
|
|
875
|
-
|
|
918
|
+
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.
|
|
876
919
|
"""
|
|
877
920
|
return pulumi.get(self, "acls")
|
|
878
921
|
|
|
@@ -880,7 +923,7 @@ class DashboardPermissions(dict):
|
|
|
880
923
|
@pulumi.getter
|
|
881
924
|
def parent(self) -> Optional[str]:
|
|
882
925
|
"""
|
|
883
|
-
|
|
926
|
+
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.
|
|
884
927
|
"""
|
|
885
928
|
return pulumi.get(self, "parent")
|
|
886
929
|
|
|
@@ -911,9 +954,9 @@ class DashboardPermissionsAcl(dict):
|
|
|
911
954
|
principal_type: str,
|
|
912
955
|
actions: Optional[Sequence[str]] = None):
|
|
913
956
|
"""
|
|
914
|
-
:param str principal_id: ID of the
|
|
915
|
-
:param str principal_type:
|
|
916
|
-
:param Sequence[str] actions:
|
|
957
|
+
:param str principal_id: ID of the user, team, or organization for which you're granting permissions.
|
|
958
|
+
:param str principal_type: Clarify whether this permission configuration is for a user, a team, or an organization. Value can be one of "USER", "TEAM", or "ORG".
|
|
959
|
+
:param Sequence[str] actions: Action the user, team, or organization can take with the dashboard. List of values (value can be "READ" or "WRITE").
|
|
917
960
|
"""
|
|
918
961
|
pulumi.set(__self__, "principal_id", principal_id)
|
|
919
962
|
pulumi.set(__self__, "principal_type", principal_type)
|
|
@@ -924,7 +967,7 @@ class DashboardPermissionsAcl(dict):
|
|
|
924
967
|
@pulumi.getter(name="principalId")
|
|
925
968
|
def principal_id(self) -> str:
|
|
926
969
|
"""
|
|
927
|
-
ID of the
|
|
970
|
+
ID of the user, team, or organization for which you're granting permissions.
|
|
928
971
|
"""
|
|
929
972
|
return pulumi.get(self, "principal_id")
|
|
930
973
|
|
|
@@ -932,7 +975,7 @@ class DashboardPermissionsAcl(dict):
|
|
|
932
975
|
@pulumi.getter(name="principalType")
|
|
933
976
|
def principal_type(self) -> str:
|
|
934
977
|
"""
|
|
935
|
-
|
|
978
|
+
Clarify whether this permission configuration is for a user, a team, or an organization. Value can be one of "USER", "TEAM", or "ORG".
|
|
936
979
|
"""
|
|
937
980
|
return pulumi.get(self, "principal_type")
|
|
938
981
|
|
|
@@ -940,7 +983,7 @@ class DashboardPermissionsAcl(dict):
|
|
|
940
983
|
@pulumi.getter
|
|
941
984
|
def actions(self) -> Optional[Sequence[str]]:
|
|
942
985
|
"""
|
|
943
|
-
|
|
986
|
+
Action the user, team, or organization can take with the dashboard. List of values (value can be "READ" or "WRITE").
|
|
944
987
|
"""
|
|
945
988
|
return pulumi.get(self, "actions")
|
|
946
989
|
|
|
@@ -952,8 +995,9 @@ class DashboardSelectedEventOverlay(dict):
|
|
|
952
995
|
sources: Optional[Sequence['outputs.DashboardSelectedEventOverlaySource']] = None,
|
|
953
996
|
type: Optional[str] = None):
|
|
954
997
|
"""
|
|
955
|
-
:param str signal: Search term used to
|
|
956
|
-
:param
|
|
998
|
+
:param str signal: Search term used to choose the events shown in the overlay.
|
|
999
|
+
:param Sequence['DashboardSelectedEventOverlaySourceArgs'] sources: Each element specifies a filter to use against the signal specified in the `signal`.
|
|
1000
|
+
:param str type: Can be set to `eventTimeSeries` (the default) to refer to externally reported events, or `detectorEvents` to refer to events from detector triggers.
|
|
957
1001
|
"""
|
|
958
1002
|
pulumi.set(__self__, "signal", signal)
|
|
959
1003
|
if sources is not None:
|
|
@@ -965,20 +1009,23 @@ class DashboardSelectedEventOverlay(dict):
|
|
|
965
1009
|
@pulumi.getter
|
|
966
1010
|
def signal(self) -> str:
|
|
967
1011
|
"""
|
|
968
|
-
Search term used to
|
|
1012
|
+
Search term used to choose the events shown in the overlay.
|
|
969
1013
|
"""
|
|
970
1014
|
return pulumi.get(self, "signal")
|
|
971
1015
|
|
|
972
1016
|
@property
|
|
973
1017
|
@pulumi.getter
|
|
974
1018
|
def sources(self) -> Optional[Sequence['outputs.DashboardSelectedEventOverlaySource']]:
|
|
1019
|
+
"""
|
|
1020
|
+
Each element specifies a filter to use against the signal specified in the `signal`.
|
|
1021
|
+
"""
|
|
975
1022
|
return pulumi.get(self, "sources")
|
|
976
1023
|
|
|
977
1024
|
@property
|
|
978
1025
|
@pulumi.getter
|
|
979
1026
|
def type(self) -> Optional[str]:
|
|
980
1027
|
"""
|
|
981
|
-
|
|
1028
|
+
Can be set to `eventTimeSeries` (the default) to refer to externally reported events, or `detectorEvents` to refer to events from detector triggers.
|
|
982
1029
|
"""
|
|
983
1030
|
return pulumi.get(self, "type")
|
|
984
1031
|
|
|
@@ -990,9 +1037,9 @@ class DashboardSelectedEventOverlaySource(dict):
|
|
|
990
1037
|
values: Sequence[str],
|
|
991
1038
|
negated: Optional[bool] = None):
|
|
992
1039
|
"""
|
|
993
|
-
:param str property:
|
|
994
|
-
:param Sequence[str] values:
|
|
995
|
-
:param bool negated:
|
|
1040
|
+
:param str property: The name of a dimension to filter against.
|
|
1041
|
+
:param Sequence[str] values: A list of values to be used with the `property`, they will be combined via `OR`.
|
|
1042
|
+
:param bool negated: If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to `false`.
|
|
996
1043
|
"""
|
|
997
1044
|
pulumi.set(__self__, "property", property)
|
|
998
1045
|
pulumi.set(__self__, "values", values)
|
|
@@ -1003,7 +1050,7 @@ class DashboardSelectedEventOverlaySource(dict):
|
|
|
1003
1050
|
@pulumi.getter
|
|
1004
1051
|
def values(self) -> Sequence[str]:
|
|
1005
1052
|
"""
|
|
1006
|
-
|
|
1053
|
+
A list of values to be used with the `property`, they will be combined via `OR`.
|
|
1007
1054
|
"""
|
|
1008
1055
|
return pulumi.get(self, "values")
|
|
1009
1056
|
|
|
@@ -1011,7 +1058,7 @@ class DashboardSelectedEventOverlaySource(dict):
|
|
|
1011
1058
|
@pulumi.getter
|
|
1012
1059
|
def negated(self) -> Optional[bool]:
|
|
1013
1060
|
"""
|
|
1014
|
-
|
|
1061
|
+
If true, only data that does not match the specified value of the specified property appear in the event overlay. Defaults to `false`.
|
|
1015
1062
|
"""
|
|
1016
1063
|
return pulumi.get(self, "negated")
|
|
1017
1064
|
|
|
@@ -1019,7 +1066,7 @@ class DashboardSelectedEventOverlaySource(dict):
|
|
|
1019
1066
|
@pulumi.getter
|
|
1020
1067
|
def property(self) -> str:
|
|
1021
1068
|
"""
|
|
1022
|
-
|
|
1069
|
+
The name of a dimension to filter against.
|
|
1023
1070
|
"""
|
|
1024
1071
|
return pulumi.get(self, "property")
|
|
1025
1072
|
|
|
@@ -1062,15 +1109,15 @@ class DashboardVariable(dict):
|
|
|
1062
1109
|
values: Optional[Sequence[str]] = None,
|
|
1063
1110
|
values_suggesteds: Optional[Sequence[str]] = None):
|
|
1064
1111
|
"""
|
|
1065
|
-
:param str alias: An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard
|
|
1066
|
-
:param str property: A metric time series dimension or property name
|
|
1067
|
-
:param bool apply_if_exist: If true, this variable will also match data that
|
|
1068
|
-
:param str description: Variable description
|
|
1069
|
-
:param bool replace_only: If true
|
|
1070
|
-
:param bool restricted_suggestions: If true
|
|
1071
|
-
:param bool value_required: 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
|
|
1072
|
-
:param Sequence[str] values: List of strings (which will be treated as an OR filter on the property)
|
|
1073
|
-
:param Sequence[str] values_suggesteds: A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable
|
|
1112
|
+
:param str alias: An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.
|
|
1113
|
+
:param str property: A metric time series dimension or property name.
|
|
1114
|
+
:param bool apply_if_exist: If true, this variable will also match data that doesn't have this property at all.
|
|
1115
|
+
:param str description: Variable description.
|
|
1116
|
+
:param bool replace_only: If `true`, this variable will only apply to charts that have a filter for the property.
|
|
1117
|
+
:param bool restricted_suggestions: If `true`, this variable may only be set to the values listed in `values_suggested` and only these values will appear in autosuggestion menus. `false` by default.
|
|
1118
|
+
:param bool value_required: 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.
|
|
1119
|
+
:param Sequence[str] values: List of of strings (which will be treated as an OR filter on the property).
|
|
1120
|
+
:param Sequence[str] values_suggesteds: A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.
|
|
1074
1121
|
"""
|
|
1075
1122
|
pulumi.set(__self__, "alias", alias)
|
|
1076
1123
|
pulumi.set(__self__, "property", property)
|
|
@@ -1093,7 +1140,7 @@ class DashboardVariable(dict):
|
|
|
1093
1140
|
@pulumi.getter
|
|
1094
1141
|
def alias(self) -> str:
|
|
1095
1142
|
"""
|
|
1096
|
-
An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard
|
|
1143
|
+
An alias for the dashboard variable. This text will appear as the label for the dropdown field on the dashboard.
|
|
1097
1144
|
"""
|
|
1098
1145
|
return pulumi.get(self, "alias")
|
|
1099
1146
|
|
|
@@ -1101,7 +1148,7 @@ class DashboardVariable(dict):
|
|
|
1101
1148
|
@pulumi.getter(name="applyIfExist")
|
|
1102
1149
|
def apply_if_exist(self) -> Optional[bool]:
|
|
1103
1150
|
"""
|
|
1104
|
-
If true, this variable will also match data that
|
|
1151
|
+
If true, this variable will also match data that doesn't have this property at all.
|
|
1105
1152
|
"""
|
|
1106
1153
|
return pulumi.get(self, "apply_if_exist")
|
|
1107
1154
|
|
|
@@ -1109,7 +1156,7 @@ class DashboardVariable(dict):
|
|
|
1109
1156
|
@pulumi.getter
|
|
1110
1157
|
def description(self) -> Optional[str]:
|
|
1111
1158
|
"""
|
|
1112
|
-
Variable description
|
|
1159
|
+
Variable description.
|
|
1113
1160
|
"""
|
|
1114
1161
|
return pulumi.get(self, "description")
|
|
1115
1162
|
|
|
@@ -1117,7 +1164,7 @@ class DashboardVariable(dict):
|
|
|
1117
1164
|
@pulumi.getter(name="replaceOnly")
|
|
1118
1165
|
def replace_only(self) -> Optional[bool]:
|
|
1119
1166
|
"""
|
|
1120
|
-
If true
|
|
1167
|
+
If `true`, this variable will only apply to charts that have a filter for the property.
|
|
1121
1168
|
"""
|
|
1122
1169
|
return pulumi.get(self, "replace_only")
|
|
1123
1170
|
|
|
@@ -1125,7 +1172,7 @@ class DashboardVariable(dict):
|
|
|
1125
1172
|
@pulumi.getter(name="restrictedSuggestions")
|
|
1126
1173
|
def restricted_suggestions(self) -> Optional[bool]:
|
|
1127
1174
|
"""
|
|
1128
|
-
If true
|
|
1175
|
+
If `true`, this variable may only be set to the values listed in `values_suggested` and only these values will appear in autosuggestion menus. `false` by default.
|
|
1129
1176
|
"""
|
|
1130
1177
|
return pulumi.get(self, "restricted_suggestions")
|
|
1131
1178
|
|
|
@@ -1133,7 +1180,7 @@ class DashboardVariable(dict):
|
|
|
1133
1180
|
@pulumi.getter(name="valueRequired")
|
|
1134
1181
|
def value_required(self) -> Optional[bool]:
|
|
1135
1182
|
"""
|
|
1136
|
-
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
|
|
1183
|
+
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.
|
|
1137
1184
|
"""
|
|
1138
1185
|
return pulumi.get(self, "value_required")
|
|
1139
1186
|
|
|
@@ -1141,7 +1188,7 @@ class DashboardVariable(dict):
|
|
|
1141
1188
|
@pulumi.getter
|
|
1142
1189
|
def values(self) -> Optional[Sequence[str]]:
|
|
1143
1190
|
"""
|
|
1144
|
-
List of strings (which will be treated as an OR filter on the property)
|
|
1191
|
+
List of of strings (which will be treated as an OR filter on the property).
|
|
1145
1192
|
"""
|
|
1146
1193
|
return pulumi.get(self, "values")
|
|
1147
1194
|
|
|
@@ -1149,7 +1196,7 @@ class DashboardVariable(dict):
|
|
|
1149
1196
|
@pulumi.getter(name="valuesSuggesteds")
|
|
1150
1197
|
def values_suggesteds(self) -> Optional[Sequence[str]]:
|
|
1151
1198
|
"""
|
|
1152
|
-
A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable
|
|
1199
|
+
A list of strings of suggested values for this variable; these suggestions will receive priority when values are autosuggested for this variable.
|
|
1153
1200
|
"""
|
|
1154
1201
|
return pulumi.get(self, "values_suggesteds")
|
|
1155
1202
|
|
|
@@ -1157,7 +1204,7 @@ class DashboardVariable(dict):
|
|
|
1157
1204
|
@pulumi.getter
|
|
1158
1205
|
def property(self) -> str:
|
|
1159
1206
|
"""
|
|
1160
|
-
A metric time series dimension or property name
|
|
1207
|
+
A metric time series dimension or property name.
|
|
1161
1208
|
"""
|
|
1162
1209
|
return pulumi.get(self, "property")
|
|
1163
1210
|
|
|
@@ -1193,10 +1240,10 @@ class DataLinkTargetExternalUrl(dict):
|
|
|
1193
1240
|
time_format: Optional[str] = None):
|
|
1194
1241
|
"""
|
|
1195
1242
|
:param str name: User-assigned target name. Use this value to differentiate between the link targets for a data link object.
|
|
1196
|
-
:param str url: URL string for a Splunk instance or external system data link target.
|
|
1197
|
-
:param str minimum_time_window: The minimum time window for a search sent to an external site.
|
|
1198
|
-
:param Mapping[str, str] property_key_mapping: Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different
|
|
1199
|
-
:param str time_format: Designates the format of
|
|
1243
|
+
:param str url: 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/).
|
|
1244
|
+
:param str minimum_time_window: The [minimum time window](https://dev.splunk.com/observability/docs/administration/datalinks/) for a search sent to an external site. Defaults to `6000`
|
|
1245
|
+
:param Mapping[str, str] property_key_mapping: Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different.
|
|
1246
|
+
:param str time_format: [Designates the format](https://dev.splunk.com/observability/docs/administration/datalinks/) of `minimum_time_window` in the same data link target object. Must be one of `"ISO8601"`, `"EpochSeconds"` or `"Epoch"` (which is milliseconds). Defaults to `"ISO8601"`.
|
|
1200
1247
|
"""
|
|
1201
1248
|
pulumi.set(__self__, "name", name)
|
|
1202
1249
|
pulumi.set(__self__, "url", url)
|
|
@@ -1219,7 +1266,7 @@ class DataLinkTargetExternalUrl(dict):
|
|
|
1219
1266
|
@pulumi.getter
|
|
1220
1267
|
def url(self) -> str:
|
|
1221
1268
|
"""
|
|
1222
|
-
URL string for a Splunk instance or external system data link target.
|
|
1269
|
+
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/).
|
|
1223
1270
|
"""
|
|
1224
1271
|
return pulumi.get(self, "url")
|
|
1225
1272
|
|
|
@@ -1227,7 +1274,7 @@ class DataLinkTargetExternalUrl(dict):
|
|
|
1227
1274
|
@pulumi.getter(name="minimumTimeWindow")
|
|
1228
1275
|
def minimum_time_window(self) -> Optional[str]:
|
|
1229
1276
|
"""
|
|
1230
|
-
The minimum time window for a search sent to an external site.
|
|
1277
|
+
The [minimum time window](https://dev.splunk.com/observability/docs/administration/datalinks/) for a search sent to an external site. Defaults to `6000`
|
|
1231
1278
|
"""
|
|
1232
1279
|
return pulumi.get(self, "minimum_time_window")
|
|
1233
1280
|
|
|
@@ -1235,7 +1282,7 @@ class DataLinkTargetExternalUrl(dict):
|
|
|
1235
1282
|
@pulumi.getter(name="propertyKeyMapping")
|
|
1236
1283
|
def property_key_mapping(self) -> Optional[Mapping[str, str]]:
|
|
1237
1284
|
"""
|
|
1238
|
-
Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different
|
|
1285
|
+
Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different.
|
|
1239
1286
|
"""
|
|
1240
1287
|
return pulumi.get(self, "property_key_mapping")
|
|
1241
1288
|
|
|
@@ -1243,7 +1290,7 @@ class DataLinkTargetExternalUrl(dict):
|
|
|
1243
1290
|
@pulumi.getter(name="timeFormat")
|
|
1244
1291
|
def time_format(self) -> Optional[str]:
|
|
1245
1292
|
"""
|
|
1246
|
-
Designates the format of
|
|
1293
|
+
[Designates the format](https://dev.splunk.com/observability/docs/administration/datalinks/) of `minimum_time_window` in the same data link target object. Must be one of `"ISO8601"`, `"EpochSeconds"` or `"Epoch"` (which is milliseconds). Defaults to `"ISO8601"`.
|
|
1247
1294
|
"""
|
|
1248
1295
|
return pulumi.get(self, "time_format")
|
|
1249
1296
|
|
|
@@ -1280,7 +1327,7 @@ class DataLinkTargetSignalfxDashboard(dict):
|
|
|
1280
1327
|
:param str dashboard_group_id: SignalFx-assigned ID of the dashboard link target's dashboard group
|
|
1281
1328
|
:param str dashboard_id: SignalFx-assigned ID of the dashboard link target
|
|
1282
1329
|
:param str name: User-assigned target name. Use this value to differentiate between the link targets for a data link object.
|
|
1283
|
-
:param bool is_default: Flag that designates a target as the default for a data link object.
|
|
1330
|
+
:param bool is_default: Flag that designates a target as the default for a data link object. `true` by default
|
|
1284
1331
|
"""
|
|
1285
1332
|
pulumi.set(__self__, "dashboard_group_id", dashboard_group_id)
|
|
1286
1333
|
pulumi.set(__self__, "dashboard_id", dashboard_id)
|
|
@@ -1316,7 +1363,7 @@ class DataLinkTargetSignalfxDashboard(dict):
|
|
|
1316
1363
|
@pulumi.getter(name="isDefault")
|
|
1317
1364
|
def is_default(self) -> Optional[bool]:
|
|
1318
1365
|
"""
|
|
1319
|
-
Flag that designates a target as the default for a data link object.
|
|
1366
|
+
Flag that designates a target as the default for a data link object. `true` by default
|
|
1320
1367
|
"""
|
|
1321
1368
|
return pulumi.get(self, "is_default")
|
|
1322
1369
|
|
|
@@ -1345,7 +1392,7 @@ class DataLinkTargetSplunk(dict):
|
|
|
1345
1392
|
property_key_mapping: Optional[Mapping[str, str]] = None):
|
|
1346
1393
|
"""
|
|
1347
1394
|
:param str name: User-assigned target name. Use this value to differentiate between the link targets for a data link object.
|
|
1348
|
-
:param Mapping[str, str] property_key_mapping: Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different
|
|
1395
|
+
:param Mapping[str, str] property_key_mapping: Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different.
|
|
1349
1396
|
"""
|
|
1350
1397
|
pulumi.set(__self__, "name", name)
|
|
1351
1398
|
if property_key_mapping is not None:
|
|
@@ -1363,7 +1410,7 @@ class DataLinkTargetSplunk(dict):
|
|
|
1363
1410
|
@pulumi.getter(name="propertyKeyMapping")
|
|
1364
1411
|
def property_key_mapping(self) -> Optional[Mapping[str, str]]:
|
|
1365
1412
|
"""
|
|
1366
|
-
Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different
|
|
1413
|
+
Describes the relationship between Splunk Observability Cloud metadata keys and external system properties when the key names are different.
|
|
1367
1414
|
"""
|
|
1368
1415
|
return pulumi.get(self, "property_key_mapping")
|
|
1369
1416
|
|
|
@@ -1404,15 +1451,15 @@ class DetectorRule(dict):
|
|
|
1404
1451
|
runbook_url: Optional[str] = None,
|
|
1405
1452
|
tip: Optional[str] = None):
|
|
1406
1453
|
"""
|
|
1407
|
-
:param str detect_label: A detect label which matches a detect label within
|
|
1408
|
-
:param str severity: The severity of the rule, must be one of: Critical
|
|
1409
|
-
:param str description: Description of the
|
|
1410
|
-
:param bool disabled:
|
|
1411
|
-
:param Sequence[str] notifications: List of strings specifying where notifications will be sent when an incident occurs. See https://
|
|
1412
|
-
:param str parameterized_body: Custom notification message body when an alert is triggered. See https://
|
|
1413
|
-
:param str parameterized_subject: Custom notification message subject when an alert is triggered. See https://
|
|
1414
|
-
:param str runbook_url: URL of page to consult when an alert is triggered
|
|
1415
|
-
:param str tip: Plain text suggested first course of action, such as a command to execute.
|
|
1454
|
+
:param str detect_label: A detect label which matches a detect label within `program_text`.
|
|
1455
|
+
:param str severity: The severity of the rule, must be one of: `"Critical"`, `"Major"`, `"Minor"`, `"Warning"`, `"Info"`.
|
|
1456
|
+
:param str description: Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.
|
|
1457
|
+
:param bool disabled: When true, notifications and events will not be generated for the detect label. `false` by default.
|
|
1458
|
+
:param Sequence[str] notifications: 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.
|
|
1459
|
+
:param str parameterized_body: 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.
|
|
1460
|
+
:param str parameterized_subject: 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.
|
|
1461
|
+
:param str runbook_url: URL of page to consult when an alert is triggered. This can be used with custom notification messages.
|
|
1462
|
+
:param str tip: Plain text suggested first course of action, such as a command line to execute. This can be used with custom notification messages.
|
|
1416
1463
|
"""
|
|
1417
1464
|
pulumi.set(__self__, "detect_label", detect_label)
|
|
1418
1465
|
pulumi.set(__self__, "severity", severity)
|
|
@@ -1435,7 +1482,7 @@ class DetectorRule(dict):
|
|
|
1435
1482
|
@pulumi.getter(name="detectLabel")
|
|
1436
1483
|
def detect_label(self) -> str:
|
|
1437
1484
|
"""
|
|
1438
|
-
A detect label which matches a detect label within
|
|
1485
|
+
A detect label which matches a detect label within `program_text`.
|
|
1439
1486
|
"""
|
|
1440
1487
|
return pulumi.get(self, "detect_label")
|
|
1441
1488
|
|
|
@@ -1443,7 +1490,7 @@ class DetectorRule(dict):
|
|
|
1443
1490
|
@pulumi.getter
|
|
1444
1491
|
def severity(self) -> str:
|
|
1445
1492
|
"""
|
|
1446
|
-
The severity of the rule, must be one of: Critical
|
|
1493
|
+
The severity of the rule, must be one of: `"Critical"`, `"Major"`, `"Minor"`, `"Warning"`, `"Info"`.
|
|
1447
1494
|
"""
|
|
1448
1495
|
return pulumi.get(self, "severity")
|
|
1449
1496
|
|
|
@@ -1451,7 +1498,7 @@ class DetectorRule(dict):
|
|
|
1451
1498
|
@pulumi.getter
|
|
1452
1499
|
def description(self) -> Optional[str]:
|
|
1453
1500
|
"""
|
|
1454
|
-
Description of the
|
|
1501
|
+
Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.
|
|
1455
1502
|
"""
|
|
1456
1503
|
return pulumi.get(self, "description")
|
|
1457
1504
|
|
|
@@ -1459,7 +1506,7 @@ class DetectorRule(dict):
|
|
|
1459
1506
|
@pulumi.getter
|
|
1460
1507
|
def disabled(self) -> Optional[bool]:
|
|
1461
1508
|
"""
|
|
1462
|
-
|
|
1509
|
+
When true, notifications and events will not be generated for the detect label. `false` by default.
|
|
1463
1510
|
"""
|
|
1464
1511
|
return pulumi.get(self, "disabled")
|
|
1465
1512
|
|
|
@@ -1467,7 +1514,7 @@ class DetectorRule(dict):
|
|
|
1467
1514
|
@pulumi.getter
|
|
1468
1515
|
def notifications(self) -> Optional[Sequence[str]]:
|
|
1469
1516
|
"""
|
|
1470
|
-
List of strings specifying where notifications will be sent when an incident occurs. See https://
|
|
1517
|
+
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.
|
|
1471
1518
|
"""
|
|
1472
1519
|
return pulumi.get(self, "notifications")
|
|
1473
1520
|
|
|
@@ -1475,7 +1522,7 @@ class DetectorRule(dict):
|
|
|
1475
1522
|
@pulumi.getter(name="parameterizedBody")
|
|
1476
1523
|
def parameterized_body(self) -> Optional[str]:
|
|
1477
1524
|
"""
|
|
1478
|
-
Custom notification message body when an alert is triggered. See https://
|
|
1525
|
+
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.
|
|
1479
1526
|
"""
|
|
1480
1527
|
return pulumi.get(self, "parameterized_body")
|
|
1481
1528
|
|
|
@@ -1483,7 +1530,7 @@ class DetectorRule(dict):
|
|
|
1483
1530
|
@pulumi.getter(name="parameterizedSubject")
|
|
1484
1531
|
def parameterized_subject(self) -> Optional[str]:
|
|
1485
1532
|
"""
|
|
1486
|
-
Custom notification message subject when an alert is triggered. See https://
|
|
1533
|
+
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.
|
|
1487
1534
|
"""
|
|
1488
1535
|
return pulumi.get(self, "parameterized_subject")
|
|
1489
1536
|
|
|
@@ -1491,7 +1538,7 @@ class DetectorRule(dict):
|
|
|
1491
1538
|
@pulumi.getter(name="runbookUrl")
|
|
1492
1539
|
def runbook_url(self) -> Optional[str]:
|
|
1493
1540
|
"""
|
|
1494
|
-
URL of page to consult when an alert is triggered
|
|
1541
|
+
URL of page to consult when an alert is triggered. This can be used with custom notification messages.
|
|
1495
1542
|
"""
|
|
1496
1543
|
return pulumi.get(self, "runbook_url")
|
|
1497
1544
|
|
|
@@ -1499,7 +1546,7 @@ class DetectorRule(dict):
|
|
|
1499
1546
|
@pulumi.getter
|
|
1500
1547
|
def tip(self) -> Optional[str]:
|
|
1501
1548
|
"""
|
|
1502
|
-
Plain text suggested first course of action, such as a command to execute.
|
|
1549
|
+
Plain text suggested first course of action, such as a command line to execute. This can be used with custom notification messages.
|
|
1503
1550
|
"""
|
|
1504
1551
|
return pulumi.get(self, "tip")
|
|
1505
1552
|
|
|
@@ -1537,12 +1584,16 @@ class DetectorVizOption(dict):
|
|
|
1537
1584
|
value_suffix: Optional[str] = None,
|
|
1538
1585
|
value_unit: Optional[str] = None):
|
|
1539
1586
|
"""
|
|
1540
|
-
:param str label:
|
|
1541
|
-
:param str color: Color to use
|
|
1587
|
+
:param str label: Label used in the publish statement that displays the plot (metric time series data) you want to customize.
|
|
1588
|
+
:param str color: Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
1542
1589
|
:param str display_name: Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
|
|
1543
|
-
:param str value_prefix:
|
|
1590
|
+
:param str value_prefix: , `value_suffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
|
|
1591
|
+
|
|
1592
|
+
**Notes**
|
|
1593
|
+
|
|
1594
|
+
Use both `max_delay` in your detector configuration and an `extrapolation` policy in your program text to reduce false positives and false negatives.
|
|
1544
1595
|
:param str value_suffix: An arbitrary suffix to display with the value of this plot
|
|
1545
|
-
:param str value_unit: A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
|
|
1596
|
+
:param str value_unit: 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`.
|
|
1546
1597
|
"""
|
|
1547
1598
|
pulumi.set(__self__, "label", label)
|
|
1548
1599
|
if color is not None:
|
|
@@ -1560,7 +1611,7 @@ class DetectorVizOption(dict):
|
|
|
1560
1611
|
@pulumi.getter
|
|
1561
1612
|
def label(self) -> str:
|
|
1562
1613
|
"""
|
|
1563
|
-
|
|
1614
|
+
Label used in the publish statement that displays the plot (metric time series data) you want to customize.
|
|
1564
1615
|
"""
|
|
1565
1616
|
return pulumi.get(self, "label")
|
|
1566
1617
|
|
|
@@ -1568,7 +1619,7 @@ class DetectorVizOption(dict):
|
|
|
1568
1619
|
@pulumi.getter
|
|
1569
1620
|
def color(self) -> Optional[str]:
|
|
1570
1621
|
"""
|
|
1571
|
-
Color to use
|
|
1622
|
+
Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
1572
1623
|
"""
|
|
1573
1624
|
return pulumi.get(self, "color")
|
|
1574
1625
|
|
|
@@ -1584,7 +1635,11 @@ class DetectorVizOption(dict):
|
|
|
1584
1635
|
@pulumi.getter(name="valuePrefix")
|
|
1585
1636
|
def value_prefix(self) -> Optional[str]:
|
|
1586
1637
|
"""
|
|
1587
|
-
|
|
1638
|
+
, `value_suffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
|
|
1639
|
+
|
|
1640
|
+
**Notes**
|
|
1641
|
+
|
|
1642
|
+
Use both `max_delay` in your detector configuration and an `extrapolation` policy in your program text to reduce false positives and false negatives.
|
|
1588
1643
|
"""
|
|
1589
1644
|
return pulumi.get(self, "value_prefix")
|
|
1590
1645
|
|
|
@@ -1600,7 +1655,7 @@ class DetectorVizOption(dict):
|
|
|
1600
1655
|
@pulumi.getter(name="valueUnit")
|
|
1601
1656
|
def value_unit(self) -> Optional[str]:
|
|
1602
1657
|
"""
|
|
1603
|
-
A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
|
|
1658
|
+
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`.
|
|
1604
1659
|
"""
|
|
1605
1660
|
return pulumi.get(self, "value_unit")
|
|
1606
1661
|
|
|
@@ -1632,8 +1687,8 @@ class HeatmapChartColorRange(dict):
|
|
|
1632
1687
|
min_value: Optional[float] = None):
|
|
1633
1688
|
"""
|
|
1634
1689
|
:param str color: The color range to use. The starting hex color value for data values in a heatmap chart. Specify the value as a 6-character hexadecimal value preceded by the '#' character, for example "#ea1849" (grass green).
|
|
1635
|
-
:param float max_value: The maximum value within the coloring range
|
|
1636
|
-
:param float min_value: The minimum value within the coloring range
|
|
1690
|
+
:param float max_value: The maximum value within the coloring range.
|
|
1691
|
+
:param float min_value: The minimum value within the coloring range.
|
|
1637
1692
|
"""
|
|
1638
1693
|
pulumi.set(__self__, "color", color)
|
|
1639
1694
|
if max_value is not None:
|
|
@@ -1653,7 +1708,7 @@ class HeatmapChartColorRange(dict):
|
|
|
1653
1708
|
@pulumi.getter(name="maxValue")
|
|
1654
1709
|
def max_value(self) -> Optional[float]:
|
|
1655
1710
|
"""
|
|
1656
|
-
The maximum value within the coloring range
|
|
1711
|
+
The maximum value within the coloring range.
|
|
1657
1712
|
"""
|
|
1658
1713
|
return pulumi.get(self, "max_value")
|
|
1659
1714
|
|
|
@@ -1661,7 +1716,7 @@ class HeatmapChartColorRange(dict):
|
|
|
1661
1716
|
@pulumi.getter(name="minValue")
|
|
1662
1717
|
def min_value(self) -> Optional[float]:
|
|
1663
1718
|
"""
|
|
1664
|
-
The minimum value within the coloring range
|
|
1719
|
+
The minimum value within the coloring range.
|
|
1665
1720
|
"""
|
|
1666
1721
|
return pulumi.get(self, "min_value")
|
|
1667
1722
|
|
|
@@ -1675,11 +1730,11 @@ class HeatmapChartColorScale(dict):
|
|
|
1675
1730
|
lt: Optional[float] = None,
|
|
1676
1731
|
lte: Optional[float] = None):
|
|
1677
1732
|
"""
|
|
1678
|
-
:param str color: 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.
|
|
1679
|
-
:param float gt: Indicates the lower threshold non-inclusive value for this range
|
|
1680
|
-
:param float gte: Indicates the lower threshold inclusive value for this range
|
|
1681
|
-
:param float lt: Indicates the upper threshold non-
|
|
1682
|
-
:param float lte: Indicates the upper threshold inclusive value for this range
|
|
1733
|
+
:param str color: 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.
|
|
1734
|
+
:param float gt: Indicates the lower threshold non-inclusive value for this range.
|
|
1735
|
+
:param float gte: Indicates the lower threshold inclusive value for this range.
|
|
1736
|
+
:param float lt: Indicates the upper threshold non-inclusive value for this range.
|
|
1737
|
+
:param float lte: Indicates the upper threshold inclusive value for this range.
|
|
1683
1738
|
"""
|
|
1684
1739
|
pulumi.set(__self__, "color", color)
|
|
1685
1740
|
if gt is not None:
|
|
@@ -1695,7 +1750,7 @@ class HeatmapChartColorScale(dict):
|
|
|
1695
1750
|
@pulumi.getter
|
|
1696
1751
|
def color(self) -> str:
|
|
1697
1752
|
"""
|
|
1698
|
-
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.
|
|
1753
|
+
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.
|
|
1699
1754
|
"""
|
|
1700
1755
|
return pulumi.get(self, "color")
|
|
1701
1756
|
|
|
@@ -1703,7 +1758,7 @@ class HeatmapChartColorScale(dict):
|
|
|
1703
1758
|
@pulumi.getter
|
|
1704
1759
|
def gt(self) -> Optional[float]:
|
|
1705
1760
|
"""
|
|
1706
|
-
Indicates the lower threshold non-inclusive value for this range
|
|
1761
|
+
Indicates the lower threshold non-inclusive value for this range.
|
|
1707
1762
|
"""
|
|
1708
1763
|
return pulumi.get(self, "gt")
|
|
1709
1764
|
|
|
@@ -1711,7 +1766,7 @@ class HeatmapChartColorScale(dict):
|
|
|
1711
1766
|
@pulumi.getter
|
|
1712
1767
|
def gte(self) -> Optional[float]:
|
|
1713
1768
|
"""
|
|
1714
|
-
Indicates the lower threshold inclusive value for this range
|
|
1769
|
+
Indicates the lower threshold inclusive value for this range.
|
|
1715
1770
|
"""
|
|
1716
1771
|
return pulumi.get(self, "gte")
|
|
1717
1772
|
|
|
@@ -1719,7 +1774,7 @@ class HeatmapChartColorScale(dict):
|
|
|
1719
1774
|
@pulumi.getter
|
|
1720
1775
|
def lt(self) -> Optional[float]:
|
|
1721
1776
|
"""
|
|
1722
|
-
Indicates the upper threshold non-
|
|
1777
|
+
Indicates the upper threshold non-inclusive value for this range.
|
|
1723
1778
|
"""
|
|
1724
1779
|
return pulumi.get(self, "lt")
|
|
1725
1780
|
|
|
@@ -1727,7 +1782,7 @@ class HeatmapChartColorScale(dict):
|
|
|
1727
1782
|
@pulumi.getter
|
|
1728
1783
|
def lte(self) -> Optional[float]:
|
|
1729
1784
|
"""
|
|
1730
|
-
Indicates the upper threshold inclusive value for this range
|
|
1785
|
+
Indicates the upper threshold inclusive value for this range.
|
|
1731
1786
|
"""
|
|
1732
1787
|
return pulumi.get(self, "lte")
|
|
1733
1788
|
|
|
@@ -1742,10 +1797,10 @@ class ListChartColorScale(dict):
|
|
|
1742
1797
|
lte: Optional[float] = None):
|
|
1743
1798
|
"""
|
|
1744
1799
|
:param str color: 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.
|
|
1745
|
-
:param float gt: Indicates the lower threshold non-inclusive value for this range
|
|
1746
|
-
:param float gte: Indicates the lower threshold inclusive value for this range
|
|
1747
|
-
:param float lt: Indicates the upper threshold non-inculsive value for this range
|
|
1748
|
-
:param float lte: Indicates the upper threshold inclusive value for this range
|
|
1800
|
+
:param float gt: Indicates the lower threshold non-inclusive value for this range.
|
|
1801
|
+
:param float gte: Indicates the lower threshold inclusive value for this range.
|
|
1802
|
+
:param float lt: Indicates the upper threshold non-inculsive value for this range.
|
|
1803
|
+
:param float lte: Indicates the upper threshold inclusive value for this range.
|
|
1749
1804
|
"""
|
|
1750
1805
|
pulumi.set(__self__, "color", color)
|
|
1751
1806
|
if gt is not None:
|
|
@@ -1769,7 +1824,7 @@ class ListChartColorScale(dict):
|
|
|
1769
1824
|
@pulumi.getter
|
|
1770
1825
|
def gt(self) -> Optional[float]:
|
|
1771
1826
|
"""
|
|
1772
|
-
Indicates the lower threshold non-inclusive value for this range
|
|
1827
|
+
Indicates the lower threshold non-inclusive value for this range.
|
|
1773
1828
|
"""
|
|
1774
1829
|
return pulumi.get(self, "gt")
|
|
1775
1830
|
|
|
@@ -1777,7 +1832,7 @@ class ListChartColorScale(dict):
|
|
|
1777
1832
|
@pulumi.getter
|
|
1778
1833
|
def gte(self) -> Optional[float]:
|
|
1779
1834
|
"""
|
|
1780
|
-
Indicates the lower threshold inclusive value for this range
|
|
1835
|
+
Indicates the lower threshold inclusive value for this range.
|
|
1781
1836
|
"""
|
|
1782
1837
|
return pulumi.get(self, "gte")
|
|
1783
1838
|
|
|
@@ -1785,7 +1840,7 @@ class ListChartColorScale(dict):
|
|
|
1785
1840
|
@pulumi.getter
|
|
1786
1841
|
def lt(self) -> Optional[float]:
|
|
1787
1842
|
"""
|
|
1788
|
-
Indicates the upper threshold non-inculsive value for this range
|
|
1843
|
+
Indicates the upper threshold non-inculsive value for this range.
|
|
1789
1844
|
"""
|
|
1790
1845
|
return pulumi.get(self, "lt")
|
|
1791
1846
|
|
|
@@ -1793,7 +1848,7 @@ class ListChartColorScale(dict):
|
|
|
1793
1848
|
@pulumi.getter
|
|
1794
1849
|
def lte(self) -> Optional[float]:
|
|
1795
1850
|
"""
|
|
1796
|
-
Indicates the upper threshold inclusive value for this range
|
|
1851
|
+
Indicates the upper threshold inclusive value for this range.
|
|
1797
1852
|
"""
|
|
1798
1853
|
return pulumi.get(self, "lte")
|
|
1799
1854
|
|
|
@@ -1804,8 +1859,8 @@ class ListChartLegendOptionsField(dict):
|
|
|
1804
1859
|
property: str,
|
|
1805
1860
|
enabled: Optional[bool] = None):
|
|
1806
1861
|
"""
|
|
1807
|
-
:param str property: The name of
|
|
1808
|
-
:param bool enabled:
|
|
1862
|
+
:param str property: The name of the property to display. Note the special values of `sf_metric` (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.
|
|
1863
|
+
:param bool enabled: True or False depending on if you want the property to be shown or hidden.
|
|
1809
1864
|
"""
|
|
1810
1865
|
pulumi.set(__self__, "property", property)
|
|
1811
1866
|
if enabled is not None:
|
|
@@ -1815,7 +1870,7 @@ class ListChartLegendOptionsField(dict):
|
|
|
1815
1870
|
@pulumi.getter
|
|
1816
1871
|
def enabled(self) -> Optional[bool]:
|
|
1817
1872
|
"""
|
|
1818
|
-
|
|
1873
|
+
True or False depending on if you want the property to be shown or hidden.
|
|
1819
1874
|
"""
|
|
1820
1875
|
return pulumi.get(self, "enabled")
|
|
1821
1876
|
|
|
@@ -1823,7 +1878,7 @@ class ListChartLegendOptionsField(dict):
|
|
|
1823
1878
|
@pulumi.getter
|
|
1824
1879
|
def property(self) -> str:
|
|
1825
1880
|
"""
|
|
1826
|
-
The name of
|
|
1881
|
+
The name of the property to display. Note the special values of `sf_metric` (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.
|
|
1827
1882
|
"""
|
|
1828
1883
|
return pulumi.get(self, "property")
|
|
1829
1884
|
|
|
@@ -1861,12 +1916,12 @@ class ListChartVizOption(dict):
|
|
|
1861
1916
|
value_suffix: Optional[str] = None,
|
|
1862
1917
|
value_unit: Optional[str] = None):
|
|
1863
1918
|
"""
|
|
1864
|
-
:param str label:
|
|
1865
|
-
:param str color:
|
|
1919
|
+
:param str label: Label used in the publish statement that displays the plot (metric time series data) you want to customize.
|
|
1920
|
+
:param str color: 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.
|
|
1866
1921
|
:param str display_name: Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
|
|
1867
|
-
:param str value_prefix:
|
|
1922
|
+
:param str value_prefix: , `value_suffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
|
|
1868
1923
|
:param str value_suffix: An arbitrary suffix to display with the value of this plot
|
|
1869
|
-
:param str value_unit: A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
|
|
1924
|
+
:param str value_unit: 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`.
|
|
1870
1925
|
"""
|
|
1871
1926
|
pulumi.set(__self__, "label", label)
|
|
1872
1927
|
if color is not None:
|
|
@@ -1884,7 +1939,7 @@ class ListChartVizOption(dict):
|
|
|
1884
1939
|
@pulumi.getter
|
|
1885
1940
|
def label(self) -> str:
|
|
1886
1941
|
"""
|
|
1887
|
-
|
|
1942
|
+
Label used in the publish statement that displays the plot (metric time series data) you want to customize.
|
|
1888
1943
|
"""
|
|
1889
1944
|
return pulumi.get(self, "label")
|
|
1890
1945
|
|
|
@@ -1892,7 +1947,7 @@ class ListChartVizOption(dict):
|
|
|
1892
1947
|
@pulumi.getter
|
|
1893
1948
|
def color(self) -> Optional[str]:
|
|
1894
1949
|
"""
|
|
1895
|
-
|
|
1950
|
+
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.
|
|
1896
1951
|
"""
|
|
1897
1952
|
return pulumi.get(self, "color")
|
|
1898
1953
|
|
|
@@ -1908,7 +1963,7 @@ class ListChartVizOption(dict):
|
|
|
1908
1963
|
@pulumi.getter(name="valuePrefix")
|
|
1909
1964
|
def value_prefix(self) -> Optional[str]:
|
|
1910
1965
|
"""
|
|
1911
|
-
|
|
1966
|
+
, `value_suffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
|
|
1912
1967
|
"""
|
|
1913
1968
|
return pulumi.get(self, "value_prefix")
|
|
1914
1969
|
|
|
@@ -1924,7 +1979,7 @@ class ListChartVizOption(dict):
|
|
|
1924
1979
|
@pulumi.getter(name="valueUnit")
|
|
1925
1980
|
def value_unit(self) -> Optional[str]:
|
|
1926
1981
|
"""
|
|
1927
|
-
A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
|
|
1982
|
+
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`.
|
|
1928
1983
|
"""
|
|
1929
1984
|
return pulumi.get(self, "value_unit")
|
|
1930
1985
|
|
|
@@ -1935,16 +1990,20 @@ class MetricRulesetAggregationRule(dict):
|
|
|
1935
1990
|
aggregators: Sequence['outputs.MetricRulesetAggregationRuleAggregator'],
|
|
1936
1991
|
enabled: bool,
|
|
1937
1992
|
matchers: Sequence['outputs.MetricRulesetAggregationRuleMatcher'],
|
|
1993
|
+
description: Optional[str] = None,
|
|
1938
1994
|
name: Optional[str] = None):
|
|
1939
1995
|
"""
|
|
1940
|
-
:param Sequence['MetricRulesetAggregationRuleAggregatorArgs'] aggregators:
|
|
1941
|
-
:param bool enabled:
|
|
1942
|
-
:param Sequence['MetricRulesetAggregationRuleMatcherArgs'] matchers:
|
|
1943
|
-
:param str
|
|
1996
|
+
:param Sequence['MetricRulesetAggregationRuleAggregatorArgs'] aggregators: Aggregator object
|
|
1997
|
+
:param bool enabled: When false, this rule will not generate aggregated MTSs
|
|
1998
|
+
:param Sequence['MetricRulesetAggregationRuleMatcherArgs'] matchers: Matcher object
|
|
1999
|
+
:param str description: Information about an aggregation rule
|
|
2000
|
+
:param str name: name of the aggregation rule
|
|
1944
2001
|
"""
|
|
1945
2002
|
pulumi.set(__self__, "aggregators", aggregators)
|
|
1946
2003
|
pulumi.set(__self__, "enabled", enabled)
|
|
1947
2004
|
pulumi.set(__self__, "matchers", matchers)
|
|
2005
|
+
if description is not None:
|
|
2006
|
+
pulumi.set(__self__, "description", description)
|
|
1948
2007
|
if name is not None:
|
|
1949
2008
|
pulumi.set(__self__, "name", name)
|
|
1950
2009
|
|
|
@@ -1952,7 +2011,7 @@ class MetricRulesetAggregationRule(dict):
|
|
|
1952
2011
|
@pulumi.getter
|
|
1953
2012
|
def aggregators(self) -> Sequence['outputs.MetricRulesetAggregationRuleAggregator']:
|
|
1954
2013
|
"""
|
|
1955
|
-
|
|
2014
|
+
Aggregator object
|
|
1956
2015
|
"""
|
|
1957
2016
|
return pulumi.get(self, "aggregators")
|
|
1958
2017
|
|
|
@@ -1960,7 +2019,7 @@ class MetricRulesetAggregationRule(dict):
|
|
|
1960
2019
|
@pulumi.getter
|
|
1961
2020
|
def enabled(self) -> bool:
|
|
1962
2021
|
"""
|
|
1963
|
-
|
|
2022
|
+
When false, this rule will not generate aggregated MTSs
|
|
1964
2023
|
"""
|
|
1965
2024
|
return pulumi.get(self, "enabled")
|
|
1966
2025
|
|
|
@@ -1968,15 +2027,23 @@ class MetricRulesetAggregationRule(dict):
|
|
|
1968
2027
|
@pulumi.getter
|
|
1969
2028
|
def matchers(self) -> Sequence['outputs.MetricRulesetAggregationRuleMatcher']:
|
|
1970
2029
|
"""
|
|
1971
|
-
|
|
2030
|
+
Matcher object
|
|
1972
2031
|
"""
|
|
1973
2032
|
return pulumi.get(self, "matchers")
|
|
1974
2033
|
|
|
2034
|
+
@property
|
|
2035
|
+
@pulumi.getter
|
|
2036
|
+
def description(self) -> Optional[str]:
|
|
2037
|
+
"""
|
|
2038
|
+
Information about an aggregation rule
|
|
2039
|
+
"""
|
|
2040
|
+
return pulumi.get(self, "description")
|
|
2041
|
+
|
|
1975
2042
|
@property
|
|
1976
2043
|
@pulumi.getter
|
|
1977
2044
|
def name(self) -> Optional[str]:
|
|
1978
2045
|
"""
|
|
1979
|
-
|
|
2046
|
+
name of the aggregation rule
|
|
1980
2047
|
"""
|
|
1981
2048
|
return pulumi.get(self, "name")
|
|
1982
2049
|
|
|
@@ -2008,10 +2075,10 @@ class MetricRulesetAggregationRuleAggregator(dict):
|
|
|
2008
2075
|
output_name: str,
|
|
2009
2076
|
type: str):
|
|
2010
2077
|
"""
|
|
2011
|
-
:param Sequence[str] dimensions: List of dimensions to
|
|
2012
|
-
:param bool drop_dimensions:
|
|
2013
|
-
:param str output_name:
|
|
2014
|
-
:param str type:
|
|
2078
|
+
:param Sequence[str] dimensions: List of dimensions to either be kept or dropped in the new aggregated MTSs
|
|
2079
|
+
:param bool drop_dimensions: when true, the specified dimensions will be dropped from the aggregated MTSs
|
|
2080
|
+
:param str output_name: name of the new aggregated metric
|
|
2081
|
+
:param str type: Type of aggregator. Must always be "rollup"
|
|
2015
2082
|
"""
|
|
2016
2083
|
pulumi.set(__self__, "dimensions", dimensions)
|
|
2017
2084
|
pulumi.set(__self__, "drop_dimensions", drop_dimensions)
|
|
@@ -2022,7 +2089,7 @@ class MetricRulesetAggregationRuleAggregator(dict):
|
|
|
2022
2089
|
@pulumi.getter
|
|
2023
2090
|
def dimensions(self) -> Sequence[str]:
|
|
2024
2091
|
"""
|
|
2025
|
-
List of dimensions to
|
|
2092
|
+
List of dimensions to either be kept or dropped in the new aggregated MTSs
|
|
2026
2093
|
"""
|
|
2027
2094
|
return pulumi.get(self, "dimensions")
|
|
2028
2095
|
|
|
@@ -2030,7 +2097,7 @@ class MetricRulesetAggregationRuleAggregator(dict):
|
|
|
2030
2097
|
@pulumi.getter(name="dropDimensions")
|
|
2031
2098
|
def drop_dimensions(self) -> bool:
|
|
2032
2099
|
"""
|
|
2033
|
-
|
|
2100
|
+
when true, the specified dimensions will be dropped from the aggregated MTSs
|
|
2034
2101
|
"""
|
|
2035
2102
|
return pulumi.get(self, "drop_dimensions")
|
|
2036
2103
|
|
|
@@ -2038,7 +2105,7 @@ class MetricRulesetAggregationRuleAggregator(dict):
|
|
|
2038
2105
|
@pulumi.getter(name="outputName")
|
|
2039
2106
|
def output_name(self) -> str:
|
|
2040
2107
|
"""
|
|
2041
|
-
|
|
2108
|
+
name of the new aggregated metric
|
|
2042
2109
|
"""
|
|
2043
2110
|
return pulumi.get(self, "output_name")
|
|
2044
2111
|
|
|
@@ -2046,7 +2113,7 @@ class MetricRulesetAggregationRuleAggregator(dict):
|
|
|
2046
2113
|
@pulumi.getter
|
|
2047
2114
|
def type(self) -> str:
|
|
2048
2115
|
"""
|
|
2049
|
-
|
|
2116
|
+
Type of aggregator. Must always be "rollup"
|
|
2050
2117
|
"""
|
|
2051
2118
|
return pulumi.get(self, "type")
|
|
2052
2119
|
|
|
@@ -2057,8 +2124,8 @@ class MetricRulesetAggregationRuleMatcher(dict):
|
|
|
2057
2124
|
type: str,
|
|
2058
2125
|
filters: Optional[Sequence['outputs.MetricRulesetAggregationRuleMatcherFilter']] = None):
|
|
2059
2126
|
"""
|
|
2060
|
-
:param str type:
|
|
2061
|
-
:param Sequence['MetricRulesetAggregationRuleMatcherFilterArgs'] filters: List of filters to
|
|
2127
|
+
:param str type: Type of matcher. Must always be "dimension"
|
|
2128
|
+
:param Sequence['MetricRulesetAggregationRuleMatcherFilterArgs'] filters: List of filters to filter the set of input MTSs
|
|
2062
2129
|
"""
|
|
2063
2130
|
pulumi.set(__self__, "type", type)
|
|
2064
2131
|
if filters is not None:
|
|
@@ -2068,7 +2135,7 @@ class MetricRulesetAggregationRuleMatcher(dict):
|
|
|
2068
2135
|
@pulumi.getter
|
|
2069
2136
|
def type(self) -> str:
|
|
2070
2137
|
"""
|
|
2071
|
-
|
|
2138
|
+
Type of matcher. Must always be "dimension"
|
|
2072
2139
|
"""
|
|
2073
2140
|
return pulumi.get(self, "type")
|
|
2074
2141
|
|
|
@@ -2076,7 +2143,7 @@ class MetricRulesetAggregationRuleMatcher(dict):
|
|
|
2076
2143
|
@pulumi.getter
|
|
2077
2144
|
def filters(self) -> Optional[Sequence['outputs.MetricRulesetAggregationRuleMatcherFilter']]:
|
|
2078
2145
|
"""
|
|
2079
|
-
List of filters to
|
|
2146
|
+
List of filters to filter the set of input MTSs
|
|
2080
2147
|
"""
|
|
2081
2148
|
return pulumi.get(self, "filters")
|
|
2082
2149
|
|
|
@@ -2107,9 +2174,163 @@ class MetricRulesetAggregationRuleMatcherFilter(dict):
|
|
|
2107
2174
|
property: str,
|
|
2108
2175
|
property_values: Sequence[str]):
|
|
2109
2176
|
"""
|
|
2110
|
-
:param bool not_:
|
|
2111
|
-
:param str property: Name of dimension
|
|
2112
|
-
:param Sequence[str] property_values:
|
|
2177
|
+
:param bool not_: When true, this filter will match all values not matching the property_values
|
|
2178
|
+
:param str property: Name of the dimension
|
|
2179
|
+
:param Sequence[str] property_values: Value of the dimension
|
|
2180
|
+
"""
|
|
2181
|
+
pulumi.set(__self__, "not_", not_)
|
|
2182
|
+
pulumi.set(__self__, "property", property)
|
|
2183
|
+
pulumi.set(__self__, "property_values", property_values)
|
|
2184
|
+
|
|
2185
|
+
@property
|
|
2186
|
+
@pulumi.getter(name="not")
|
|
2187
|
+
def not_(self) -> bool:
|
|
2188
|
+
"""
|
|
2189
|
+
When true, this filter will match all values not matching the property_values
|
|
2190
|
+
"""
|
|
2191
|
+
return pulumi.get(self, "not_")
|
|
2192
|
+
|
|
2193
|
+
@property
|
|
2194
|
+
@pulumi.getter(name="propertyValues")
|
|
2195
|
+
def property_values(self) -> Sequence[str]:
|
|
2196
|
+
"""
|
|
2197
|
+
Value of the dimension
|
|
2198
|
+
"""
|
|
2199
|
+
return pulumi.get(self, "property_values")
|
|
2200
|
+
|
|
2201
|
+
@property
|
|
2202
|
+
@pulumi.getter
|
|
2203
|
+
def property(self) -> str:
|
|
2204
|
+
"""
|
|
2205
|
+
Name of the dimension
|
|
2206
|
+
"""
|
|
2207
|
+
return pulumi.get(self, "property")
|
|
2208
|
+
|
|
2209
|
+
|
|
2210
|
+
@pulumi.output_type
|
|
2211
|
+
class MetricRulesetExceptionRule(dict):
|
|
2212
|
+
def __init__(__self__, *,
|
|
2213
|
+
enabled: bool,
|
|
2214
|
+
matchers: Sequence['outputs.MetricRulesetExceptionRuleMatcher'],
|
|
2215
|
+
description: Optional[str] = None,
|
|
2216
|
+
name: Optional[str] = None,
|
|
2217
|
+
restorations: Optional[Sequence['outputs.MetricRulesetExceptionRuleRestoration']] = None):
|
|
2218
|
+
"""
|
|
2219
|
+
:param bool enabled: When false, this rule will not route matched data to real-time
|
|
2220
|
+
:param Sequence['MetricRulesetExceptionRuleMatcherArgs'] matchers: Matcher object
|
|
2221
|
+
:param str description: Information about an exception rule
|
|
2222
|
+
:param str name: name of the exception rule
|
|
2223
|
+
:param Sequence['MetricRulesetExceptionRuleRestorationArgs'] restorations: Properties of a restoration job
|
|
2224
|
+
"""
|
|
2225
|
+
pulumi.set(__self__, "enabled", enabled)
|
|
2226
|
+
pulumi.set(__self__, "matchers", matchers)
|
|
2227
|
+
if description is not None:
|
|
2228
|
+
pulumi.set(__self__, "description", description)
|
|
2229
|
+
if name is not None:
|
|
2230
|
+
pulumi.set(__self__, "name", name)
|
|
2231
|
+
if restorations is not None:
|
|
2232
|
+
pulumi.set(__self__, "restorations", restorations)
|
|
2233
|
+
|
|
2234
|
+
@property
|
|
2235
|
+
@pulumi.getter
|
|
2236
|
+
def enabled(self) -> bool:
|
|
2237
|
+
"""
|
|
2238
|
+
When false, this rule will not route matched data to real-time
|
|
2239
|
+
"""
|
|
2240
|
+
return pulumi.get(self, "enabled")
|
|
2241
|
+
|
|
2242
|
+
@property
|
|
2243
|
+
@pulumi.getter
|
|
2244
|
+
def matchers(self) -> Sequence['outputs.MetricRulesetExceptionRuleMatcher']:
|
|
2245
|
+
"""
|
|
2246
|
+
Matcher object
|
|
2247
|
+
"""
|
|
2248
|
+
return pulumi.get(self, "matchers")
|
|
2249
|
+
|
|
2250
|
+
@property
|
|
2251
|
+
@pulumi.getter
|
|
2252
|
+
def description(self) -> Optional[str]:
|
|
2253
|
+
"""
|
|
2254
|
+
Information about an exception rule
|
|
2255
|
+
"""
|
|
2256
|
+
return pulumi.get(self, "description")
|
|
2257
|
+
|
|
2258
|
+
@property
|
|
2259
|
+
@pulumi.getter
|
|
2260
|
+
def name(self) -> Optional[str]:
|
|
2261
|
+
"""
|
|
2262
|
+
name of the exception rule
|
|
2263
|
+
"""
|
|
2264
|
+
return pulumi.get(self, "name")
|
|
2265
|
+
|
|
2266
|
+
@property
|
|
2267
|
+
@pulumi.getter
|
|
2268
|
+
def restorations(self) -> Optional[Sequence['outputs.MetricRulesetExceptionRuleRestoration']]:
|
|
2269
|
+
"""
|
|
2270
|
+
Properties of a restoration job
|
|
2271
|
+
"""
|
|
2272
|
+
return pulumi.get(self, "restorations")
|
|
2273
|
+
|
|
2274
|
+
|
|
2275
|
+
@pulumi.output_type
|
|
2276
|
+
class MetricRulesetExceptionRuleMatcher(dict):
|
|
2277
|
+
def __init__(__self__, *,
|
|
2278
|
+
type: str,
|
|
2279
|
+
filters: Optional[Sequence['outputs.MetricRulesetExceptionRuleMatcherFilter']] = None):
|
|
2280
|
+
"""
|
|
2281
|
+
:param str type: Type of matcher. Must always be "dimension"
|
|
2282
|
+
:param Sequence['MetricRulesetExceptionRuleMatcherFilterArgs'] filters: List of filters to filter the set of input MTSs
|
|
2283
|
+
"""
|
|
2284
|
+
pulumi.set(__self__, "type", type)
|
|
2285
|
+
if filters is not None:
|
|
2286
|
+
pulumi.set(__self__, "filters", filters)
|
|
2287
|
+
|
|
2288
|
+
@property
|
|
2289
|
+
@pulumi.getter
|
|
2290
|
+
def type(self) -> str:
|
|
2291
|
+
"""
|
|
2292
|
+
Type of matcher. Must always be "dimension"
|
|
2293
|
+
"""
|
|
2294
|
+
return pulumi.get(self, "type")
|
|
2295
|
+
|
|
2296
|
+
@property
|
|
2297
|
+
@pulumi.getter
|
|
2298
|
+
def filters(self) -> Optional[Sequence['outputs.MetricRulesetExceptionRuleMatcherFilter']]:
|
|
2299
|
+
"""
|
|
2300
|
+
List of filters to filter the set of input MTSs
|
|
2301
|
+
"""
|
|
2302
|
+
return pulumi.get(self, "filters")
|
|
2303
|
+
|
|
2304
|
+
|
|
2305
|
+
@pulumi.output_type
|
|
2306
|
+
class MetricRulesetExceptionRuleMatcherFilter(dict):
|
|
2307
|
+
@staticmethod
|
|
2308
|
+
def __key_warning(key: str):
|
|
2309
|
+
suggest = None
|
|
2310
|
+
if key == "not":
|
|
2311
|
+
suggest = "not_"
|
|
2312
|
+
elif key == "propertyValues":
|
|
2313
|
+
suggest = "property_values"
|
|
2314
|
+
|
|
2315
|
+
if suggest:
|
|
2316
|
+
pulumi.log.warn(f"Key '{key}' not found in MetricRulesetExceptionRuleMatcherFilter. Access the value via the '{suggest}' property getter instead.")
|
|
2317
|
+
|
|
2318
|
+
def __getitem__(self, key: str) -> Any:
|
|
2319
|
+
MetricRulesetExceptionRuleMatcherFilter.__key_warning(key)
|
|
2320
|
+
return super().__getitem__(key)
|
|
2321
|
+
|
|
2322
|
+
def get(self, key: str, default = None) -> Any:
|
|
2323
|
+
MetricRulesetExceptionRuleMatcherFilter.__key_warning(key)
|
|
2324
|
+
return super().get(key, default)
|
|
2325
|
+
|
|
2326
|
+
def __init__(__self__, *,
|
|
2327
|
+
not_: bool,
|
|
2328
|
+
property: str,
|
|
2329
|
+
property_values: Sequence[str]):
|
|
2330
|
+
"""
|
|
2331
|
+
:param bool not_: When true, this filter will match all values not matching the property_values
|
|
2332
|
+
:param str property: Name of the dimension
|
|
2333
|
+
:param Sequence[str] property_values: Value of the dimension
|
|
2113
2334
|
"""
|
|
2114
2335
|
pulumi.set(__self__, "not_", not_)
|
|
2115
2336
|
pulumi.set(__self__, "property", property)
|
|
@@ -2119,7 +2340,7 @@ class MetricRulesetAggregationRuleMatcherFilter(dict):
|
|
|
2119
2340
|
@pulumi.getter(name="not")
|
|
2120
2341
|
def not_(self) -> bool:
|
|
2121
2342
|
"""
|
|
2122
|
-
|
|
2343
|
+
When true, this filter will match all values not matching the property_values
|
|
2123
2344
|
"""
|
|
2124
2345
|
return pulumi.get(self, "not_")
|
|
2125
2346
|
|
|
@@ -2127,7 +2348,7 @@ class MetricRulesetAggregationRuleMatcherFilter(dict):
|
|
|
2127
2348
|
@pulumi.getter(name="propertyValues")
|
|
2128
2349
|
def property_values(self) -> Sequence[str]:
|
|
2129
2350
|
"""
|
|
2130
|
-
|
|
2351
|
+
Value of the dimension
|
|
2131
2352
|
"""
|
|
2132
2353
|
return pulumi.get(self, "property_values")
|
|
2133
2354
|
|
|
@@ -2135,17 +2356,80 @@ class MetricRulesetAggregationRuleMatcherFilter(dict):
|
|
|
2135
2356
|
@pulumi.getter
|
|
2136
2357
|
def property(self) -> str:
|
|
2137
2358
|
"""
|
|
2138
|
-
Name of dimension
|
|
2359
|
+
Name of the dimension
|
|
2139
2360
|
"""
|
|
2140
2361
|
return pulumi.get(self, "property")
|
|
2141
2362
|
|
|
2142
2363
|
|
|
2364
|
+
@pulumi.output_type
|
|
2365
|
+
class MetricRulesetExceptionRuleRestoration(dict):
|
|
2366
|
+
@staticmethod
|
|
2367
|
+
def __key_warning(key: str):
|
|
2368
|
+
suggest = None
|
|
2369
|
+
if key == "startTime":
|
|
2370
|
+
suggest = "start_time"
|
|
2371
|
+
elif key == "restorationId":
|
|
2372
|
+
suggest = "restoration_id"
|
|
2373
|
+
elif key == "stopTime":
|
|
2374
|
+
suggest = "stop_time"
|
|
2375
|
+
|
|
2376
|
+
if suggest:
|
|
2377
|
+
pulumi.log.warn(f"Key '{key}' not found in MetricRulesetExceptionRuleRestoration. Access the value via the '{suggest}' property getter instead.")
|
|
2378
|
+
|
|
2379
|
+
def __getitem__(self, key: str) -> Any:
|
|
2380
|
+
MetricRulesetExceptionRuleRestoration.__key_warning(key)
|
|
2381
|
+
return super().__getitem__(key)
|
|
2382
|
+
|
|
2383
|
+
def get(self, key: str, default = None) -> Any:
|
|
2384
|
+
MetricRulesetExceptionRuleRestoration.__key_warning(key)
|
|
2385
|
+
return super().get(key, default)
|
|
2386
|
+
|
|
2387
|
+
def __init__(__self__, *,
|
|
2388
|
+
start_time: str,
|
|
2389
|
+
restoration_id: Optional[str] = None,
|
|
2390
|
+
stop_time: Optional[str] = None):
|
|
2391
|
+
"""
|
|
2392
|
+
:param str start_time: Time from which the restoration job will restore archived data, in the form of *nix time in milliseconds
|
|
2393
|
+
:param str restoration_id: ID of the restoration job.
|
|
2394
|
+
:param str stop_time: Time to which the restoration job will restore archived data, in the form of *nix time in milliseconds
|
|
2395
|
+
"""
|
|
2396
|
+
pulumi.set(__self__, "start_time", start_time)
|
|
2397
|
+
if restoration_id is not None:
|
|
2398
|
+
pulumi.set(__self__, "restoration_id", restoration_id)
|
|
2399
|
+
if stop_time is not None:
|
|
2400
|
+
pulumi.set(__self__, "stop_time", stop_time)
|
|
2401
|
+
|
|
2402
|
+
@property
|
|
2403
|
+
@pulumi.getter(name="startTime")
|
|
2404
|
+
def start_time(self) -> str:
|
|
2405
|
+
"""
|
|
2406
|
+
Time from which the restoration job will restore archived data, in the form of *nix time in milliseconds
|
|
2407
|
+
"""
|
|
2408
|
+
return pulumi.get(self, "start_time")
|
|
2409
|
+
|
|
2410
|
+
@property
|
|
2411
|
+
@pulumi.getter(name="restorationId")
|
|
2412
|
+
def restoration_id(self) -> Optional[str]:
|
|
2413
|
+
"""
|
|
2414
|
+
ID of the restoration job.
|
|
2415
|
+
"""
|
|
2416
|
+
return pulumi.get(self, "restoration_id")
|
|
2417
|
+
|
|
2418
|
+
@property
|
|
2419
|
+
@pulumi.getter(name="stopTime")
|
|
2420
|
+
def stop_time(self) -> Optional[str]:
|
|
2421
|
+
"""
|
|
2422
|
+
Time to which the restoration job will restore archived data, in the form of *nix time in milliseconds
|
|
2423
|
+
"""
|
|
2424
|
+
return pulumi.get(self, "stop_time")
|
|
2425
|
+
|
|
2426
|
+
|
|
2143
2427
|
@pulumi.output_type
|
|
2144
2428
|
class MetricRulesetRoutingRule(dict):
|
|
2145
2429
|
def __init__(__self__, *,
|
|
2146
2430
|
destination: str):
|
|
2147
2431
|
"""
|
|
2148
|
-
:param str destination:
|
|
2432
|
+
:param str destination: end destination of the input metric. Must be `RealTime`, `Archived`, or `Drop`
|
|
2149
2433
|
"""
|
|
2150
2434
|
pulumi.set(__self__, "destination", destination)
|
|
2151
2435
|
|
|
@@ -2153,7 +2437,7 @@ class MetricRulesetRoutingRule(dict):
|
|
|
2153
2437
|
@pulumi.getter
|
|
2154
2438
|
def destination(self) -> str:
|
|
2155
2439
|
"""
|
|
2156
|
-
|
|
2440
|
+
end destination of the input metric. Must be `RealTime`, `Archived`, or `Drop`
|
|
2157
2441
|
"""
|
|
2158
2442
|
return pulumi.get(self, "destination")
|
|
2159
2443
|
|
|
@@ -2250,12 +2534,12 @@ class OrgTokenHostOrUsageLimits(dict):
|
|
|
2250
2534
|
host_limit: Optional[int] = None,
|
|
2251
2535
|
host_notification_threshold: Optional[int] = None):
|
|
2252
2536
|
"""
|
|
2253
|
-
:param int container_limit: Max number of containers that can use this token
|
|
2254
|
-
:param int container_notification_threshold: Notification threshold for containers
|
|
2537
|
+
:param int container_limit: Max number of Docker containers that can use this token
|
|
2538
|
+
:param int container_notification_threshold: Notification threshold for Docker containers
|
|
2255
2539
|
:param int custom_metrics_limit: Max number of custom metrics that can be sent with this token
|
|
2256
2540
|
:param int custom_metrics_notification_threshold: Notification threshold for custom metrics
|
|
2257
|
-
:param int high_res_metrics_limit: Max number of
|
|
2258
|
-
:param int high_res_metrics_notification_threshold: Notification threshold for
|
|
2541
|
+
:param int high_res_metrics_limit: Max number of hi-res metrics that can be sent with this toke
|
|
2542
|
+
:param int high_res_metrics_notification_threshold: Notification threshold for hi-res metrics
|
|
2259
2543
|
:param int host_limit: Max number of hosts that can use this token
|
|
2260
2544
|
:param int host_notification_threshold: Notification threshold for hosts
|
|
2261
2545
|
"""
|
|
@@ -2280,7 +2564,7 @@ class OrgTokenHostOrUsageLimits(dict):
|
|
|
2280
2564
|
@pulumi.getter(name="containerLimit")
|
|
2281
2565
|
def container_limit(self) -> Optional[int]:
|
|
2282
2566
|
"""
|
|
2283
|
-
Max number of containers that can use this token
|
|
2567
|
+
Max number of Docker containers that can use this token
|
|
2284
2568
|
"""
|
|
2285
2569
|
return pulumi.get(self, "container_limit")
|
|
2286
2570
|
|
|
@@ -2288,7 +2572,7 @@ class OrgTokenHostOrUsageLimits(dict):
|
|
|
2288
2572
|
@pulumi.getter(name="containerNotificationThreshold")
|
|
2289
2573
|
def container_notification_threshold(self) -> Optional[int]:
|
|
2290
2574
|
"""
|
|
2291
|
-
Notification threshold for containers
|
|
2575
|
+
Notification threshold for Docker containers
|
|
2292
2576
|
"""
|
|
2293
2577
|
return pulumi.get(self, "container_notification_threshold")
|
|
2294
2578
|
|
|
@@ -2312,7 +2596,7 @@ class OrgTokenHostOrUsageLimits(dict):
|
|
|
2312
2596
|
@pulumi.getter(name="highResMetricsLimit")
|
|
2313
2597
|
def high_res_metrics_limit(self) -> Optional[int]:
|
|
2314
2598
|
"""
|
|
2315
|
-
Max number of
|
|
2599
|
+
Max number of hi-res metrics that can be sent with this toke
|
|
2316
2600
|
"""
|
|
2317
2601
|
return pulumi.get(self, "high_res_metrics_limit")
|
|
2318
2602
|
|
|
@@ -2320,7 +2604,7 @@ class OrgTokenHostOrUsageLimits(dict):
|
|
|
2320
2604
|
@pulumi.getter(name="highResMetricsNotificationThreshold")
|
|
2321
2605
|
def high_res_metrics_notification_threshold(self) -> Optional[int]:
|
|
2322
2606
|
"""
|
|
2323
|
-
Notification threshold for
|
|
2607
|
+
Notification threshold for hi-res metrics
|
|
2324
2608
|
"""
|
|
2325
2609
|
return pulumi.get(self, "high_res_metrics_notification_threshold")
|
|
2326
2610
|
|
|
@@ -2351,10 +2635,10 @@ class SingleValueChartColorScale(dict):
|
|
|
2351
2635
|
lte: Optional[float] = None):
|
|
2352
2636
|
"""
|
|
2353
2637
|
:param str color: 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.
|
|
2354
|
-
:param float gt: Indicates the lower threshold non-inclusive value for this range
|
|
2355
|
-
:param float gte: Indicates the lower threshold inclusive value for this range
|
|
2356
|
-
:param float lt: Indicates the upper threshold non-inculsive value for this range
|
|
2357
|
-
:param float lte: Indicates the upper threshold inclusive value for this range
|
|
2638
|
+
:param float gt: Indicates the lower threshold non-inclusive value for this range.
|
|
2639
|
+
:param float gte: Indicates the lower threshold inclusive value for this range.
|
|
2640
|
+
:param float lt: Indicates the upper threshold non-inculsive value for this range.
|
|
2641
|
+
:param float lte: Indicates the upper threshold inclusive value for this range.
|
|
2358
2642
|
"""
|
|
2359
2643
|
pulumi.set(__self__, "color", color)
|
|
2360
2644
|
if gt is not None:
|
|
@@ -2378,7 +2662,7 @@ class SingleValueChartColorScale(dict):
|
|
|
2378
2662
|
@pulumi.getter
|
|
2379
2663
|
def gt(self) -> Optional[float]:
|
|
2380
2664
|
"""
|
|
2381
|
-
Indicates the lower threshold non-inclusive value for this range
|
|
2665
|
+
Indicates the lower threshold non-inclusive value for this range.
|
|
2382
2666
|
"""
|
|
2383
2667
|
return pulumi.get(self, "gt")
|
|
2384
2668
|
|
|
@@ -2386,7 +2670,7 @@ class SingleValueChartColorScale(dict):
|
|
|
2386
2670
|
@pulumi.getter
|
|
2387
2671
|
def gte(self) -> Optional[float]:
|
|
2388
2672
|
"""
|
|
2389
|
-
Indicates the lower threshold inclusive value for this range
|
|
2673
|
+
Indicates the lower threshold inclusive value for this range.
|
|
2390
2674
|
"""
|
|
2391
2675
|
return pulumi.get(self, "gte")
|
|
2392
2676
|
|
|
@@ -2394,7 +2678,7 @@ class SingleValueChartColorScale(dict):
|
|
|
2394
2678
|
@pulumi.getter
|
|
2395
2679
|
def lt(self) -> Optional[float]:
|
|
2396
2680
|
"""
|
|
2397
|
-
Indicates the upper threshold non-inculsive value for this range
|
|
2681
|
+
Indicates the upper threshold non-inculsive value for this range.
|
|
2398
2682
|
"""
|
|
2399
2683
|
return pulumi.get(self, "lt")
|
|
2400
2684
|
|
|
@@ -2402,7 +2686,7 @@ class SingleValueChartColorScale(dict):
|
|
|
2402
2686
|
@pulumi.getter
|
|
2403
2687
|
def lte(self) -> Optional[float]:
|
|
2404
2688
|
"""
|
|
2405
|
-
Indicates the upper threshold inclusive value for this range
|
|
2689
|
+
Indicates the upper threshold inclusive value for this range.
|
|
2406
2690
|
"""
|
|
2407
2691
|
return pulumi.get(self, "lte")
|
|
2408
2692
|
|
|
@@ -2440,12 +2724,12 @@ class SingleValueChartVizOption(dict):
|
|
|
2440
2724
|
value_suffix: Optional[str] = None,
|
|
2441
2725
|
value_unit: Optional[str] = None):
|
|
2442
2726
|
"""
|
|
2443
|
-
:param str label:
|
|
2444
|
-
:param str color:
|
|
2727
|
+
:param str label: Label used in the publish statement that displays the plot (metric time series data) you want to customize.
|
|
2728
|
+
:param str color: 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.
|
|
2445
2729
|
:param str display_name: Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
|
|
2446
|
-
:param str value_prefix:
|
|
2730
|
+
:param str value_prefix: , `value_suffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
|
|
2447
2731
|
:param str value_suffix: An arbitrary suffix to display with the value of this plot
|
|
2448
|
-
:param str value_unit: A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
|
|
2732
|
+
:param str value_unit: 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`.
|
|
2449
2733
|
"""
|
|
2450
2734
|
pulumi.set(__self__, "label", label)
|
|
2451
2735
|
if color is not None:
|
|
@@ -2463,7 +2747,7 @@ class SingleValueChartVizOption(dict):
|
|
|
2463
2747
|
@pulumi.getter
|
|
2464
2748
|
def label(self) -> str:
|
|
2465
2749
|
"""
|
|
2466
|
-
|
|
2750
|
+
Label used in the publish statement that displays the plot (metric time series data) you want to customize.
|
|
2467
2751
|
"""
|
|
2468
2752
|
return pulumi.get(self, "label")
|
|
2469
2753
|
|
|
@@ -2471,7 +2755,7 @@ class SingleValueChartVizOption(dict):
|
|
|
2471
2755
|
@pulumi.getter
|
|
2472
2756
|
def color(self) -> Optional[str]:
|
|
2473
2757
|
"""
|
|
2474
|
-
|
|
2758
|
+
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.
|
|
2475
2759
|
"""
|
|
2476
2760
|
return pulumi.get(self, "color")
|
|
2477
2761
|
|
|
@@ -2487,7 +2771,7 @@ class SingleValueChartVizOption(dict):
|
|
|
2487
2771
|
@pulumi.getter(name="valuePrefix")
|
|
2488
2772
|
def value_prefix(self) -> Optional[str]:
|
|
2489
2773
|
"""
|
|
2490
|
-
|
|
2774
|
+
, `value_suffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
|
|
2491
2775
|
"""
|
|
2492
2776
|
return pulumi.get(self, "value_prefix")
|
|
2493
2777
|
|
|
@@ -2503,7 +2787,7 @@ class SingleValueChartVizOption(dict):
|
|
|
2503
2787
|
@pulumi.getter(name="valueUnit")
|
|
2504
2788
|
def value_unit(self) -> Optional[str]:
|
|
2505
2789
|
"""
|
|
2506
|
-
A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
|
|
2790
|
+
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`.
|
|
2507
2791
|
"""
|
|
2508
2792
|
return pulumi.get(self, "value_unit")
|
|
2509
2793
|
|
|
@@ -2536,9 +2820,9 @@ class SloInput(dict):
|
|
|
2536
2820
|
good_events_label: Optional[str] = None,
|
|
2537
2821
|
total_events_label: Optional[str] = None):
|
|
2538
2822
|
"""
|
|
2539
|
-
:param str program_text:
|
|
2540
|
-
:param str good_events_label: Label used in `program_text` that refers to the data block which contains the stream of successful events
|
|
2541
|
-
:param str total_events_label: Label used in `program_text` that refers to the data block which contains the stream of total events
|
|
2823
|
+
:param str program_text: SignalFlow program and arguments text strings that define the streams used as successful event count and total event count
|
|
2824
|
+
:param str good_events_label: Label used in `"program_text"` that refers to the data block which contains the stream of successful events
|
|
2825
|
+
:param str total_events_label: Label used in `"program_text"` that refers to the data block which contains the stream of total events
|
|
2542
2826
|
"""
|
|
2543
2827
|
pulumi.set(__self__, "program_text", program_text)
|
|
2544
2828
|
if good_events_label is not None:
|
|
@@ -2550,7 +2834,7 @@ class SloInput(dict):
|
|
|
2550
2834
|
@pulumi.getter(name="programText")
|
|
2551
2835
|
def program_text(self) -> str:
|
|
2552
2836
|
"""
|
|
2553
|
-
|
|
2837
|
+
SignalFlow program and arguments text strings that define the streams used as successful event count and total event count
|
|
2554
2838
|
"""
|
|
2555
2839
|
return pulumi.get(self, "program_text")
|
|
2556
2840
|
|
|
@@ -2558,7 +2842,7 @@ class SloInput(dict):
|
|
|
2558
2842
|
@pulumi.getter(name="goodEventsLabel")
|
|
2559
2843
|
def good_events_label(self) -> Optional[str]:
|
|
2560
2844
|
"""
|
|
2561
|
-
Label used in `program_text` that refers to the data block which contains the stream of successful events
|
|
2845
|
+
Label used in `"program_text"` that refers to the data block which contains the stream of successful events
|
|
2562
2846
|
"""
|
|
2563
2847
|
return pulumi.get(self, "good_events_label")
|
|
2564
2848
|
|
|
@@ -2566,7 +2850,7 @@ class SloInput(dict):
|
|
|
2566
2850
|
@pulumi.getter(name="totalEventsLabel")
|
|
2567
2851
|
def total_events_label(self) -> Optional[str]:
|
|
2568
2852
|
"""
|
|
2569
|
-
Label used in `program_text` that refers to the data block which contains the stream of total events
|
|
2853
|
+
Label used in `"program_text"` that refers to the data block which contains the stream of total events
|
|
2570
2854
|
"""
|
|
2571
2855
|
return pulumi.get(self, "total_events_label")
|
|
2572
2856
|
|
|
@@ -2580,6 +2864,10 @@ class SloTarget(dict):
|
|
|
2580
2864
|
suggest = "alert_rules"
|
|
2581
2865
|
elif key == "compliancePeriod":
|
|
2582
2866
|
suggest = "compliance_period"
|
|
2867
|
+
elif key == "cycleStart":
|
|
2868
|
+
suggest = "cycle_start"
|
|
2869
|
+
elif key == "cycleType":
|
|
2870
|
+
suggest = "cycle_type"
|
|
2583
2871
|
|
|
2584
2872
|
if suggest:
|
|
2585
2873
|
pulumi.log.warn(f"Key '{key}' not found in SloTarget. Access the value via the '{suggest}' property getter instead.")
|
|
@@ -2596,24 +2884,32 @@ class SloTarget(dict):
|
|
|
2596
2884
|
alert_rules: Sequence['outputs.SloTargetAlertRule'],
|
|
2597
2885
|
slo: float,
|
|
2598
2886
|
type: str,
|
|
2599
|
-
compliance_period: Optional[str] = None
|
|
2887
|
+
compliance_period: Optional[str] = None,
|
|
2888
|
+
cycle_start: Optional[str] = None,
|
|
2889
|
+
cycle_type: Optional[str] = None):
|
|
2600
2890
|
"""
|
|
2601
|
-
:param Sequence['SloTargetAlertRuleArgs'] alert_rules: SLO alert
|
|
2891
|
+
:param Sequence['SloTargetAlertRuleArgs'] alert_rules: List of alert rules you want to set for this SLO target. An SLO alert rule of type BREACH is always required.
|
|
2602
2892
|
:param float slo: Target value in the form of a percentage
|
|
2603
|
-
:param str type: SLO target type can be the following type: `RollingWindow`
|
|
2604
|
-
:param str compliance_period:
|
|
2893
|
+
:param str type: SLO target type can be the following type: `"RollingWindow"`, `"CalendarWindow"`
|
|
2894
|
+
:param str compliance_period: Compliance period of this SLO. This value must be within the range of 1d (1 days) to 30d (30 days), inclusive.
|
|
2895
|
+
:param str cycle_start: 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)
|
|
2896
|
+
:param str cycle_type: The cycle type of the calendar window, e.g. week, month.
|
|
2605
2897
|
"""
|
|
2606
2898
|
pulumi.set(__self__, "alert_rules", alert_rules)
|
|
2607
2899
|
pulumi.set(__self__, "slo", slo)
|
|
2608
2900
|
pulumi.set(__self__, "type", type)
|
|
2609
2901
|
if compliance_period is not None:
|
|
2610
2902
|
pulumi.set(__self__, "compliance_period", compliance_period)
|
|
2903
|
+
if cycle_start is not None:
|
|
2904
|
+
pulumi.set(__self__, "cycle_start", cycle_start)
|
|
2905
|
+
if cycle_type is not None:
|
|
2906
|
+
pulumi.set(__self__, "cycle_type", cycle_type)
|
|
2611
2907
|
|
|
2612
2908
|
@property
|
|
2613
2909
|
@pulumi.getter(name="alertRules")
|
|
2614
2910
|
def alert_rules(self) -> Sequence['outputs.SloTargetAlertRule']:
|
|
2615
2911
|
"""
|
|
2616
|
-
SLO alert
|
|
2912
|
+
List of alert rules you want to set for this SLO target. An SLO alert rule of type BREACH is always required.
|
|
2617
2913
|
"""
|
|
2618
2914
|
return pulumi.get(self, "alert_rules")
|
|
2619
2915
|
|
|
@@ -2629,7 +2925,7 @@ class SloTarget(dict):
|
|
|
2629
2925
|
@pulumi.getter
|
|
2630
2926
|
def type(self) -> str:
|
|
2631
2927
|
"""
|
|
2632
|
-
SLO target type can be the following type: `RollingWindow`
|
|
2928
|
+
SLO target type can be the following type: `"RollingWindow"`, `"CalendarWindow"`
|
|
2633
2929
|
"""
|
|
2634
2930
|
return pulumi.get(self, "type")
|
|
2635
2931
|
|
|
@@ -2637,10 +2933,26 @@ class SloTarget(dict):
|
|
|
2637
2933
|
@pulumi.getter(name="compliancePeriod")
|
|
2638
2934
|
def compliance_period(self) -> Optional[str]:
|
|
2639
2935
|
"""
|
|
2640
|
-
|
|
2936
|
+
Compliance period of this SLO. This value must be within the range of 1d (1 days) to 30d (30 days), inclusive.
|
|
2641
2937
|
"""
|
|
2642
2938
|
return pulumi.get(self, "compliance_period")
|
|
2643
2939
|
|
|
2940
|
+
@property
|
|
2941
|
+
@pulumi.getter(name="cycleStart")
|
|
2942
|
+
def cycle_start(self) -> Optional[str]:
|
|
2943
|
+
"""
|
|
2944
|
+
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)
|
|
2945
|
+
"""
|
|
2946
|
+
return pulumi.get(self, "cycle_start")
|
|
2947
|
+
|
|
2948
|
+
@property
|
|
2949
|
+
@pulumi.getter(name="cycleType")
|
|
2950
|
+
def cycle_type(self) -> Optional[str]:
|
|
2951
|
+
"""
|
|
2952
|
+
The cycle type of the calendar window, e.g. week, month.
|
|
2953
|
+
"""
|
|
2954
|
+
return pulumi.get(self, "cycle_type")
|
|
2955
|
+
|
|
2644
2956
|
|
|
2645
2957
|
@pulumi.output_type
|
|
2646
2958
|
class SloTargetAlertRule(dict):
|
|
@@ -2648,8 +2960,8 @@ class SloTargetAlertRule(dict):
|
|
|
2648
2960
|
rules: Sequence['outputs.SloTargetAlertRuleRule'],
|
|
2649
2961
|
type: str):
|
|
2650
2962
|
"""
|
|
2651
|
-
:param Sequence['SloTargetAlertRuleRuleArgs'] rules: Set of rules used for alerting
|
|
2652
|
-
:param str type: SLO alert rule type
|
|
2963
|
+
:param Sequence['SloTargetAlertRuleRuleArgs'] rules: Set of rules used for alerting.
|
|
2964
|
+
:param str type: 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 alert_rule per type. For example, you can't specify two alert_rule of type BREACH. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
|
|
2653
2965
|
"""
|
|
2654
2966
|
pulumi.set(__self__, "rules", rules)
|
|
2655
2967
|
pulumi.set(__self__, "type", type)
|
|
@@ -2658,7 +2970,7 @@ class SloTargetAlertRule(dict):
|
|
|
2658
2970
|
@pulumi.getter
|
|
2659
2971
|
def rules(self) -> Sequence['outputs.SloTargetAlertRuleRule']:
|
|
2660
2972
|
"""
|
|
2661
|
-
Set of rules used for alerting
|
|
2973
|
+
Set of rules used for alerting.
|
|
2662
2974
|
"""
|
|
2663
2975
|
return pulumi.get(self, "rules")
|
|
2664
2976
|
|
|
@@ -2666,7 +2978,7 @@ class SloTargetAlertRule(dict):
|
|
|
2666
2978
|
@pulumi.getter
|
|
2667
2979
|
def type(self) -> str:
|
|
2668
2980
|
"""
|
|
2669
|
-
SLO alert rule type
|
|
2981
|
+
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 alert_rule per type. For example, you can't specify two alert_rule of type BREACH. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
|
|
2670
2982
|
"""
|
|
2671
2983
|
return pulumi.get(self, "type")
|
|
2672
2984
|
|
|
@@ -2705,15 +3017,15 @@ class SloTargetAlertRuleRule(dict):
|
|
|
2705
3017
|
runbook_url: Optional[str] = None,
|
|
2706
3018
|
tip: Optional[str] = None):
|
|
2707
3019
|
"""
|
|
2708
|
-
:param str severity: The severity of the rule, must be one of: Critical
|
|
2709
|
-
:param str description: Description of the
|
|
2710
|
-
:param bool disabled:
|
|
2711
|
-
:param Sequence[str] notifications: List of strings specifying where notifications will be sent when an incident occurs. See https://
|
|
2712
|
-
:param str parameterized_body: Custom notification message body when an alert is triggered. See https://
|
|
2713
|
-
:param str parameterized_subject: Custom notification message subject when an alert is triggered. See https://
|
|
3020
|
+
:param str severity: The severity of the rule, must be one of: `"Critical"`, `"Major"`, `"Minor"`, `"Warning"`, `"Info"`.
|
|
3021
|
+
:param str description: Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.
|
|
3022
|
+
:param bool disabled: When true, notifications and events will not be generated for the detect label. `false` by default.
|
|
3023
|
+
:param Sequence[str] notifications: 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.
|
|
3024
|
+
:param str parameterized_body: 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.
|
|
3025
|
+
:param str parameterized_subject: 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.
|
|
2714
3026
|
:param 'SloTargetAlertRuleRuleParametersArgs' parameters: Parameters for the SLO alert rule. Each SLO alert rule type accepts different parameters. If not specified, default parameters are used.
|
|
2715
|
-
:param str runbook_url: URL of page to consult when an alert is triggered
|
|
2716
|
-
:param str tip: Plain text suggested first course of action, such as a command to execute.
|
|
3027
|
+
:param str runbook_url: URL of page to consult when an alert is triggered. This can be used with custom notification messages.
|
|
3028
|
+
:param str tip: Plain text suggested first course of action, such as a command line to execute. This can be used with custom notification messages.
|
|
2717
3029
|
"""
|
|
2718
3030
|
pulumi.set(__self__, "severity", severity)
|
|
2719
3031
|
if description is not None:
|
|
@@ -2737,7 +3049,7 @@ class SloTargetAlertRuleRule(dict):
|
|
|
2737
3049
|
@pulumi.getter
|
|
2738
3050
|
def severity(self) -> str:
|
|
2739
3051
|
"""
|
|
2740
|
-
The severity of the rule, must be one of: Critical
|
|
3052
|
+
The severity of the rule, must be one of: `"Critical"`, `"Major"`, `"Minor"`, `"Warning"`, `"Info"`.
|
|
2741
3053
|
"""
|
|
2742
3054
|
return pulumi.get(self, "severity")
|
|
2743
3055
|
|
|
@@ -2745,7 +3057,7 @@ class SloTargetAlertRuleRule(dict):
|
|
|
2745
3057
|
@pulumi.getter
|
|
2746
3058
|
def description(self) -> Optional[str]:
|
|
2747
3059
|
"""
|
|
2748
|
-
Description of the
|
|
3060
|
+
Description for the rule. Displays as the alert condition in the Alert Rules tab of the detector editor in the web UI.
|
|
2749
3061
|
"""
|
|
2750
3062
|
return pulumi.get(self, "description")
|
|
2751
3063
|
|
|
@@ -2753,7 +3065,7 @@ class SloTargetAlertRuleRule(dict):
|
|
|
2753
3065
|
@pulumi.getter
|
|
2754
3066
|
def disabled(self) -> Optional[bool]:
|
|
2755
3067
|
"""
|
|
2756
|
-
|
|
3068
|
+
When true, notifications and events will not be generated for the detect label. `false` by default.
|
|
2757
3069
|
"""
|
|
2758
3070
|
return pulumi.get(self, "disabled")
|
|
2759
3071
|
|
|
@@ -2761,7 +3073,7 @@ class SloTargetAlertRuleRule(dict):
|
|
|
2761
3073
|
@pulumi.getter
|
|
2762
3074
|
def notifications(self) -> Optional[Sequence[str]]:
|
|
2763
3075
|
"""
|
|
2764
|
-
List of strings specifying where notifications will be sent when an incident occurs. See https://
|
|
3076
|
+
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.
|
|
2765
3077
|
"""
|
|
2766
3078
|
return pulumi.get(self, "notifications")
|
|
2767
3079
|
|
|
@@ -2769,7 +3081,7 @@ class SloTargetAlertRuleRule(dict):
|
|
|
2769
3081
|
@pulumi.getter(name="parameterizedBody")
|
|
2770
3082
|
def parameterized_body(self) -> Optional[str]:
|
|
2771
3083
|
"""
|
|
2772
|
-
Custom notification message body when an alert is triggered. See https://
|
|
3084
|
+
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.
|
|
2773
3085
|
"""
|
|
2774
3086
|
return pulumi.get(self, "parameterized_body")
|
|
2775
3087
|
|
|
@@ -2777,7 +3089,7 @@ class SloTargetAlertRuleRule(dict):
|
|
|
2777
3089
|
@pulumi.getter(name="parameterizedSubject")
|
|
2778
3090
|
def parameterized_subject(self) -> Optional[str]:
|
|
2779
3091
|
"""
|
|
2780
|
-
Custom notification message subject when an alert is triggered. See https://
|
|
3092
|
+
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.
|
|
2781
3093
|
"""
|
|
2782
3094
|
return pulumi.get(self, "parameterized_subject")
|
|
2783
3095
|
|
|
@@ -2793,7 +3105,7 @@ class SloTargetAlertRuleRule(dict):
|
|
|
2793
3105
|
@pulumi.getter(name="runbookUrl")
|
|
2794
3106
|
def runbook_url(self) -> Optional[str]:
|
|
2795
3107
|
"""
|
|
2796
|
-
URL of page to consult when an alert is triggered
|
|
3108
|
+
URL of page to consult when an alert is triggered. This can be used with custom notification messages.
|
|
2797
3109
|
"""
|
|
2798
3110
|
return pulumi.get(self, "runbook_url")
|
|
2799
3111
|
|
|
@@ -2801,7 +3113,7 @@ class SloTargetAlertRuleRule(dict):
|
|
|
2801
3113
|
@pulumi.getter
|
|
2802
3114
|
def tip(self) -> Optional[str]:
|
|
2803
3115
|
"""
|
|
2804
|
-
Plain text suggested first course of action, such as a command to execute.
|
|
3116
|
+
Plain text suggested first course of action, such as a command line to execute. This can be used with custom notification messages.
|
|
2805
3117
|
"""
|
|
2806
3118
|
return pulumi.get(self, "tip")
|
|
2807
3119
|
|
|
@@ -2852,15 +3164,15 @@ class SloTargetAlertRuleRuleParameters(dict):
|
|
|
2852
3164
|
short_window1: Optional[str] = None,
|
|
2853
3165
|
short_window2: Optional[str] = None):
|
|
2854
3166
|
"""
|
|
2855
|
-
:param float burn_rate_threshold1: 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 burn_rate_threshold_1 parameter.
|
|
2856
|
-
:param float burn_rate_threshold2: 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 burn_rate_threshold_2 parameter.
|
|
2857
|
-
:param str fire_lasting: 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
|
|
2858
|
-
:param str long_window1: Long window 1 used in burn rate alert calculation. This value must be longer than short_window_1` and shorter than 90 days. Note: BURN_RATE alert rules use the long_window_1 parameter.
|
|
2859
|
-
:param str long_window2: Long window 2 used in burn rate alert calculation. This value must be longer than short_window_2` and shorter than 90 days. Note: BURN_RATE alert rules use the long_window_2 parameter.
|
|
2860
|
-
:param float percent_error_budget_left: 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 percent_error_budget_left parameter.
|
|
2861
|
-
:param float percent_of_lasting: Percentage of the fire_lasting duration that the alert condition is met before the alert is triggered. Note: BREACH and ERROR_BUDGET_LEFT alert rules use the percent_of_lasting parameter
|
|
2862
|
-
:param str short_window1: Short window 1 used in burn rate alert calculation. This value must be longer than 1/30 of long_window_1
|
|
2863
|
-
:param str short_window2: Short window 2 used in burn rate alert calculation. This value must be longer than 1/30 of long_window_2
|
|
3167
|
+
:param float burn_rate_threshold1: 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 `"burn_rate_threshold_1"` parameter. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
|
|
3168
|
+
:param float burn_rate_threshold2: 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 `"burn_rate_threshold_2"` parameter. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
|
|
3169
|
+
:param str fire_lasting: 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"`
|
|
3170
|
+
:param str long_window1: Long window 1 used in burn rate alert calculation. This value must be longer than `"short_window_1"` and shorter than 90 days. Note: `"BURN_RATE"` alert rules use the `"long_window_1"` parameter. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
|
|
3171
|
+
:param str long_window2: Long window 2 used in burn rate alert calculation. This value must be longer than `"short_window_2"` and shorter than 90 days. Note: `"BURN_RATE"` alert rules use the `"long_window_2"` parameter. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
|
|
3172
|
+
:param float percent_error_budget_left: 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 `"percent_error_budget_left"` parameter. Default: `100`
|
|
3173
|
+
:param float percent_of_lasting: Percentage of the `"fire_lasting"` duration that the alert condition is met before the alert is triggered. Note: `"BREACH"` and `"ERROR_BUDGET_LEFT"` alert rules use the `"percent_of_lasting"` parameter. Default: `100`
|
|
3174
|
+
:param str short_window1: 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 `"short_window_1"` parameter. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
|
|
3175
|
+
:param str short_window2: 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 `"short_window_2"` parameter. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
|
|
2864
3176
|
"""
|
|
2865
3177
|
if burn_rate_threshold1 is not None:
|
|
2866
3178
|
pulumi.set(__self__, "burn_rate_threshold1", burn_rate_threshold1)
|
|
@@ -2885,7 +3197,7 @@ class SloTargetAlertRuleRuleParameters(dict):
|
|
|
2885
3197
|
@pulumi.getter(name="burnRateThreshold1")
|
|
2886
3198
|
def burn_rate_threshold1(self) -> Optional[float]:
|
|
2887
3199
|
"""
|
|
2888
|
-
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 burn_rate_threshold_1 parameter.
|
|
3200
|
+
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 `"burn_rate_threshold_1"` parameter. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
|
|
2889
3201
|
"""
|
|
2890
3202
|
return pulumi.get(self, "burn_rate_threshold1")
|
|
2891
3203
|
|
|
@@ -2893,7 +3205,7 @@ class SloTargetAlertRuleRuleParameters(dict):
|
|
|
2893
3205
|
@pulumi.getter(name="burnRateThreshold2")
|
|
2894
3206
|
def burn_rate_threshold2(self) -> Optional[float]:
|
|
2895
3207
|
"""
|
|
2896
|
-
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 burn_rate_threshold_2 parameter.
|
|
3208
|
+
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 `"burn_rate_threshold_2"` parameter. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
|
|
2897
3209
|
"""
|
|
2898
3210
|
return pulumi.get(self, "burn_rate_threshold2")
|
|
2899
3211
|
|
|
@@ -2901,7 +3213,7 @@ class SloTargetAlertRuleRuleParameters(dict):
|
|
|
2901
3213
|
@pulumi.getter(name="fireLasting")
|
|
2902
3214
|
def fire_lasting(self) -> Optional[str]:
|
|
2903
3215
|
"""
|
|
2904
|
-
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
|
|
3216
|
+
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"`
|
|
2905
3217
|
"""
|
|
2906
3218
|
return pulumi.get(self, "fire_lasting")
|
|
2907
3219
|
|
|
@@ -2909,7 +3221,7 @@ class SloTargetAlertRuleRuleParameters(dict):
|
|
|
2909
3221
|
@pulumi.getter(name="longWindow1")
|
|
2910
3222
|
def long_window1(self) -> Optional[str]:
|
|
2911
3223
|
"""
|
|
2912
|
-
Long window 1 used in burn rate alert calculation. This value must be longer than short_window_1` and shorter than 90 days. Note: BURN_RATE alert rules use the long_window_1 parameter.
|
|
3224
|
+
Long window 1 used in burn rate alert calculation. This value must be longer than `"short_window_1"` and shorter than 90 days. Note: `"BURN_RATE"` alert rules use the `"long_window_1"` parameter. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
|
|
2913
3225
|
"""
|
|
2914
3226
|
return pulumi.get(self, "long_window1")
|
|
2915
3227
|
|
|
@@ -2917,7 +3229,7 @@ class SloTargetAlertRuleRuleParameters(dict):
|
|
|
2917
3229
|
@pulumi.getter(name="longWindow2")
|
|
2918
3230
|
def long_window2(self) -> Optional[str]:
|
|
2919
3231
|
"""
|
|
2920
|
-
Long window 2 used in burn rate alert calculation. This value must be longer than short_window_2` and shorter than 90 days. Note: BURN_RATE alert rules use the long_window_2 parameter.
|
|
3232
|
+
Long window 2 used in burn rate alert calculation. This value must be longer than `"short_window_2"` and shorter than 90 days. Note: `"BURN_RATE"` alert rules use the `"long_window_2"` parameter. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
|
|
2921
3233
|
"""
|
|
2922
3234
|
return pulumi.get(self, "long_window2")
|
|
2923
3235
|
|
|
@@ -2925,7 +3237,7 @@ class SloTargetAlertRuleRuleParameters(dict):
|
|
|
2925
3237
|
@pulumi.getter(name="percentErrorBudgetLeft")
|
|
2926
3238
|
def percent_error_budget_left(self) -> Optional[float]:
|
|
2927
3239
|
"""
|
|
2928
|
-
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 percent_error_budget_left parameter.
|
|
3240
|
+
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 `"percent_error_budget_left"` parameter. Default: `100`
|
|
2929
3241
|
"""
|
|
2930
3242
|
return pulumi.get(self, "percent_error_budget_left")
|
|
2931
3243
|
|
|
@@ -2933,7 +3245,7 @@ class SloTargetAlertRuleRuleParameters(dict):
|
|
|
2933
3245
|
@pulumi.getter(name="percentOfLasting")
|
|
2934
3246
|
def percent_of_lasting(self) -> Optional[float]:
|
|
2935
3247
|
"""
|
|
2936
|
-
Percentage of the fire_lasting duration that the alert condition is met before the alert is triggered. Note: BREACH and ERROR_BUDGET_LEFT alert rules use the percent_of_lasting parameter
|
|
3248
|
+
Percentage of the `"fire_lasting"` duration that the alert condition is met before the alert is triggered. Note: `"BREACH"` and `"ERROR_BUDGET_LEFT"` alert rules use the `"percent_of_lasting"` parameter. Default: `100`
|
|
2937
3249
|
"""
|
|
2938
3250
|
return pulumi.get(self, "percent_of_lasting")
|
|
2939
3251
|
|
|
@@ -2941,7 +3253,7 @@ class SloTargetAlertRuleRuleParameters(dict):
|
|
|
2941
3253
|
@pulumi.getter(name="shortWindow1")
|
|
2942
3254
|
def short_window1(self) -> Optional[str]:
|
|
2943
3255
|
"""
|
|
2944
|
-
Short window 1 used in burn rate alert calculation. This value must be longer than 1/30 of long_window_1
|
|
3256
|
+
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 `"short_window_1"` parameter. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
|
|
2945
3257
|
"""
|
|
2946
3258
|
return pulumi.get(self, "short_window1")
|
|
2947
3259
|
|
|
@@ -2949,7 +3261,7 @@ class SloTargetAlertRuleRuleParameters(dict):
|
|
|
2949
3261
|
@pulumi.getter(name="shortWindow2")
|
|
2950
3262
|
def short_window2(self) -> Optional[str]:
|
|
2951
3263
|
"""
|
|
2952
|
-
Short window 2 used in burn rate alert calculation. This value must be longer than 1/30 of long_window_2
|
|
3264
|
+
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 `"short_window_2"` parameter. See [SLO alerts](https://docs.splunk.com/observability/en/alerts-detectors-notifications/slo/burn-rate-alerts.html) for more info.
|
|
2953
3265
|
"""
|
|
2954
3266
|
return pulumi.get(self, "short_window2")
|
|
2955
3267
|
|
|
@@ -3094,13 +3406,13 @@ class TimeChartAxisLeft(dict):
|
|
|
3094
3406
|
min_value: Optional[float] = None,
|
|
3095
3407
|
watermarks: Optional[Sequence['outputs.TimeChartAxisLeftWatermark']] = None):
|
|
3096
3408
|
"""
|
|
3097
|
-
:param float high_watermark: A line to draw as a high watermark
|
|
3098
|
-
:param str high_watermark_label: A label to attach to the high watermark line
|
|
3099
|
-
:param str label: Label of the left axis
|
|
3100
|
-
:param float low_watermark: A line to draw as a low watermark
|
|
3101
|
-
:param str low_watermark_label: A label to attach to the low watermark line
|
|
3102
|
-
:param float max_value: The maximum value for the left axis
|
|
3103
|
-
:param float min_value: The minimum value for the left axis
|
|
3409
|
+
:param float high_watermark: A line to draw as a high watermark.
|
|
3410
|
+
:param str high_watermark_label: A label to attach to the high watermark line.
|
|
3411
|
+
:param str label: Label of the left axis.
|
|
3412
|
+
:param float low_watermark: A line to draw as a low watermark.
|
|
3413
|
+
:param str low_watermark_label: A label to attach to the low watermark line.
|
|
3414
|
+
:param float max_value: The maximum value for the left axis.
|
|
3415
|
+
:param float min_value: The minimum value for the left axis.
|
|
3104
3416
|
"""
|
|
3105
3417
|
if high_watermark is not None:
|
|
3106
3418
|
pulumi.set(__self__, "high_watermark", high_watermark)
|
|
@@ -3123,7 +3435,7 @@ class TimeChartAxisLeft(dict):
|
|
|
3123
3435
|
@pulumi.getter(name="highWatermark")
|
|
3124
3436
|
def high_watermark(self) -> Optional[float]:
|
|
3125
3437
|
"""
|
|
3126
|
-
A line to draw as a high watermark
|
|
3438
|
+
A line to draw as a high watermark.
|
|
3127
3439
|
"""
|
|
3128
3440
|
return pulumi.get(self, "high_watermark")
|
|
3129
3441
|
|
|
@@ -3131,7 +3443,7 @@ class TimeChartAxisLeft(dict):
|
|
|
3131
3443
|
@pulumi.getter(name="highWatermarkLabel")
|
|
3132
3444
|
def high_watermark_label(self) -> Optional[str]:
|
|
3133
3445
|
"""
|
|
3134
|
-
A label to attach to the high watermark line
|
|
3446
|
+
A label to attach to the high watermark line.
|
|
3135
3447
|
"""
|
|
3136
3448
|
return pulumi.get(self, "high_watermark_label")
|
|
3137
3449
|
|
|
@@ -3139,7 +3451,7 @@ class TimeChartAxisLeft(dict):
|
|
|
3139
3451
|
@pulumi.getter
|
|
3140
3452
|
def label(self) -> Optional[str]:
|
|
3141
3453
|
"""
|
|
3142
|
-
Label of the left axis
|
|
3454
|
+
Label of the left axis.
|
|
3143
3455
|
"""
|
|
3144
3456
|
return pulumi.get(self, "label")
|
|
3145
3457
|
|
|
@@ -3147,7 +3459,7 @@ class TimeChartAxisLeft(dict):
|
|
|
3147
3459
|
@pulumi.getter(name="lowWatermark")
|
|
3148
3460
|
def low_watermark(self) -> Optional[float]:
|
|
3149
3461
|
"""
|
|
3150
|
-
A line to draw as a low watermark
|
|
3462
|
+
A line to draw as a low watermark.
|
|
3151
3463
|
"""
|
|
3152
3464
|
return pulumi.get(self, "low_watermark")
|
|
3153
3465
|
|
|
@@ -3155,7 +3467,7 @@ class TimeChartAxisLeft(dict):
|
|
|
3155
3467
|
@pulumi.getter(name="lowWatermarkLabel")
|
|
3156
3468
|
def low_watermark_label(self) -> Optional[str]:
|
|
3157
3469
|
"""
|
|
3158
|
-
A label to attach to the low watermark line
|
|
3470
|
+
A label to attach to the low watermark line.
|
|
3159
3471
|
"""
|
|
3160
3472
|
return pulumi.get(self, "low_watermark_label")
|
|
3161
3473
|
|
|
@@ -3163,7 +3475,7 @@ class TimeChartAxisLeft(dict):
|
|
|
3163
3475
|
@pulumi.getter(name="maxValue")
|
|
3164
3476
|
def max_value(self) -> Optional[float]:
|
|
3165
3477
|
"""
|
|
3166
|
-
The maximum value for the left axis
|
|
3478
|
+
The maximum value for the left axis.
|
|
3167
3479
|
"""
|
|
3168
3480
|
return pulumi.get(self, "max_value")
|
|
3169
3481
|
|
|
@@ -3171,7 +3483,7 @@ class TimeChartAxisLeft(dict):
|
|
|
3171
3483
|
@pulumi.getter(name="minValue")
|
|
3172
3484
|
def min_value(self) -> Optional[float]:
|
|
3173
3485
|
"""
|
|
3174
|
-
The minimum value for the left axis
|
|
3486
|
+
The minimum value for the left axis.
|
|
3175
3487
|
"""
|
|
3176
3488
|
return pulumi.get(self, "min_value")
|
|
3177
3489
|
|
|
@@ -3250,13 +3562,13 @@ class TimeChartAxisRight(dict):
|
|
|
3250
3562
|
min_value: Optional[float] = None,
|
|
3251
3563
|
watermarks: Optional[Sequence['outputs.TimeChartAxisRightWatermark']] = None):
|
|
3252
3564
|
"""
|
|
3253
|
-
:param float high_watermark: A line to draw as a high watermark
|
|
3254
|
-
:param str high_watermark_label: A label to attach to the high watermark line
|
|
3255
|
-
:param str label: Label of the right axis
|
|
3256
|
-
:param float low_watermark: A line to draw as a low watermark
|
|
3257
|
-
:param str low_watermark_label: A label to attach to the low watermark line
|
|
3258
|
-
:param float max_value: The maximum value for the right axis
|
|
3259
|
-
:param float min_value: The minimum value for the right axis
|
|
3565
|
+
:param float high_watermark: A line to draw as a high watermark.
|
|
3566
|
+
:param str high_watermark_label: A label to attach to the high watermark line.
|
|
3567
|
+
:param str label: Label of the right axis.
|
|
3568
|
+
:param float low_watermark: A line to draw as a low watermark.
|
|
3569
|
+
:param str low_watermark_label: A label to attach to the low watermark line.
|
|
3570
|
+
:param float max_value: The maximum value for the right axis.
|
|
3571
|
+
:param float min_value: The minimum value for the right axis.
|
|
3260
3572
|
"""
|
|
3261
3573
|
if high_watermark is not None:
|
|
3262
3574
|
pulumi.set(__self__, "high_watermark", high_watermark)
|
|
@@ -3279,7 +3591,7 @@ class TimeChartAxisRight(dict):
|
|
|
3279
3591
|
@pulumi.getter(name="highWatermark")
|
|
3280
3592
|
def high_watermark(self) -> Optional[float]:
|
|
3281
3593
|
"""
|
|
3282
|
-
A line to draw as a high watermark
|
|
3594
|
+
A line to draw as a high watermark.
|
|
3283
3595
|
"""
|
|
3284
3596
|
return pulumi.get(self, "high_watermark")
|
|
3285
3597
|
|
|
@@ -3287,7 +3599,7 @@ class TimeChartAxisRight(dict):
|
|
|
3287
3599
|
@pulumi.getter(name="highWatermarkLabel")
|
|
3288
3600
|
def high_watermark_label(self) -> Optional[str]:
|
|
3289
3601
|
"""
|
|
3290
|
-
A label to attach to the high watermark line
|
|
3602
|
+
A label to attach to the high watermark line.
|
|
3291
3603
|
"""
|
|
3292
3604
|
return pulumi.get(self, "high_watermark_label")
|
|
3293
3605
|
|
|
@@ -3295,7 +3607,7 @@ class TimeChartAxisRight(dict):
|
|
|
3295
3607
|
@pulumi.getter
|
|
3296
3608
|
def label(self) -> Optional[str]:
|
|
3297
3609
|
"""
|
|
3298
|
-
Label of the right axis
|
|
3610
|
+
Label of the right axis.
|
|
3299
3611
|
"""
|
|
3300
3612
|
return pulumi.get(self, "label")
|
|
3301
3613
|
|
|
@@ -3303,7 +3615,7 @@ class TimeChartAxisRight(dict):
|
|
|
3303
3615
|
@pulumi.getter(name="lowWatermark")
|
|
3304
3616
|
def low_watermark(self) -> Optional[float]:
|
|
3305
3617
|
"""
|
|
3306
|
-
A line to draw as a low watermark
|
|
3618
|
+
A line to draw as a low watermark.
|
|
3307
3619
|
"""
|
|
3308
3620
|
return pulumi.get(self, "low_watermark")
|
|
3309
3621
|
|
|
@@ -3311,7 +3623,7 @@ class TimeChartAxisRight(dict):
|
|
|
3311
3623
|
@pulumi.getter(name="lowWatermarkLabel")
|
|
3312
3624
|
def low_watermark_label(self) -> Optional[str]:
|
|
3313
3625
|
"""
|
|
3314
|
-
A label to attach to the low watermark line
|
|
3626
|
+
A label to attach to the low watermark line.
|
|
3315
3627
|
"""
|
|
3316
3628
|
return pulumi.get(self, "low_watermark_label")
|
|
3317
3629
|
|
|
@@ -3319,7 +3631,7 @@ class TimeChartAxisRight(dict):
|
|
|
3319
3631
|
@pulumi.getter(name="maxValue")
|
|
3320
3632
|
def max_value(self) -> Optional[float]:
|
|
3321
3633
|
"""
|
|
3322
|
-
The maximum value for the right axis
|
|
3634
|
+
The maximum value for the right axis.
|
|
3323
3635
|
"""
|
|
3324
3636
|
return pulumi.get(self, "max_value")
|
|
3325
3637
|
|
|
@@ -3327,7 +3639,7 @@ class TimeChartAxisRight(dict):
|
|
|
3327
3639
|
@pulumi.getter(name="minValue")
|
|
3328
3640
|
def min_value(self) -> Optional[float]:
|
|
3329
3641
|
"""
|
|
3330
|
-
The minimum value for the right axis
|
|
3642
|
+
The minimum value for the right axis.
|
|
3331
3643
|
"""
|
|
3332
3644
|
return pulumi.get(self, "min_value")
|
|
3333
3645
|
|
|
@@ -3391,8 +3703,8 @@ class TimeChartEventOption(dict):
|
|
|
3391
3703
|
color: Optional[str] = None,
|
|
3392
3704
|
display_name: Optional[str] = None):
|
|
3393
3705
|
"""
|
|
3394
|
-
:param str label:
|
|
3395
|
-
:param str color: Color to use
|
|
3706
|
+
:param str label: Label used in the publish statement that displays the event query you want to customize.
|
|
3707
|
+
:param str color: Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
3396
3708
|
:param str display_name: Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
|
|
3397
3709
|
"""
|
|
3398
3710
|
pulumi.set(__self__, "label", label)
|
|
@@ -3405,7 +3717,7 @@ class TimeChartEventOption(dict):
|
|
|
3405
3717
|
@pulumi.getter
|
|
3406
3718
|
def label(self) -> str:
|
|
3407
3719
|
"""
|
|
3408
|
-
|
|
3720
|
+
Label used in the publish statement that displays the event query you want to customize.
|
|
3409
3721
|
"""
|
|
3410
3722
|
return pulumi.get(self, "label")
|
|
3411
3723
|
|
|
@@ -3413,7 +3725,7 @@ class TimeChartEventOption(dict):
|
|
|
3413
3725
|
@pulumi.getter
|
|
3414
3726
|
def color(self) -> Optional[str]:
|
|
3415
3727
|
"""
|
|
3416
|
-
Color to use
|
|
3728
|
+
Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
3417
3729
|
"""
|
|
3418
3730
|
return pulumi.get(self, "color")
|
|
3419
3731
|
|
|
@@ -3448,7 +3760,7 @@ class TimeChartHistogramOption(dict):
|
|
|
3448
3760
|
def __init__(__self__, *,
|
|
3449
3761
|
color_theme: Optional[str] = None):
|
|
3450
3762
|
"""
|
|
3451
|
-
:param str color_theme:
|
|
3763
|
+
:param str color_theme: Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine, red, gold, greenyellow, chartreuse, jade
|
|
3452
3764
|
"""
|
|
3453
3765
|
if color_theme is not None:
|
|
3454
3766
|
pulumi.set(__self__, "color_theme", color_theme)
|
|
@@ -3457,7 +3769,7 @@ class TimeChartHistogramOption(dict):
|
|
|
3457
3769
|
@pulumi.getter(name="colorTheme")
|
|
3458
3770
|
def color_theme(self) -> Optional[str]:
|
|
3459
3771
|
"""
|
|
3460
|
-
|
|
3772
|
+
Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine, red, gold, greenyellow, chartreuse, jade
|
|
3461
3773
|
"""
|
|
3462
3774
|
return pulumi.get(self, "color_theme")
|
|
3463
3775
|
|
|
@@ -3468,8 +3780,8 @@ class TimeChartLegendOptionsField(dict):
|
|
|
3468
3780
|
property: str,
|
|
3469
3781
|
enabled: Optional[bool] = None):
|
|
3470
3782
|
"""
|
|
3471
|
-
:param str property: The name of
|
|
3472
|
-
:param bool enabled:
|
|
3783
|
+
:param str property: The name of the property to display. Note the special values of `plot_label` (corresponding with the API's `sf_metric`) 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.
|
|
3784
|
+
:param bool enabled: True or False depending on if you want the property to be shown or hidden.
|
|
3473
3785
|
"""
|
|
3474
3786
|
pulumi.set(__self__, "property", property)
|
|
3475
3787
|
if enabled is not None:
|
|
@@ -3479,7 +3791,7 @@ class TimeChartLegendOptionsField(dict):
|
|
|
3479
3791
|
@pulumi.getter
|
|
3480
3792
|
def enabled(self) -> Optional[bool]:
|
|
3481
3793
|
"""
|
|
3482
|
-
|
|
3794
|
+
True or False depending on if you want the property to be shown or hidden.
|
|
3483
3795
|
"""
|
|
3484
3796
|
return pulumi.get(self, "enabled")
|
|
3485
3797
|
|
|
@@ -3487,7 +3799,7 @@ class TimeChartLegendOptionsField(dict):
|
|
|
3487
3799
|
@pulumi.getter
|
|
3488
3800
|
def property(self) -> str:
|
|
3489
3801
|
"""
|
|
3490
|
-
The name of
|
|
3802
|
+
The name of the property to display. Note the special values of `plot_label` (corresponding with the API's `sf_metric`) 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.
|
|
3491
3803
|
"""
|
|
3492
3804
|
return pulumi.get(self, "property")
|
|
3493
3805
|
|
|
@@ -3529,14 +3841,14 @@ class TimeChartVizOption(dict):
|
|
|
3529
3841
|
value_suffix: Optional[str] = None,
|
|
3530
3842
|
value_unit: Optional[str] = None):
|
|
3531
3843
|
"""
|
|
3532
|
-
:param str label:
|
|
3533
|
-
:param str axis:
|
|
3534
|
-
:param str color: Color to use
|
|
3844
|
+
:param str label: Label used in the publish statement that displays the plot (metric time series data) you want to customize.
|
|
3845
|
+
:param str axis: Y-axis associated with values for this plot. Must be either `right` or `left`.
|
|
3846
|
+
:param str color: Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
3535
3847
|
:param str display_name: Specifies an alternate value for the Plot Name column of the Data Table associated with the chart.
|
|
3536
|
-
:param str plot_type:
|
|
3537
|
-
:param str value_prefix:
|
|
3848
|
+
:param str plot_type: The visualization style to use. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Chart level `plot_type` by default.
|
|
3849
|
+
:param str value_prefix: , `value_suffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
|
|
3538
3850
|
:param str value_suffix: An arbitrary suffix to display with the value of this plot
|
|
3539
|
-
:param str value_unit: A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
|
|
3851
|
+
:param str value_unit: 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`.
|
|
3540
3852
|
"""
|
|
3541
3853
|
pulumi.set(__self__, "label", label)
|
|
3542
3854
|
if axis is not None:
|
|
@@ -3558,7 +3870,7 @@ class TimeChartVizOption(dict):
|
|
|
3558
3870
|
@pulumi.getter
|
|
3559
3871
|
def label(self) -> str:
|
|
3560
3872
|
"""
|
|
3561
|
-
|
|
3873
|
+
Label used in the publish statement that displays the plot (metric time series data) you want to customize.
|
|
3562
3874
|
"""
|
|
3563
3875
|
return pulumi.get(self, "label")
|
|
3564
3876
|
|
|
@@ -3566,7 +3878,7 @@ class TimeChartVizOption(dict):
|
|
|
3566
3878
|
@pulumi.getter
|
|
3567
3879
|
def axis(self) -> Optional[str]:
|
|
3568
3880
|
"""
|
|
3569
|
-
|
|
3881
|
+
Y-axis associated with values for this plot. Must be either `right` or `left`.
|
|
3570
3882
|
"""
|
|
3571
3883
|
return pulumi.get(self, "axis")
|
|
3572
3884
|
|
|
@@ -3574,7 +3886,7 @@ class TimeChartVizOption(dict):
|
|
|
3574
3886
|
@pulumi.getter
|
|
3575
3887
|
def color(self) -> Optional[str]:
|
|
3576
3888
|
"""
|
|
3577
|
-
Color to use
|
|
3889
|
+
Color to use : gray, blue, azure, navy, brown, orange, yellow, iris, magenta, pink, purple, violet, lilac, emerald, green, aquamarine.
|
|
3578
3890
|
"""
|
|
3579
3891
|
return pulumi.get(self, "color")
|
|
3580
3892
|
|
|
@@ -3590,7 +3902,7 @@ class TimeChartVizOption(dict):
|
|
|
3590
3902
|
@pulumi.getter(name="plotType")
|
|
3591
3903
|
def plot_type(self) -> Optional[str]:
|
|
3592
3904
|
"""
|
|
3593
|
-
|
|
3905
|
+
The visualization style to use. Must be `"LineChart"`, `"AreaChart"`, `"ColumnChart"`, or `"Histogram"`. Chart level `plot_type` by default.
|
|
3594
3906
|
"""
|
|
3595
3907
|
return pulumi.get(self, "plot_type")
|
|
3596
3908
|
|
|
@@ -3598,7 +3910,7 @@ class TimeChartVizOption(dict):
|
|
|
3598
3910
|
@pulumi.getter(name="valuePrefix")
|
|
3599
3911
|
def value_prefix(self) -> Optional[str]:
|
|
3600
3912
|
"""
|
|
3601
|
-
|
|
3913
|
+
, `value_suffix` - (Optional) Arbitrary prefix/suffix to display with the value of this plot.
|
|
3602
3914
|
"""
|
|
3603
3915
|
return pulumi.get(self, "value_prefix")
|
|
3604
3916
|
|
|
@@ -3614,7 +3926,7 @@ class TimeChartVizOption(dict):
|
|
|
3614
3926
|
@pulumi.getter(name="valueUnit")
|
|
3615
3927
|
def value_unit(self) -> Optional[str]:
|
|
3616
3928
|
"""
|
|
3617
|
-
A unit to attach to this plot. Units support automatic scaling (eg thousands of bytes will be displayed as kilobytes)
|
|
3929
|
+
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`.
|
|
3618
3930
|
"""
|
|
3619
3931
|
return pulumi.get(self, "value_unit")
|
|
3620
3932
|
|
|
@@ -3643,17 +3955,27 @@ class WebhookIntegrationHeader(dict):
|
|
|
3643
3955
|
def __init__(__self__, *,
|
|
3644
3956
|
header_key: str,
|
|
3645
3957
|
header_value: str):
|
|
3958
|
+
"""
|
|
3959
|
+
:param str header_key: The key of the header to send
|
|
3960
|
+
:param str header_value: The value of the header to send
|
|
3961
|
+
"""
|
|
3646
3962
|
pulumi.set(__self__, "header_key", header_key)
|
|
3647
3963
|
pulumi.set(__self__, "header_value", header_value)
|
|
3648
3964
|
|
|
3649
3965
|
@property
|
|
3650
3966
|
@pulumi.getter(name="headerKey")
|
|
3651
3967
|
def header_key(self) -> str:
|
|
3968
|
+
"""
|
|
3969
|
+
The key of the header to send
|
|
3970
|
+
"""
|
|
3652
3971
|
return pulumi.get(self, "header_key")
|
|
3653
3972
|
|
|
3654
3973
|
@property
|
|
3655
3974
|
@pulumi.getter(name="headerValue")
|
|
3656
3975
|
def header_value(self) -> str:
|
|
3976
|
+
"""
|
|
3977
|
+
The value of the header to send
|
|
3978
|
+
"""
|
|
3657
3979
|
return pulumi.get(self, "header_value")
|
|
3658
3980
|
|
|
3659
3981
|
|