pulumi-oci 1.40.0a1718172898__py3-none-any.whl → 1.40.0a1718211931__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 +10 -6
- pulumi_oci/monitoring/alarm.py +189 -28
- pulumi_oci/monitoring/get_alarm.py +44 -5
- pulumi_oci/monitoring/outputs.py +87 -28
- pulumi_oci/pulumi-plugin.json +1 -1
- {pulumi_oci-1.40.0a1718172898.dist-info → pulumi_oci-1.40.0a1718211931.dist-info}/METADATA +1 -1
- {pulumi_oci-1.40.0a1718172898.dist-info → pulumi_oci-1.40.0a1718211931.dist-info}/RECORD +10 -10
- {pulumi_oci-1.40.0a1718172898.dist-info → pulumi_oci-1.40.0a1718211931.dist-info}/WHEEL +0 -0
- {pulumi_oci-1.40.0a1718172898.dist-info → pulumi_oci-1.40.0a1718211931.dist-info}/top_level.txt +0 -0
@@ -22,10 +22,13 @@ class GetAlarmResult:
|
|
22
22
|
"""
|
23
23
|
A collection of values returned by getAlarm.
|
24
24
|
"""
|
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):
|
25
|
+
def __init__(__self__, alarm_id=None, alarm_summary=None, body=None, compartment_id=None, defined_tags=None, destinations=None, display_name=None, evaluation_slack_duration=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_title=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)
|
29
32
|
if body and not isinstance(body, str):
|
30
33
|
raise TypeError("Expected argument 'body' to be a str")
|
31
34
|
pulumi.set(__self__, "body", body)
|
@@ -41,6 +44,9 @@ class GetAlarmResult:
|
|
41
44
|
if display_name and not isinstance(display_name, str):
|
42
45
|
raise TypeError("Expected argument 'display_name' to be a str")
|
43
46
|
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)
|
44
50
|
if freeform_tags and not isinstance(freeform_tags, dict):
|
45
51
|
raise TypeError("Expected argument 'freeform_tags' to be a dict")
|
46
52
|
pulumi.set(__self__, "freeform_tags", freeform_tags)
|
@@ -65,6 +71,9 @@ class GetAlarmResult:
|
|
65
71
|
if namespace and not isinstance(namespace, str):
|
66
72
|
raise TypeError("Expected argument 'namespace' to be a str")
|
67
73
|
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)
|
68
77
|
if notification_version and not isinstance(notification_version, str):
|
69
78
|
raise TypeError("Expected argument 'notification_version' to be a str")
|
70
79
|
pulumi.set(__self__, "notification_version", notification_version)
|
@@ -110,11 +119,19 @@ class GetAlarmResult:
|
|
110
119
|
def alarm_id(self) -> str:
|
111
120
|
return pulumi.get(self, "alarm_id")
|
112
121
|
|
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
|
+
|
113
130
|
@property
|
114
131
|
@pulumi.getter
|
115
132
|
def body(self) -> str:
|
116
133
|
"""
|
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.`
|
134
|
+
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.`
|
118
135
|
"""
|
119
136
|
return pulumi.get(self, "body")
|
120
137
|
|
@@ -150,6 +167,14 @@ class GetAlarmResult:
|
|
150
167
|
"""
|
151
168
|
return pulumi.get(self, "display_name")
|
152
169
|
|
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
|
+
|
153
178
|
@property
|
154
179
|
@pulumi.getter(name="freeformTags")
|
155
180
|
def freeform_tags(self) -> Mapping[str, Any]:
|
@@ -217,6 +242,14 @@ class GetAlarmResult:
|
|
217
242
|
"""
|
218
243
|
return pulumi.get(self, "namespace")
|
219
244
|
|
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
|
+
|
220
253
|
@property
|
221
254
|
@pulumi.getter(name="notificationVersion")
|
222
255
|
def notification_version(self) -> str:
|
@@ -245,7 +278,7 @@ class GetAlarmResult:
|
|
245
278
|
@pulumi.getter
|
246
279
|
def query(self) -> str:
|
247
280
|
"""
|
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).
|
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. Also, you can customize the [absence detection period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). 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).
|
249
282
|
"""
|
250
283
|
return pulumi.get(self, "query")
|
251
284
|
|
@@ -269,7 +302,7 @@ class GetAlarmResult:
|
|
269
302
|
@pulumi.getter(name="resourceGroup")
|
270
303
|
def resource_group(self) -> str:
|
271
304
|
"""
|
272
|
-
Resource group to match
|
305
|
+
Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. 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`
|
273
306
|
"""
|
274
307
|
return pulumi.get(self, "resource_group")
|
275
308
|
|
@@ -277,7 +310,7 @@ class GetAlarmResult:
|
|
277
310
|
@pulumi.getter(name="ruleName")
|
278
311
|
def rule_name(self) -> str:
|
279
312
|
"""
|
280
|
-
Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides.
|
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).
|
281
314
|
"""
|
282
315
|
return pulumi.get(self, "rule_name")
|
283
316
|
|
@@ -329,11 +362,13 @@ class AwaitableGetAlarmResult(GetAlarmResult):
|
|
329
362
|
yield self
|
330
363
|
return GetAlarmResult(
|
331
364
|
alarm_id=self.alarm_id,
|
365
|
+
alarm_summary=self.alarm_summary,
|
332
366
|
body=self.body,
|
333
367
|
compartment_id=self.compartment_id,
|
334
368
|
defined_tags=self.defined_tags,
|
335
369
|
destinations=self.destinations,
|
336
370
|
display_name=self.display_name,
|
371
|
+
evaluation_slack_duration=self.evaluation_slack_duration,
|
337
372
|
freeform_tags=self.freeform_tags,
|
338
373
|
id=self.id,
|
339
374
|
is_enabled=self.is_enabled,
|
@@ -342,6 +377,7 @@ class AwaitableGetAlarmResult(GetAlarmResult):
|
|
342
377
|
metric_compartment_id=self.metric_compartment_id,
|
343
378
|
metric_compartment_id_in_subtree=self.metric_compartment_id_in_subtree,
|
344
379
|
namespace=self.namespace,
|
380
|
+
notification_title=self.notification_title,
|
345
381
|
notification_version=self.notification_version,
|
346
382
|
overrides=self.overrides,
|
347
383
|
pending_duration=self.pending_duration,
|
@@ -391,11 +427,13 @@ def get_alarm(alarm_id: Optional[str] = None,
|
|
391
427
|
|
392
428
|
return AwaitableGetAlarmResult(
|
393
429
|
alarm_id=pulumi.get(__ret__, 'alarm_id'),
|
430
|
+
alarm_summary=pulumi.get(__ret__, 'alarm_summary'),
|
394
431
|
body=pulumi.get(__ret__, 'body'),
|
395
432
|
compartment_id=pulumi.get(__ret__, 'compartment_id'),
|
396
433
|
defined_tags=pulumi.get(__ret__, 'defined_tags'),
|
397
434
|
destinations=pulumi.get(__ret__, 'destinations'),
|
398
435
|
display_name=pulumi.get(__ret__, 'display_name'),
|
436
|
+
evaluation_slack_duration=pulumi.get(__ret__, 'evaluation_slack_duration'),
|
399
437
|
freeform_tags=pulumi.get(__ret__, 'freeform_tags'),
|
400
438
|
id=pulumi.get(__ret__, 'id'),
|
401
439
|
is_enabled=pulumi.get(__ret__, 'is_enabled'),
|
@@ -404,6 +442,7 @@ def get_alarm(alarm_id: Optional[str] = None,
|
|
404
442
|
metric_compartment_id=pulumi.get(__ret__, 'metric_compartment_id'),
|
405
443
|
metric_compartment_id_in_subtree=pulumi.get(__ret__, 'metric_compartment_id_in_subtree'),
|
406
444
|
namespace=pulumi.get(__ret__, 'namespace'),
|
445
|
+
notification_title=pulumi.get(__ret__, 'notification_title'),
|
407
446
|
notification_version=pulumi.get(__ret__, 'notification_version'),
|
408
447
|
overrides=pulumi.get(__ret__, 'overrides'),
|
409
448
|
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. 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.`
|
67
|
+
:param str body: (Updatable) 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.`
|
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. 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).
|
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. Also, you can customize the [absence detection period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). 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,7 +90,9 @@ class AlarmOverride(dict):
|
|
90
90
|
|
91
91
|
CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent()
|
92
92
|
|
93
|
-
-----
|
93
|
+
----- Example of absence alarm with custom absence detection period of 20 hours:
|
94
|
+
|
95
|
+
----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) -----
|
94
96
|
:param str rule_name: (Updatable) A user-friendly description for this alarm override. Must be unique across all `ruleName` values for the alarm.
|
95
97
|
:param str severity: (Updatable) The perceived severity of the alarm with regard to the affected system. Example: `CRITICAL`
|
96
98
|
"""
|
@@ -109,7 +111,7 @@ class AlarmOverride(dict):
|
|
109
111
|
@pulumi.getter
|
110
112
|
def body(self) -> Optional[str]:
|
111
113
|
"""
|
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.`
|
114
|
+
(Updatable) 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.`
|
113
115
|
"""
|
114
116
|
return pulumi.get(self, "body")
|
115
117
|
|
@@ -133,7 +135,7 @@ class AlarmOverride(dict):
|
|
133
135
|
@pulumi.getter
|
134
136
|
def query(self) -> Optional[str]:
|
135
137
|
"""
|
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).
|
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. Also, you can customize the [absence detection period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). 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).
|
137
139
|
|
138
140
|
Example of threshold alarm:
|
139
141
|
|
@@ -149,7 +151,9 @@ class AlarmOverride(dict):
|
|
149
151
|
|
150
152
|
CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent()
|
151
153
|
|
152
|
-
-----
|
154
|
+
----- Example of absence alarm with custom absence detection period of 20 hours:
|
155
|
+
|
156
|
+
----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) -----
|
153
157
|
"""
|
154
158
|
return pulumi.get(self, "query")
|
155
159
|
|
@@ -297,18 +301,29 @@ class AlarmSuppressionAlarmSuppressionTarget(dict):
|
|
297
301
|
@pulumi.output_type
|
298
302
|
class GetAlarmHistoryCollectionEntryResult(dict):
|
299
303
|
def __init__(__self__, *,
|
304
|
+
alarm_summary: str,
|
300
305
|
summary: str,
|
301
306
|
timestamp: str,
|
302
307
|
timestamp_triggered: str):
|
303
308
|
"""
|
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).
|
304
310
|
:param str summary: Description for this alarm history entry.
|
305
311
|
:param str timestamp: Timestamp for this alarm history entry. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z`
|
306
312
|
: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`
|
307
313
|
"""
|
314
|
+
pulumi.set(__self__, "alarm_summary", alarm_summary)
|
308
315
|
pulumi.set(__self__, "summary", summary)
|
309
316
|
pulumi.set(__self__, "timestamp", timestamp)
|
310
317
|
pulumi.set(__self__, "timestamp_triggered", timestamp_triggered)
|
311
318
|
|
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
|
+
|
312
327
|
@property
|
313
328
|
@pulumi.getter
|
314
329
|
def summary(self) -> str:
|
@@ -343,10 +358,10 @@ class GetAlarmOverrideResult(dict):
|
|
343
358
|
rule_name: str,
|
344
359
|
severity: str):
|
345
360
|
"""
|
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.`
|
361
|
+
: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.`
|
347
362
|
: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".
|
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.
|
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. Also, you can customize the [absence detection period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). 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).
|
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).
|
350
365
|
:param str severity: The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL`
|
351
366
|
"""
|
352
367
|
pulumi.set(__self__, "body", body)
|
@@ -359,7 +374,7 @@ class GetAlarmOverrideResult(dict):
|
|
359
374
|
@pulumi.getter
|
360
375
|
def body(self) -> str:
|
361
376
|
"""
|
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.`
|
377
|
+
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.`
|
363
378
|
"""
|
364
379
|
return pulumi.get(self, "body")
|
365
380
|
|
@@ -375,7 +390,7 @@ class GetAlarmOverrideResult(dict):
|
|
375
390
|
@pulumi.getter
|
376
391
|
def query(self) -> str:
|
377
392
|
"""
|
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).
|
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. Also, you can customize the [absence detection period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). 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).
|
379
394
|
"""
|
380
395
|
return pulumi.get(self, "query")
|
381
396
|
|
@@ -383,7 +398,7 @@ class GetAlarmOverrideResult(dict):
|
|
383
398
|
@pulumi.getter(name="ruleName")
|
384
399
|
def rule_name(self) -> str:
|
385
400
|
"""
|
386
|
-
Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides.
|
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).
|
387
402
|
"""
|
388
403
|
return pulumi.get(self, "rule_name")
|
389
404
|
|
@@ -399,6 +414,7 @@ class GetAlarmOverrideResult(dict):
|
|
399
414
|
@pulumi.output_type
|
400
415
|
class GetAlarmStatusesAlarmStatusResult(dict):
|
401
416
|
def __init__(__self__, *,
|
417
|
+
alarm_summary: str,
|
402
418
|
display_name: str,
|
403
419
|
id: str,
|
404
420
|
rule_name: str,
|
@@ -407,14 +423,16 @@ class GetAlarmStatusesAlarmStatusResult(dict):
|
|
407
423
|
suppressions: Sequence['outputs.GetAlarmStatusesAlarmStatusSuppressionResult'],
|
408
424
|
timestamp_triggered: str):
|
409
425
|
"""
|
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).
|
410
427
|
: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.
|
411
428
|
:param str id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm.
|
412
|
-
:param str rule_name: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides.
|
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).
|
413
430
|
:param str severity: The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL`
|
414
431
|
: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`
|
415
432
|
:param Sequence['GetAlarmStatusesAlarmStatusSuppressionArgs'] suppressions: The configuration details for suppressing an alarm.
|
416
433
|
: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`
|
417
434
|
"""
|
435
|
+
pulumi.set(__self__, "alarm_summary", alarm_summary)
|
418
436
|
pulumi.set(__self__, "display_name", display_name)
|
419
437
|
pulumi.set(__self__, "id", id)
|
420
438
|
pulumi.set(__self__, "rule_name", rule_name)
|
@@ -423,6 +441,14 @@ class GetAlarmStatusesAlarmStatusResult(dict):
|
|
423
441
|
pulumi.set(__self__, "suppressions", suppressions)
|
424
442
|
pulumi.set(__self__, "timestamp_triggered", timestamp_triggered)
|
425
443
|
|
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
|
+
|
426
452
|
@property
|
427
453
|
@pulumi.getter(name="displayName")
|
428
454
|
def display_name(self) -> str:
|
@@ -443,7 +469,7 @@ class GetAlarmStatusesAlarmStatusResult(dict):
|
|
443
469
|
@pulumi.getter(name="ruleName")
|
444
470
|
def rule_name(self) -> str:
|
445
471
|
"""
|
446
|
-
Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides.
|
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).
|
447
473
|
"""
|
448
474
|
return pulumi.get(self, "rule_name")
|
449
475
|
|
@@ -837,11 +863,13 @@ class GetAlarmSuppressionsFilterResult(dict):
|
|
837
863
|
@pulumi.output_type
|
838
864
|
class GetAlarmsAlarmResult(dict):
|
839
865
|
def __init__(__self__, *,
|
866
|
+
alarm_summary: str,
|
840
867
|
body: str,
|
841
868
|
compartment_id: str,
|
842
869
|
defined_tags: Mapping[str, Any],
|
843
870
|
destinations: Sequence[str],
|
844
871
|
display_name: str,
|
872
|
+
evaluation_slack_duration: str,
|
845
873
|
freeform_tags: Mapping[str, Any],
|
846
874
|
id: str,
|
847
875
|
is_enabled: bool,
|
@@ -850,6 +878,7 @@ class GetAlarmsAlarmResult(dict):
|
|
850
878
|
metric_compartment_id: str,
|
851
879
|
metric_compartment_id_in_subtree: bool,
|
852
880
|
namespace: str,
|
881
|
+
notification_title: str,
|
853
882
|
notification_version: str,
|
854
883
|
overrides: Sequence['outputs.GetAlarmsAlarmOverrideResult'],
|
855
884
|
pending_duration: str,
|
@@ -864,11 +893,13 @@ class GetAlarmsAlarmResult(dict):
|
|
864
893
|
time_created: str,
|
865
894
|
time_updated: str):
|
866
895
|
"""
|
867
|
-
:param str
|
896
|
+
: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).
|
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.`
|
868
898
|
: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`
|
869
899
|
:param Mapping[str, Any] defined_tags: Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}`
|
870
900
|
: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.
|
871
901
|
: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).
|
872
903
|
: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"}`
|
873
904
|
:param str id: The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm.
|
874
905
|
:param bool is_enabled: Whether the alarm is enabled. Example: `true`
|
@@ -880,25 +911,28 @@ class GetAlarmsAlarmResult(dict):
|
|
880
911
|
: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.
|
881
912
|
: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`
|
882
913
|
: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.
|
883
915
|
: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.
|
884
916
|
:param Sequence['GetAlarmsAlarmOverrideArgs'] overrides: A set of overrides that control evaluations of the alarm.
|
885
917
|
: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".
|
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).
|
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. Also, you can customize the [absence detection period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). 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).
|
887
919
|
: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.
|
888
920
|
:param str resolution: The time between calculated aggregation windows for the alarm. Supported value: `1m`
|
889
|
-
:param str resource_group: Resource group to match
|
890
|
-
:param str rule_name: Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides.
|
921
|
+
:param str resource_group: Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. 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`
|
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).
|
891
923
|
:param str severity: The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL`
|
892
924
|
: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.
|
893
925
|
:param Sequence['GetAlarmsAlarmSuppressionArgs'] suppressions: The configuration details for suppressing an alarm.
|
894
926
|
:param str time_created: The date and time the alarm was created. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z`
|
895
927
|
:param str time_updated: The date and time the alarm was last updated. Format defined by RFC3339. Example: `2023-02-03T01:02:29.600Z`
|
896
928
|
"""
|
929
|
+
pulumi.set(__self__, "alarm_summary", alarm_summary)
|
897
930
|
pulumi.set(__self__, "body", body)
|
898
931
|
pulumi.set(__self__, "compartment_id", compartment_id)
|
899
932
|
pulumi.set(__self__, "defined_tags", defined_tags)
|
900
933
|
pulumi.set(__self__, "destinations", destinations)
|
901
934
|
pulumi.set(__self__, "display_name", display_name)
|
935
|
+
pulumi.set(__self__, "evaluation_slack_duration", evaluation_slack_duration)
|
902
936
|
pulumi.set(__self__, "freeform_tags", freeform_tags)
|
903
937
|
pulumi.set(__self__, "id", id)
|
904
938
|
pulumi.set(__self__, "is_enabled", is_enabled)
|
@@ -907,6 +941,7 @@ class GetAlarmsAlarmResult(dict):
|
|
907
941
|
pulumi.set(__self__, "metric_compartment_id", metric_compartment_id)
|
908
942
|
pulumi.set(__self__, "metric_compartment_id_in_subtree", metric_compartment_id_in_subtree)
|
909
943
|
pulumi.set(__self__, "namespace", namespace)
|
944
|
+
pulumi.set(__self__, "notification_title", notification_title)
|
910
945
|
pulumi.set(__self__, "notification_version", notification_version)
|
911
946
|
pulumi.set(__self__, "overrides", overrides)
|
912
947
|
pulumi.set(__self__, "pending_duration", pending_duration)
|
@@ -921,11 +956,19 @@ class GetAlarmsAlarmResult(dict):
|
|
921
956
|
pulumi.set(__self__, "time_created", time_created)
|
922
957
|
pulumi.set(__self__, "time_updated", time_updated)
|
923
958
|
|
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
|
+
|
924
967
|
@property
|
925
968
|
@pulumi.getter
|
926
969
|
def body(self) -> str:
|
927
970
|
"""
|
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.`
|
971
|
+
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.`
|
929
972
|
"""
|
930
973
|
return pulumi.get(self, "body")
|
931
974
|
|
@@ -961,6 +1004,14 @@ class GetAlarmsAlarmResult(dict):
|
|
961
1004
|
"""
|
962
1005
|
return pulumi.get(self, "display_name")
|
963
1006
|
|
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
|
+
|
964
1015
|
@property
|
965
1016
|
@pulumi.getter(name="freeformTags")
|
966
1017
|
def freeform_tags(self) -> Mapping[str, Any]:
|
@@ -1028,6 +1079,14 @@ class GetAlarmsAlarmResult(dict):
|
|
1028
1079
|
"""
|
1029
1080
|
return pulumi.get(self, "namespace")
|
1030
1081
|
|
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
|
+
|
1031
1090
|
@property
|
1032
1091
|
@pulumi.getter(name="notificationVersion")
|
1033
1092
|
def notification_version(self) -> str:
|
@@ -1056,7 +1115,7 @@ class GetAlarmsAlarmResult(dict):
|
|
1056
1115
|
@pulumi.getter
|
1057
1116
|
def query(self) -> str:
|
1058
1117
|
"""
|
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).
|
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. Also, you can customize the [absence detection period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). 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).
|
1060
1119
|
"""
|
1061
1120
|
return pulumi.get(self, "query")
|
1062
1121
|
|
@@ -1080,7 +1139,7 @@ class GetAlarmsAlarmResult(dict):
|
|
1080
1139
|
@pulumi.getter(name="resourceGroup")
|
1081
1140
|
def resource_group(self) -> str:
|
1082
1141
|
"""
|
1083
|
-
Resource group to match
|
1142
|
+
Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. 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`
|
1084
1143
|
"""
|
1085
1144
|
return pulumi.get(self, "resource_group")
|
1086
1145
|
|
@@ -1088,7 +1147,7 @@ class GetAlarmsAlarmResult(dict):
|
|
1088
1147
|
@pulumi.getter(name="ruleName")
|
1089
1148
|
def rule_name(self) -> str:
|
1090
1149
|
"""
|
1091
|
-
Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides.
|
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).
|
1092
1151
|
"""
|
1093
1152
|
return pulumi.get(self, "rule_name")
|
1094
1153
|
|
@@ -1142,10 +1201,10 @@ class GetAlarmsAlarmOverrideResult(dict):
|
|
1142
1201
|
rule_name: str,
|
1143
1202
|
severity: str):
|
1144
1203
|
"""
|
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.`
|
1204
|
+
: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.`
|
1146
1205
|
: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".
|
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.
|
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. Also, you can customize the [absence detection period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). 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).
|
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).
|
1149
1208
|
:param str severity: The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL`
|
1150
1209
|
"""
|
1151
1210
|
pulumi.set(__self__, "body", body)
|
@@ -1158,7 +1217,7 @@ class GetAlarmsAlarmOverrideResult(dict):
|
|
1158
1217
|
@pulumi.getter
|
1159
1218
|
def body(self) -> str:
|
1160
1219
|
"""
|
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.`
|
1220
|
+
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.`
|
1162
1221
|
"""
|
1163
1222
|
return pulumi.get(self, "body")
|
1164
1223
|
|
@@ -1174,7 +1233,7 @@ class GetAlarmsAlarmOverrideResult(dict):
|
|
1174
1233
|
@pulumi.getter
|
1175
1234
|
def query(self) -> str:
|
1176
1235
|
"""
|
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).
|
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. Also, you can customize the [absence detection period](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-edit-alarm-query-absence-detection-period.htm). 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).
|
1178
1237
|
"""
|
1179
1238
|
return pulumi.get(self, "query")
|
1180
1239
|
|
@@ -1182,7 +1241,7 @@ class GetAlarmsAlarmOverrideResult(dict):
|
|
1182
1241
|
@pulumi.getter(name="ruleName")
|
1183
1242
|
def rule_name(self) -> str:
|
1184
1243
|
"""
|
1185
|
-
Identifier of the alarm's base values for alarm evaluation, for use when the alarm contains overrides.
|
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).
|
1186
1245
|
"""
|
1187
1246
|
return pulumi.get(self, "rule_name")
|
1188
1247
|
|
pulumi_oci/pulumi-plugin.json
CHANGED