pulumi-oci 1.40.0__py3-none-any.whl → 1.40.0a1718172898__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_oci/loganalytics/namespace.py +2 -2
- pulumi_oci/monitoring/_inputs.py +6 -10
- pulumi_oci/monitoring/alarm.py +28 -189
- pulumi_oci/monitoring/get_alarm.py +5 -44
- pulumi_oci/monitoring/outputs.py +28 -87
- pulumi_oci/pulumi-plugin.json +1 -1
- {pulumi_oci-1.40.0.dist-info → pulumi_oci-1.40.0a1718172898.dist-info}/METADATA +1 -1
- {pulumi_oci-1.40.0.dist-info → pulumi_oci-1.40.0a1718172898.dist-info}/RECORD +10 -10
- {pulumi_oci-1.40.0.dist-info → pulumi_oci-1.40.0a1718172898.dist-info}/WHEEL +0 -0
- {pulumi_oci-1.40.0.dist-info → pulumi_oci-1.40.0a1718172898.dist-info}/top_level.txt +0 -0
@@ -22,13 +22,10 @@ class GetAlarmResult:
|
|
22
22
|
"""
|
23
23
|
A collection of values returned by getAlarm.
|
24
24
|
"""
|
25
|
-
def __init__(__self__, alarm_id=None,
|
25
|
+
def __init__(__self__, alarm_id=None, body=None, compartment_id=None, defined_tags=None, destinations=None, display_name=None, freeform_tags=None, id=None, is_enabled=None, is_notifications_per_metric_dimension_enabled=None, message_format=None, metric_compartment_id=None, metric_compartment_id_in_subtree=None, namespace=None, notification_version=None, overrides=None, pending_duration=None, query=None, repeat_notification_duration=None, resolution=None, resource_group=None, rule_name=None, severity=None, state=None, suppressions=None, time_created=None, time_updated=None):
|
26
26
|
if alarm_id and not isinstance(alarm_id, str):
|
27
27
|
raise TypeError("Expected argument 'alarm_id' to be a str")
|
28
28
|
pulumi.set(__self__, "alarm_id", alarm_id)
|
29
|
-
if alarm_summary and not isinstance(alarm_summary, str):
|
30
|
-
raise TypeError("Expected argument 'alarm_summary' to be a str")
|
31
|
-
pulumi.set(__self__, "alarm_summary", alarm_summary)
|
32
29
|
if body and not isinstance(body, str):
|
33
30
|
raise TypeError("Expected argument 'body' to be a str")
|
34
31
|
pulumi.set(__self__, "body", body)
|
@@ -44,9 +41,6 @@ class GetAlarmResult:
|
|
44
41
|
if display_name and not isinstance(display_name, str):
|
45
42
|
raise TypeError("Expected argument 'display_name' to be a str")
|
46
43
|
pulumi.set(__self__, "display_name", display_name)
|
47
|
-
if evaluation_slack_duration and not isinstance(evaluation_slack_duration, str):
|
48
|
-
raise TypeError("Expected argument 'evaluation_slack_duration' to be a str")
|
49
|
-
pulumi.set(__self__, "evaluation_slack_duration", evaluation_slack_duration)
|
50
44
|
if freeform_tags and not isinstance(freeform_tags, dict):
|
51
45
|
raise TypeError("Expected argument 'freeform_tags' to be a dict")
|
52
46
|
pulumi.set(__self__, "freeform_tags", freeform_tags)
|
@@ -71,9 +65,6 @@ class GetAlarmResult:
|
|
71
65
|
if namespace and not isinstance(namespace, str):
|
72
66
|
raise TypeError("Expected argument 'namespace' to be a str")
|
73
67
|
pulumi.set(__self__, "namespace", namespace)
|
74
|
-
if notification_title and not isinstance(notification_title, str):
|
75
|
-
raise TypeError("Expected argument 'notification_title' to be a str")
|
76
|
-
pulumi.set(__self__, "notification_title", notification_title)
|
77
68
|
if notification_version and not isinstance(notification_version, str):
|
78
69
|
raise TypeError("Expected argument 'notification_version' to be a str")
|
79
70
|
pulumi.set(__self__, "notification_version", notification_version)
|
@@ -119,19 +110,11 @@ class GetAlarmResult:
|
|
119
110
|
def alarm_id(self) -> str:
|
120
111
|
return pulumi.get(self, "alarm_id")
|
121
112
|
|
122
|
-
@property
|
123
|
-
@pulumi.getter(name="alarmSummary")
|
124
|
-
def alarm_summary(self) -> str:
|
125
|
-
"""
|
126
|
-
Customizable alarm summary (`alarmSummary` [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). The alarm summary appears within the body of the alarm message and in responses to [ListAlarmStatus](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmStatusSummary/ListAlarmsStatus) [GetAlarmHistory](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmHistoryCollection/GetAlarmHistory) and [RetrieveDimensionStates](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates).
|
127
|
-
"""
|
128
|
-
return pulumi.get(self, "alarm_summary")
|
129
|
-
|
130
113
|
@property
|
131
114
|
@pulumi.getter
|
132
115
|
def body(self) -> str:
|
133
116
|
"""
|
134
|
-
The human-readable content of the delivered alarm notification.
|
117
|
+
The human-readable content of the delivered alarm notification. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: `High CPU usage alert. Follow runbook instructions for resolution.`
|
135
118
|
"""
|
136
119
|
return pulumi.get(self, "body")
|
137
120
|
|
@@ -167,14 +150,6 @@ class GetAlarmResult:
|
|
167
150
|
"""
|
168
151
|
return pulumi.get(self, "display_name")
|
169
152
|
|
170
|
-
@property
|
171
|
-
@pulumi.getter(name="evaluationSlackDuration")
|
172
|
-
def evaluation_slack_duration(self) -> str:
|
173
|
-
"""
|
174
|
-
Customizable slack period to wait for metric ingestion before evaluating the alarm. Specify a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. For more information about the slack period, see [About the Internal Reset Period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset).
|
175
|
-
"""
|
176
|
-
return pulumi.get(self, "evaluation_slack_duration")
|
177
|
-
|
178
153
|
@property
|
179
154
|
@pulumi.getter(name="freeformTags")
|
180
155
|
def freeform_tags(self) -> Mapping[str, Any]:
|
@@ -242,14 +217,6 @@ class GetAlarmResult:
|
|
242
217
|
"""
|
243
218
|
return pulumi.get(self, "namespace")
|
244
219
|
|
245
|
-
@property
|
246
|
-
@pulumi.getter(name="notificationTitle")
|
247
|
-
def notification_title(self) -> str:
|
248
|
-
"""
|
249
|
-
Customizable notification title (`title` [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). The notification title appears as the subject line in a formatted email message and as the title in a Slack message.
|
250
|
-
"""
|
251
|
-
return pulumi.get(self, "notification_title")
|
252
|
-
|
253
220
|
@property
|
254
221
|
@pulumi.getter(name="notificationVersion")
|
255
222
|
def notification_version(self) -> str:
|
@@ -278,7 +245,7 @@ class GetAlarmResult:
|
|
278
245
|
@pulumi.getter
|
279
246
|
def query(self) -> str:
|
280
247
|
"""
|
281
|
-
The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions.
|
248
|
+
The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. For information about writing MQL expressions, see [Editing the MQL Expression for a Query](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). For details about MQL, see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
|
282
249
|
"""
|
283
250
|
return pulumi.get(self, "query")
|
284
251
|
|
@@ -302,7 +269,7 @@ class GetAlarmResult:
|
|
302
269
|
@pulumi.getter(name="resourceGroup")
|
303
270
|
def resource_group(self) -> str:
|
304
271
|
"""
|
305
|
-
Resource group
|
272
|
+
Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: `frontend-fleet`
|
306
273
|
"""
|
307
274
|
return pulumi.get(self, "resource_group")
|
308
275
|
|
@@ -310,7 +277,7 @@ class GetAlarmResult:
|
|
310
277
|
@pulumi.getter(name="ruleName")
|
311
278
|
def rule_name(self) -> str:
|
312
279
|
"""
|
313
|
-
Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride).
|
280
|
+
Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. Minimum number of characters: 3. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride).
|
314
281
|
"""
|
315
282
|
return pulumi.get(self, "rule_name")
|
316
283
|
|
@@ -362,13 +329,11 @@ class AwaitableGetAlarmResult(GetAlarmResult):
|
|
362
329
|
yield self
|
363
330
|
return GetAlarmResult(
|
364
331
|
alarm_id=self.alarm_id,
|
365
|
-
alarm_summary=self.alarm_summary,
|
366
332
|
body=self.body,
|
367
333
|
compartment_id=self.compartment_id,
|
368
334
|
defined_tags=self.defined_tags,
|
369
335
|
destinations=self.destinations,
|
370
336
|
display_name=self.display_name,
|
371
|
-
evaluation_slack_duration=self.evaluation_slack_duration,
|
372
337
|
freeform_tags=self.freeform_tags,
|
373
338
|
id=self.id,
|
374
339
|
is_enabled=self.is_enabled,
|
@@ -377,7 +342,6 @@ class AwaitableGetAlarmResult(GetAlarmResult):
|
|
377
342
|
metric_compartment_id=self.metric_compartment_id,
|
378
343
|
metric_compartment_id_in_subtree=self.metric_compartment_id_in_subtree,
|
379
344
|
namespace=self.namespace,
|
380
|
-
notification_title=self.notification_title,
|
381
345
|
notification_version=self.notification_version,
|
382
346
|
overrides=self.overrides,
|
383
347
|
pending_duration=self.pending_duration,
|
@@ -427,13 +391,11 @@ def get_alarm(alarm_id: Optional[str] = None,
|
|
427
391
|
|
428
392
|
return AwaitableGetAlarmResult(
|
429
393
|
alarm_id=pulumi.get(__ret__, 'alarm_id'),
|
430
|
-
alarm_summary=pulumi.get(__ret__, 'alarm_summary'),
|
431
394
|
body=pulumi.get(__ret__, 'body'),
|
432
395
|
compartment_id=pulumi.get(__ret__, 'compartment_id'),
|
433
396
|
defined_tags=pulumi.get(__ret__, 'defined_tags'),
|
434
397
|
destinations=pulumi.get(__ret__, 'destinations'),
|
435
398
|
display_name=pulumi.get(__ret__, 'display_name'),
|
436
|
-
evaluation_slack_duration=pulumi.get(__ret__, 'evaluation_slack_duration'),
|
437
399
|
freeform_tags=pulumi.get(__ret__, 'freeform_tags'),
|
438
400
|
id=pulumi.get(__ret__, 'id'),
|
439
401
|
is_enabled=pulumi.get(__ret__, 'is_enabled'),
|
@@ -442,7 +404,6 @@ def get_alarm(alarm_id: Optional[str] = None,
|
|
442
404
|
metric_compartment_id=pulumi.get(__ret__, 'metric_compartment_id'),
|
443
405
|
metric_compartment_id_in_subtree=pulumi.get(__ret__, 'metric_compartment_id_in_subtree'),
|
444
406
|
namespace=pulumi.get(__ret__, 'namespace'),
|
445
|
-
notification_title=pulumi.get(__ret__, 'notification_title'),
|
446
407
|
notification_version=pulumi.get(__ret__, 'notification_version'),
|
447
408
|
overrides=pulumi.get(__ret__, 'overrides'),
|
448
409
|
pending_duration=pulumi.get(__ret__, 'pending_duration'),
|
pulumi_oci/monitoring/outputs.py
CHANGED
@@ -64,7 +64,7 @@ class AlarmOverride(dict):
|
|
64
64
|
rule_name: Optional[str] = None,
|
65
65
|
severity: Optional[str] = None):
|
66
66
|
"""
|
67
|
-
:param str body: (Updatable) The human-readable content of the delivered alarm notification.
|
67
|
+
:param str body: (Updatable) The human-readable content of the delivered alarm notification. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: `High CPU usage alert. Follow runbook instructions for resolution.`
|
68
68
|
:param str pending_duration: (Updatable) The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
|
69
69
|
|
70
70
|
The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M.
|
@@ -74,7 +74,7 @@ class AlarmOverride(dict):
|
|
74
74
|
The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute.
|
75
75
|
|
76
76
|
Example: `PT5M`
|
77
|
-
:param str query: (Updatable) The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions.
|
77
|
+
:param str query: (Updatable) The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. For information about writing MQL expressions, see [Editing the MQL Expression for a Query](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). For details about MQL, see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
|
78
78
|
|
79
79
|
Example of threshold alarm:
|
80
80
|
|
@@ -90,9 +90,7 @@ class AlarmOverride(dict):
|
|
90
90
|
|
91
91
|
CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent()
|
92
92
|
|
93
|
-
-----
|
94
|
-
|
95
|
-
----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) -----
|
93
|
+
-----
|
96
94
|
:param str rule_name: (Updatable) A user-friendly description for this alarm override. Must be unique across all `ruleName` values for the alarm.
|
97
95
|
:param str severity: (Updatable) The perceived severity of the alarm with regard to the affected system. Example: `CRITICAL`
|
98
96
|
"""
|
@@ -111,7 +109,7 @@ class AlarmOverride(dict):
|
|
111
109
|
@pulumi.getter
|
112
110
|
def body(self) -> Optional[str]:
|
113
111
|
"""
|
114
|
-
(Updatable) The human-readable content of the delivered alarm notification.
|
112
|
+
(Updatable) The human-readable content of the delivered alarm notification. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: `High CPU usage alert. Follow runbook instructions for resolution.`
|
115
113
|
"""
|
116
114
|
return pulumi.get(self, "body")
|
117
115
|
|
@@ -135,7 +133,7 @@ class AlarmOverride(dict):
|
|
135
133
|
@pulumi.getter
|
136
134
|
def query(self) -> Optional[str]:
|
137
135
|
"""
|
138
|
-
(Updatable) The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions.
|
136
|
+
(Updatable) The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. For information about writing MQL expressions, see [Editing the MQL Expression for a Query](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). For details about MQL, see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
|
139
137
|
|
140
138
|
Example of threshold alarm:
|
141
139
|
|
@@ -151,9 +149,7 @@ class AlarmOverride(dict):
|
|
151
149
|
|
152
150
|
CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent()
|
153
151
|
|
154
|
-
-----
|
155
|
-
|
156
|
-
----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) -----
|
152
|
+
-----
|
157
153
|
"""
|
158
154
|
return pulumi.get(self, "query")
|
159
155
|
|
@@ -301,29 +297,18 @@ class AlarmSuppressionAlarmSuppressionTarget(dict):
|
|
301
297
|
@pulumi.output_type
|
302
298
|
class GetAlarmHistoryCollectionEntryResult(dict):
|
303
299
|
def __init__(__self__, *,
|
304
|
-
alarm_summary: str,
|
305
300
|
summary: str,
|
306
301
|
timestamp: str,
|
307
302
|
timestamp_triggered: str):
|
308
303
|
"""
|
309
|
-
:param str alarm_summary: Customizable alarm summary (`alarmSummary` [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). The alarm summary appears within the body of the alarm message and in responses to [ListAlarmStatus](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmStatusSummary/ListAlarmsStatus) [GetAlarmHistory](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmHistoryCollection/GetAlarmHistory) and [RetrieveDimensionStates](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates).
|
310
304
|
:param str summary: Description for this alarm history entry.
|
311
305
|
:param str timestamp: Timestamp for this alarm history entry. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z`
|
312
306
|
:param str timestamp_triggered: Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Available for state transition entries only. Note: A three-minute lag for this value accounts for any late-arriving metrics. Example: `2023-02-01T0:59:00.789Z`
|
313
307
|
"""
|
314
|
-
pulumi.set(__self__, "alarm_summary", alarm_summary)
|
315
308
|
pulumi.set(__self__, "summary", summary)
|
316
309
|
pulumi.set(__self__, "timestamp", timestamp)
|
317
310
|
pulumi.set(__self__, "timestamp_triggered", timestamp_triggered)
|
318
311
|
|
319
|
-
@property
|
320
|
-
@pulumi.getter(name="alarmSummary")
|
321
|
-
def alarm_summary(self) -> str:
|
322
|
-
"""
|
323
|
-
Customizable alarm summary (`alarmSummary` [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). The alarm summary appears within the body of the alarm message and in responses to [ListAlarmStatus](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmStatusSummary/ListAlarmsStatus) [GetAlarmHistory](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmHistoryCollection/GetAlarmHistory) and [RetrieveDimensionStates](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates).
|
324
|
-
"""
|
325
|
-
return pulumi.get(self, "alarm_summary")
|
326
|
-
|
327
312
|
@property
|
328
313
|
@pulumi.getter
|
329
314
|
def summary(self) -> str:
|
@@ -358,10 +343,10 @@ class GetAlarmOverrideResult(dict):
|
|
358
343
|
rule_name: str,
|
359
344
|
severity: str):
|
360
345
|
"""
|
361
|
-
:param str body: The human-readable content of the delivered alarm notification.
|
346
|
+
:param str body: The human-readable content of the delivered alarm notification. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: `High CPU usage alert. Follow runbook instructions for resolution.`
|
362
347
|
:param str pending_duration: The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
|
363
|
-
:param str query: The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions.
|
364
|
-
:param str rule_name: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride).
|
348
|
+
:param str query: The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. For information about writing MQL expressions, see [Editing the MQL Expression for a Query](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). For details about MQL, see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
|
349
|
+
:param str rule_name: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. Minimum number of characters: 3. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride).
|
365
350
|
:param str severity: The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL`
|
366
351
|
"""
|
367
352
|
pulumi.set(__self__, "body", body)
|
@@ -374,7 +359,7 @@ class GetAlarmOverrideResult(dict):
|
|
374
359
|
@pulumi.getter
|
375
360
|
def body(self) -> str:
|
376
361
|
"""
|
377
|
-
The human-readable content of the delivered alarm notification.
|
362
|
+
The human-readable content of the delivered alarm notification. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: `High CPU usage alert. Follow runbook instructions for resolution.`
|
378
363
|
"""
|
379
364
|
return pulumi.get(self, "body")
|
380
365
|
|
@@ -390,7 +375,7 @@ class GetAlarmOverrideResult(dict):
|
|
390
375
|
@pulumi.getter
|
391
376
|
def query(self) -> str:
|
392
377
|
"""
|
393
|
-
The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions.
|
378
|
+
The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. For information about writing MQL expressions, see [Editing the MQL Expression for a Query](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). For details about MQL, see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
|
394
379
|
"""
|
395
380
|
return pulumi.get(self, "query")
|
396
381
|
|
@@ -398,7 +383,7 @@ class GetAlarmOverrideResult(dict):
|
|
398
383
|
@pulumi.getter(name="ruleName")
|
399
384
|
def rule_name(self) -> str:
|
400
385
|
"""
|
401
|
-
Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride).
|
386
|
+
Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. Minimum number of characters: 3. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride).
|
402
387
|
"""
|
403
388
|
return pulumi.get(self, "rule_name")
|
404
389
|
|
@@ -414,7 +399,6 @@ class GetAlarmOverrideResult(dict):
|
|
414
399
|
@pulumi.output_type
|
415
400
|
class GetAlarmStatusesAlarmStatusResult(dict):
|
416
401
|
def __init__(__self__, *,
|
417
|
-
alarm_summary: str,
|
418
402
|
display_name: str,
|
419
403
|
id: str,
|
420
404
|
rule_name: str,
|
@@ -423,16 +407,14 @@ class GetAlarmStatusesAlarmStatusResult(dict):
|
|
423
407
|
suppressions: Sequence['outputs.GetAlarmStatusesAlarmStatusSuppressionResult'],
|
424
408
|
timestamp_triggered: str):
|
425
409
|
"""
|
426
|
-
:param str alarm_summary: Customizable alarm summary (`alarmSummary` [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). The alarm summary appears within the body of the alarm message and in responses to [ListAlarmStatus](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmStatusSummary/ListAlarmsStatus) [GetAlarmHistory](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmHistoryCollection/GetAlarmHistory) and [RetrieveDimensionStates](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates).
|
427
410
|
:param str display_name: A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
|
428
411
|
:param str id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm.
|
429
|
-
:param str rule_name: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride).
|
412
|
+
:param str rule_name: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. Minimum number of characters: 3. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride).
|
430
413
|
:param str severity: The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL`
|
431
414
|
:param str status: The status of the metric stream to use for alarm filtering. For example, set `StatusQueryParam` to "FIRING" to filter results to metric streams of the alarm with that status. Default behaviour is to return alarms irrespective of metric streams' status. Example: `FIRING`
|
432
415
|
:param Sequence['GetAlarmStatusesAlarmStatusSuppressionArgs'] suppressions: The configuration details for suppressing an alarm.
|
433
416
|
:param str timestamp_triggered: Timestamp for the transition of the alarm state. For example, the time when the alarm transitioned from OK to Firing. Note: A three-minute lag for this value accounts for any late-arriving metrics. Example: `2023-02-01T01:02:29.600Z`
|
434
417
|
"""
|
435
|
-
pulumi.set(__self__, "alarm_summary", alarm_summary)
|
436
418
|
pulumi.set(__self__, "display_name", display_name)
|
437
419
|
pulumi.set(__self__, "id", id)
|
438
420
|
pulumi.set(__self__, "rule_name", rule_name)
|
@@ -441,14 +423,6 @@ class GetAlarmStatusesAlarmStatusResult(dict):
|
|
441
423
|
pulumi.set(__self__, "suppressions", suppressions)
|
442
424
|
pulumi.set(__self__, "timestamp_triggered", timestamp_triggered)
|
443
425
|
|
444
|
-
@property
|
445
|
-
@pulumi.getter(name="alarmSummary")
|
446
|
-
def alarm_summary(self) -> str:
|
447
|
-
"""
|
448
|
-
Customizable alarm summary (`alarmSummary` [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). The alarm summary appears within the body of the alarm message and in responses to [ListAlarmStatus](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmStatusSummary/ListAlarmsStatus) [GetAlarmHistory](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmHistoryCollection/GetAlarmHistory) and [RetrieveDimensionStates](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates).
|
449
|
-
"""
|
450
|
-
return pulumi.get(self, "alarm_summary")
|
451
|
-
|
452
426
|
@property
|
453
427
|
@pulumi.getter(name="displayName")
|
454
428
|
def display_name(self) -> str:
|
@@ -469,7 +443,7 @@ class GetAlarmStatusesAlarmStatusResult(dict):
|
|
469
443
|
@pulumi.getter(name="ruleName")
|
470
444
|
def rule_name(self) -> str:
|
471
445
|
"""
|
472
|
-
Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride).
|
446
|
+
Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. Minimum number of characters: 3. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride).
|
473
447
|
"""
|
474
448
|
return pulumi.get(self, "rule_name")
|
475
449
|
|
@@ -863,13 +837,11 @@ class GetAlarmSuppressionsFilterResult(dict):
|
|
863
837
|
@pulumi.output_type
|
864
838
|
class GetAlarmsAlarmResult(dict):
|
865
839
|
def __init__(__self__, *,
|
866
|
-
alarm_summary: str,
|
867
840
|
body: str,
|
868
841
|
compartment_id: str,
|
869
842
|
defined_tags: Mapping[str, Any],
|
870
843
|
destinations: Sequence[str],
|
871
844
|
display_name: str,
|
872
|
-
evaluation_slack_duration: str,
|
873
845
|
freeform_tags: Mapping[str, Any],
|
874
846
|
id: str,
|
875
847
|
is_enabled: bool,
|
@@ -878,7 +850,6 @@ class GetAlarmsAlarmResult(dict):
|
|
878
850
|
metric_compartment_id: str,
|
879
851
|
metric_compartment_id_in_subtree: bool,
|
880
852
|
namespace: str,
|
881
|
-
notification_title: str,
|
882
853
|
notification_version: str,
|
883
854
|
overrides: Sequence['outputs.GetAlarmsAlarmOverrideResult'],
|
884
855
|
pending_duration: str,
|
@@ -893,13 +864,11 @@ class GetAlarmsAlarmResult(dict):
|
|
893
864
|
time_created: str,
|
894
865
|
time_updated: str):
|
895
866
|
"""
|
896
|
-
:param str
|
897
|
-
:param str body: The human-readable content of the delivered alarm notification. Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: `High CPU usage alert. Follow runbook instructions for resolution.`
|
867
|
+
:param str body: The human-readable content of the delivered alarm notification. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: `High CPU usage alert. Follow runbook instructions for resolution.`
|
898
868
|
:param str compartment_id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the resources monitored by the metric that you are searching for. Use tenancyId to search in the root compartment. Example: `ocid1.compartment.oc1..exampleuniqueID`
|
899
869
|
:param Mapping[str, Any] defined_tags: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}`
|
900
870
|
:param Sequence[str] destinations: A list of destinations for alarm notifications. Each destination is represented by the [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of a related resource, such as a [topic](https://docs.cloud.oracle.com/iaas/api/#/en/notification/latest/NotificationTopic). Supported destination services: Notifications, Streaming. Limit: One destination per supported destination service.
|
901
871
|
:param str display_name: A filter to return only resources that match the given display name exactly. Use this filter to list an alarm by name. Alternatively, when you know the alarm OCID, use the GetAlarm operation.
|
902
|
-
:param str evaluation_slack_duration: Customizable slack period to wait for metric ingestion before evaluating the alarm. Specify a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. For more information about the slack period, see [About the Internal Reset Period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset).
|
903
872
|
:param Mapping[str, Any] freeform_tags: Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}`
|
904
873
|
:param str id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm.
|
905
874
|
:param bool is_enabled: Whether the alarm is enabled. Example: `true`
|
@@ -911,28 +880,25 @@ class GetAlarmsAlarmResult(dict):
|
|
911
880
|
:param str metric_compartment_id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric being evaluated by the alarm.
|
912
881
|
:param bool metric_compartment_id_in_subtree: When true, the alarm evaluates metrics from all compartments and subcompartments. The parameter can only be set to true when metricCompartmentId is the tenancy OCID (the tenancy is the root compartment). A true value requires the user to have tenancy-level permissions. If this requirement is not met, then the call is rejected. When false, the alarm evaluates metrics from only the compartment specified in metricCompartmentId. Default is false. Example: `true`
|
913
882
|
:param str namespace: The source service or application emitting the metric that is evaluated by the alarm. Example: `oci_computeagent`
|
914
|
-
:param str notification_title: Customizable notification title (`title` [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). The notification title appears as the subject line in a formatted email message and as the title in a Slack message.
|
915
883
|
:param str notification_version: The version of the alarm notification to be delivered. Allowed value: `1.X` The value must start with a number (up to four digits), followed by a period and an uppercase X.
|
916
884
|
:param Sequence['GetAlarmsAlarmOverrideArgs'] overrides: A set of overrides that control evaluations of the alarm.
|
917
885
|
:param str pending_duration: The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
|
918
|
-
:param str query: The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions.
|
886
|
+
:param str query: The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. For information about writing MQL expressions, see [Editing the MQL Expression for a Query](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). For details about MQL, see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
|
919
887
|
:param str repeat_notification_duration: The frequency for re-submitting alarm notifications, if the alarm keeps firing without interruption. Format defined by ISO 8601. For example, `PT4H` indicates four hours. Minimum: PT1M. Maximum: P30D.
|
920
888
|
:param str resolution: The time between calculated aggregation windows for the alarm. Supported value: `1m`
|
921
|
-
:param str resource_group: Resource group
|
922
|
-
:param str rule_name: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride).
|
889
|
+
:param str resource_group: Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: `frontend-fleet`
|
890
|
+
:param str rule_name: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. Minimum number of characters: 3. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride).
|
923
891
|
:param str severity: The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL`
|
924
892
|
:param str state: A filter to return only alarms that match the given lifecycle state exactly. When not specified, only alarms in the ACTIVE lifecycle state are listed.
|
925
893
|
:param Sequence['GetAlarmsAlarmSuppressionArgs'] suppressions: The configuration details for suppressing an alarm.
|
926
894
|
:param str time_created: The date and time the alarm was created. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z`
|
927
895
|
:param str time_updated: The date and time the alarm was last updated. Format defined by RFC3339. Example: `2023-02-03T01:02:29.600Z`
|
928
896
|
"""
|
929
|
-
pulumi.set(__self__, "alarm_summary", alarm_summary)
|
930
897
|
pulumi.set(__self__, "body", body)
|
931
898
|
pulumi.set(__self__, "compartment_id", compartment_id)
|
932
899
|
pulumi.set(__self__, "defined_tags", defined_tags)
|
933
900
|
pulumi.set(__self__, "destinations", destinations)
|
934
901
|
pulumi.set(__self__, "display_name", display_name)
|
935
|
-
pulumi.set(__self__, "evaluation_slack_duration", evaluation_slack_duration)
|
936
902
|
pulumi.set(__self__, "freeform_tags", freeform_tags)
|
937
903
|
pulumi.set(__self__, "id", id)
|
938
904
|
pulumi.set(__self__, "is_enabled", is_enabled)
|
@@ -941,7 +907,6 @@ class GetAlarmsAlarmResult(dict):
|
|
941
907
|
pulumi.set(__self__, "metric_compartment_id", metric_compartment_id)
|
942
908
|
pulumi.set(__self__, "metric_compartment_id_in_subtree", metric_compartment_id_in_subtree)
|
943
909
|
pulumi.set(__self__, "namespace", namespace)
|
944
|
-
pulumi.set(__self__, "notification_title", notification_title)
|
945
910
|
pulumi.set(__self__, "notification_version", notification_version)
|
946
911
|
pulumi.set(__self__, "overrides", overrides)
|
947
912
|
pulumi.set(__self__, "pending_duration", pending_duration)
|
@@ -956,19 +921,11 @@ class GetAlarmsAlarmResult(dict):
|
|
956
921
|
pulumi.set(__self__, "time_created", time_created)
|
957
922
|
pulumi.set(__self__, "time_updated", time_updated)
|
958
923
|
|
959
|
-
@property
|
960
|
-
@pulumi.getter(name="alarmSummary")
|
961
|
-
def alarm_summary(self) -> str:
|
962
|
-
"""
|
963
|
-
Customizable alarm summary (`alarmSummary` [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). The alarm summary appears within the body of the alarm message and in responses to [ListAlarmStatus](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmStatusSummary/ListAlarmsStatus) [GetAlarmHistory](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmHistoryCollection/GetAlarmHistory) and [RetrieveDimensionStates](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/AlarmDimensionStatesCollection/RetrieveDimensionStates).
|
964
|
-
"""
|
965
|
-
return pulumi.get(self, "alarm_summary")
|
966
|
-
|
967
924
|
@property
|
968
925
|
@pulumi.getter
|
969
926
|
def body(self) -> str:
|
970
927
|
"""
|
971
|
-
The human-readable content of the delivered alarm notification.
|
928
|
+
The human-readable content of the delivered alarm notification. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: `High CPU usage alert. Follow runbook instructions for resolution.`
|
972
929
|
"""
|
973
930
|
return pulumi.get(self, "body")
|
974
931
|
|
@@ -1004,14 +961,6 @@ class GetAlarmsAlarmResult(dict):
|
|
1004
961
|
"""
|
1005
962
|
return pulumi.get(self, "display_name")
|
1006
963
|
|
1007
|
-
@property
|
1008
|
-
@pulumi.getter(name="evaluationSlackDuration")
|
1009
|
-
def evaluation_slack_duration(self) -> str:
|
1010
|
-
"""
|
1011
|
-
Customizable slack period to wait for metric ingestion before evaluating the alarm. Specify a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT3M. Maximum: PT2H. Default: PT3M. For more information about the slack period, see [About the Internal Reset Period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#reset).
|
1012
|
-
"""
|
1013
|
-
return pulumi.get(self, "evaluation_slack_duration")
|
1014
|
-
|
1015
964
|
@property
|
1016
965
|
@pulumi.getter(name="freeformTags")
|
1017
966
|
def freeform_tags(self) -> Mapping[str, Any]:
|
@@ -1079,14 +1028,6 @@ class GetAlarmsAlarmResult(dict):
|
|
1079
1028
|
"""
|
1080
1029
|
return pulumi.get(self, "namespace")
|
1081
1030
|
|
1082
|
-
@property
|
1083
|
-
@pulumi.getter(name="notificationTitle")
|
1084
|
-
def notification_title(self) -> str:
|
1085
|
-
"""
|
1086
|
-
Customizable notification title (`title` [alarm message parameter](https://docs.cloud.oracle.com/iaas/Content/Monitoring/alarm-message-format.htm)). Optionally include [dynamic variables](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/update-alarm-dynamic-variables.htm). The notification title appears as the subject line in a formatted email message and as the title in a Slack message.
|
1087
|
-
"""
|
1088
|
-
return pulumi.get(self, "notification_title")
|
1089
|
-
|
1090
1031
|
@property
|
1091
1032
|
@pulumi.getter(name="notificationVersion")
|
1092
1033
|
def notification_version(self) -> str:
|
@@ -1115,7 +1056,7 @@ class GetAlarmsAlarmResult(dict):
|
|
1115
1056
|
@pulumi.getter
|
1116
1057
|
def query(self) -> str:
|
1117
1058
|
"""
|
1118
|
-
The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions.
|
1059
|
+
The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. For information about writing MQL expressions, see [Editing the MQL Expression for a Query](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). For details about MQL, see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
|
1119
1060
|
"""
|
1120
1061
|
return pulumi.get(self, "query")
|
1121
1062
|
|
@@ -1139,7 +1080,7 @@ class GetAlarmsAlarmResult(dict):
|
|
1139
1080
|
@pulumi.getter(name="resourceGroup")
|
1140
1081
|
def resource_group(self) -> str:
|
1141
1082
|
"""
|
1142
|
-
Resource group
|
1083
|
+
Resource group to match for metric data retrieved by the alarm. A resource group is a custom string that you can match when retrieving custom metrics. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: `frontend-fleet`
|
1143
1084
|
"""
|
1144
1085
|
return pulumi.get(self, "resource_group")
|
1145
1086
|
|
@@ -1147,7 +1088,7 @@ class GetAlarmsAlarmResult(dict):
|
|
1147
1088
|
@pulumi.getter(name="ruleName")
|
1148
1089
|
def rule_name(self) -> str:
|
1149
1090
|
"""
|
1150
|
-
Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride).
|
1091
|
+
Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. Minimum number of characters: 3. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride).
|
1151
1092
|
"""
|
1152
1093
|
return pulumi.get(self, "rule_name")
|
1153
1094
|
|
@@ -1201,10 +1142,10 @@ class GetAlarmsAlarmOverrideResult(dict):
|
|
1201
1142
|
rule_name: str,
|
1202
1143
|
severity: str):
|
1203
1144
|
"""
|
1204
|
-
:param str body: The human-readable content of the delivered alarm notification.
|
1145
|
+
:param str body: The human-readable content of the delivered alarm notification. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: `High CPU usage alert. Follow runbook instructions for resolution.`
|
1205
1146
|
:param str pending_duration: The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING".
|
1206
|
-
:param str query: The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions.
|
1207
|
-
:param str rule_name: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride).
|
1147
|
+
:param str query: The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. For information about writing MQL expressions, see [Editing the MQL Expression for a Query](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). For details about MQL, see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
|
1148
|
+
:param str rule_name: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. Minimum number of characters: 3. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride).
|
1208
1149
|
:param str severity: The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL`
|
1209
1150
|
"""
|
1210
1151
|
pulumi.set(__self__, "body", body)
|
@@ -1217,7 +1158,7 @@ class GetAlarmsAlarmOverrideResult(dict):
|
|
1217
1158
|
@pulumi.getter
|
1218
1159
|
def body(self) -> str:
|
1219
1160
|
"""
|
1220
|
-
The human-readable content of the delivered alarm notification.
|
1161
|
+
The human-readable content of the delivered alarm notification. Oracle recommends providing guidance to operators for resolving the alarm condition. Consider adding links to standard runbook practices. Avoid entering confidential information. Example: `High CPU usage alert. Follow runbook instructions for resolution.`
|
1221
1162
|
"""
|
1222
1163
|
return pulumi.get(self, "body")
|
1223
1164
|
|
@@ -1233,7 +1174,7 @@ class GetAlarmsAlarmOverrideResult(dict):
|
|
1233
1174
|
@pulumi.getter
|
1234
1175
|
def query(self) -> str:
|
1235
1176
|
"""
|
1236
|
-
The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions.
|
1177
|
+
The Monitoring Query Language (MQL) expression to evaluate for the alarm. The Alarms feature of the Monitoring service interprets results for each returned time series as Boolean values, where zero represents false and a non-zero value represents true. A true value means that the trigger rule condition has been met. The query must specify a metric, statistic, interval, and trigger rule (threshold or absence). Supported values for interval depend on the specified time range. More interval values are supported for smaller time ranges. You can optionally specify dimensions and grouping functions. Supported grouping functions: `grouping()`, `groupBy()`. For information about writing MQL expressions, see [Editing the MQL Expression for a Query](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/query-metric-mql.htm). For details about MQL, see [Monitoring Query Language (MQL) Reference](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Reference/mql.htm). For available dimensions, review the metric definition for the supported service. See [Supported Services](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#SupportedServices).
|
1237
1178
|
"""
|
1238
1179
|
return pulumi.get(self, "query")
|
1239
1180
|
|
@@ -1241,7 +1182,7 @@ class GetAlarmsAlarmOverrideResult(dict):
|
|
1241
1182
|
@pulumi.getter(name="ruleName")
|
1242
1183
|
def rule_name(self) -> str:
|
1243
1184
|
"""
|
1244
|
-
Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride).
|
1185
|
+
Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides. A valid ruleName value starts with an alphabetic character and includes only alphanumeric characters, underscores and square brackets. Minimum number of characters: 3. Default value is `BASE`. For information about alarm overrides, see [AlarmOverride](https://docs.cloud.oracle.com/iaas/api/#/en/monitoring/latest/datatypes/AlarmOverride).
|
1245
1186
|
"""
|
1246
1187
|
return pulumi.get(self, "rule_name")
|
1247
1188
|
|
pulumi_oci/pulumi-plugin.json
CHANGED