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
pulumi_oci/monitoring/alarm.py
CHANGED
@@ -24,15 +24,12 @@ class AlarmArgs:
|
|
24
24
|
namespace: pulumi.Input[str],
|
25
25
|
query: pulumi.Input[str],
|
26
26
|
severity: pulumi.Input[str],
|
27
|
-
alarm_summary: Optional[pulumi.Input[str]] = None,
|
28
27
|
body: Optional[pulumi.Input[str]] = None,
|
29
28
|
defined_tags: Optional[pulumi.Input[Mapping[str, Any]]] = None,
|
30
|
-
evaluation_slack_duration: Optional[pulumi.Input[str]] = None,
|
31
29
|
freeform_tags: Optional[pulumi.Input[Mapping[str, Any]]] = None,
|
32
30
|
is_notifications_per_metric_dimension_enabled: Optional[pulumi.Input[bool]] = None,
|
33
31
|
message_format: Optional[pulumi.Input[str]] = None,
|
34
32
|
metric_compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
|
35
|
-
notification_title: Optional[pulumi.Input[str]] = None,
|
36
33
|
notification_version: Optional[pulumi.Input[str]] = None,
|
37
34
|
overrides: Optional[pulumi.Input[Sequence[pulumi.Input['AlarmOverrideArgs']]]] = None,
|
38
35
|
pending_duration: Optional[pulumi.Input[str]] = None,
|
@@ -53,7 +50,7 @@ class AlarmArgs:
|
|
53
50
|
:param pulumi.Input[bool] is_enabled: (Updatable) Whether the alarm is enabled. Example: `true`
|
54
51
|
:param pulumi.Input[str] metric_compartment_id: (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric being evaluated by the alarm.
|
55
52
|
:param pulumi.Input[str] namespace: (Updatable) The source service or application emitting the metric that is evaluated by the alarm. Example: `oci_computeagent`
|
56
|
-
:param pulumi.Input[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.
|
53
|
+
:param pulumi.Input[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).
|
57
54
|
|
58
55
|
Example of threshold alarm:
|
59
56
|
|
@@ -69,14 +66,10 @@ class AlarmArgs:
|
|
69
66
|
|
70
67
|
CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent()
|
71
68
|
|
72
|
-
-----
|
73
|
-
|
74
|
-
----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) -----
|
69
|
+
-----
|
75
70
|
:param pulumi.Input[str] severity: (Updatable) The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL`
|
76
|
-
:param pulumi.Input[str]
|
77
|
-
:param pulumi.Input[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.`
|
71
|
+
:param pulumi.Input[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.`
|
78
72
|
:param pulumi.Input[Mapping[str, Any]] defined_tags: (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}`
|
79
|
-
:param pulumi.Input[str] evaluation_slack_duration: (Updatable) 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).
|
80
73
|
:param pulumi.Input[Mapping[str, Any]] freeform_tags: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}`
|
81
74
|
:param pulumi.Input[bool] is_notifications_per_metric_dimension_enabled: (Updatable) When set to `true`, splits alarm notifications per metric stream. When set to `false`, groups alarm notifications across metric streams. Example: `true`
|
82
75
|
:param pulumi.Input[str] message_format: (Updatable) The format to use for alarm notifications. The formats are:
|
@@ -84,7 +77,6 @@ class AlarmArgs:
|
|
84
77
|
* `PRETTY_JSON`: JSON with new lines and indents. Available when the `destinations` attribute specifies `Notifications` only.
|
85
78
|
* `ONS_OPTIMIZED`: Simplified, user-friendly layout. Available when the `destinations` attribute specifies `Notifications` only. Applies to Email subscription types only.
|
86
79
|
:param pulumi.Input[bool] metric_compartment_id_in_subtree: (Updatable) 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`
|
87
|
-
:param pulumi.Input[str] notification_title: (Updatable) 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.
|
88
80
|
:param pulumi.Input[str] notification_version: (Updatable) 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.
|
89
81
|
:param pulumi.Input[Sequence[pulumi.Input['AlarmOverrideArgs']]] overrides: (Updatable) A set of overrides that control evaluations of the alarm.
|
90
82
|
|
@@ -105,7 +97,7 @@ class AlarmArgs:
|
|
105
97
|
Example: `PT2H`
|
106
98
|
:param pulumi.Input[str] resolution: (Updatable) The time between calculated aggregation windows for the alarm. Supported value: `1m`
|
107
99
|
:param pulumi.Input[str] resource_group: (Updatable) Resource group that you want to match. A null value returns only metric data that has no resource groups. The alarm retrieves metric data associated with the specified resource group only. 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 ($). Avoid entering confidential information. Example: `frontend-fleet`
|
108
|
-
:param pulumi.Input[str] rule_name: (Updatable) 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).
|
100
|
+
:param pulumi.Input[str] rule_name: (Updatable) 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).
|
109
101
|
:param pulumi.Input['AlarmSuppressionArgs'] suppression: (Updatable) The configuration details for suppressing an alarm.
|
110
102
|
"""
|
111
103
|
pulumi.set(__self__, "compartment_id", compartment_id)
|
@@ -116,14 +108,10 @@ class AlarmArgs:
|
|
116
108
|
pulumi.set(__self__, "namespace", namespace)
|
117
109
|
pulumi.set(__self__, "query", query)
|
118
110
|
pulumi.set(__self__, "severity", severity)
|
119
|
-
if alarm_summary is not None:
|
120
|
-
pulumi.set(__self__, "alarm_summary", alarm_summary)
|
121
111
|
if body is not None:
|
122
112
|
pulumi.set(__self__, "body", body)
|
123
113
|
if defined_tags is not None:
|
124
114
|
pulumi.set(__self__, "defined_tags", defined_tags)
|
125
|
-
if evaluation_slack_duration is not None:
|
126
|
-
pulumi.set(__self__, "evaluation_slack_duration", evaluation_slack_duration)
|
127
115
|
if freeform_tags is not None:
|
128
116
|
pulumi.set(__self__, "freeform_tags", freeform_tags)
|
129
117
|
if is_notifications_per_metric_dimension_enabled is not None:
|
@@ -132,8 +120,6 @@ class AlarmArgs:
|
|
132
120
|
pulumi.set(__self__, "message_format", message_format)
|
133
121
|
if metric_compartment_id_in_subtree is not None:
|
134
122
|
pulumi.set(__self__, "metric_compartment_id_in_subtree", metric_compartment_id_in_subtree)
|
135
|
-
if notification_title is not None:
|
136
|
-
pulumi.set(__self__, "notification_title", notification_title)
|
137
123
|
if notification_version is not None:
|
138
124
|
pulumi.set(__self__, "notification_version", notification_version)
|
139
125
|
if overrides is not None:
|
@@ -231,7 +217,7 @@ class AlarmArgs:
|
|
231
217
|
@pulumi.getter
|
232
218
|
def query(self) -> pulumi.Input[str]:
|
233
219
|
"""
|
234
|
-
(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.
|
220
|
+
(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).
|
235
221
|
|
236
222
|
Example of threshold alarm:
|
237
223
|
|
@@ -247,9 +233,7 @@ class AlarmArgs:
|
|
247
233
|
|
248
234
|
CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent()
|
249
235
|
|
250
|
-
-----
|
251
|
-
|
252
|
-
----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) -----
|
236
|
+
-----
|
253
237
|
"""
|
254
238
|
return pulumi.get(self, "query")
|
255
239
|
|
@@ -269,23 +253,11 @@ class AlarmArgs:
|
|
269
253
|
def severity(self, value: pulumi.Input[str]):
|
270
254
|
pulumi.set(self, "severity", value)
|
271
255
|
|
272
|
-
@property
|
273
|
-
@pulumi.getter(name="alarmSummary")
|
274
|
-
def alarm_summary(self) -> Optional[pulumi.Input[str]]:
|
275
|
-
"""
|
276
|
-
(Updatable) 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).
|
277
|
-
"""
|
278
|
-
return pulumi.get(self, "alarm_summary")
|
279
|
-
|
280
|
-
@alarm_summary.setter
|
281
|
-
def alarm_summary(self, value: Optional[pulumi.Input[str]]):
|
282
|
-
pulumi.set(self, "alarm_summary", value)
|
283
|
-
|
284
256
|
@property
|
285
257
|
@pulumi.getter
|
286
258
|
def body(self) -> Optional[pulumi.Input[str]]:
|
287
259
|
"""
|
288
|
-
(Updatable) The human-readable content of the delivered alarm notification.
|
260
|
+
(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.`
|
289
261
|
"""
|
290
262
|
return pulumi.get(self, "body")
|
291
263
|
|
@@ -305,18 +277,6 @@ class AlarmArgs:
|
|
305
277
|
def defined_tags(self, value: Optional[pulumi.Input[Mapping[str, Any]]]):
|
306
278
|
pulumi.set(self, "defined_tags", value)
|
307
279
|
|
308
|
-
@property
|
309
|
-
@pulumi.getter(name="evaluationSlackDuration")
|
310
|
-
def evaluation_slack_duration(self) -> Optional[pulumi.Input[str]]:
|
311
|
-
"""
|
312
|
-
(Updatable) 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).
|
313
|
-
"""
|
314
|
-
return pulumi.get(self, "evaluation_slack_duration")
|
315
|
-
|
316
|
-
@evaluation_slack_duration.setter
|
317
|
-
def evaluation_slack_duration(self, value: Optional[pulumi.Input[str]]):
|
318
|
-
pulumi.set(self, "evaluation_slack_duration", value)
|
319
|
-
|
320
280
|
@property
|
321
281
|
@pulumi.getter(name="freeformTags")
|
322
282
|
def freeform_tags(self) -> Optional[pulumi.Input[Mapping[str, Any]]]:
|
@@ -368,18 +328,6 @@ class AlarmArgs:
|
|
368
328
|
def metric_compartment_id_in_subtree(self, value: Optional[pulumi.Input[bool]]):
|
369
329
|
pulumi.set(self, "metric_compartment_id_in_subtree", value)
|
370
330
|
|
371
|
-
@property
|
372
|
-
@pulumi.getter(name="notificationTitle")
|
373
|
-
def notification_title(self) -> Optional[pulumi.Input[str]]:
|
374
|
-
"""
|
375
|
-
(Updatable) 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.
|
376
|
-
"""
|
377
|
-
return pulumi.get(self, "notification_title")
|
378
|
-
|
379
|
-
@notification_title.setter
|
380
|
-
def notification_title(self, value: Optional[pulumi.Input[str]]):
|
381
|
-
pulumi.set(self, "notification_title", value)
|
382
|
-
|
383
331
|
@property
|
384
332
|
@pulumi.getter(name="notificationVersion")
|
385
333
|
def notification_version(self) -> Optional[pulumi.Input[str]]:
|
@@ -470,7 +418,7 @@ class AlarmArgs:
|
|
470
418
|
@pulumi.getter(name="ruleName")
|
471
419
|
def rule_name(self) -> Optional[pulumi.Input[str]]:
|
472
420
|
"""
|
473
|
-
(Updatable) 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).
|
421
|
+
(Updatable) 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).
|
474
422
|
"""
|
475
423
|
return pulumi.get(self, "rule_name")
|
476
424
|
|
@@ -494,13 +442,11 @@ class AlarmArgs:
|
|
494
442
|
@pulumi.input_type
|
495
443
|
class _AlarmState:
|
496
444
|
def __init__(__self__, *,
|
497
|
-
alarm_summary: Optional[pulumi.Input[str]] = None,
|
498
445
|
body: Optional[pulumi.Input[str]] = None,
|
499
446
|
compartment_id: Optional[pulumi.Input[str]] = None,
|
500
447
|
defined_tags: Optional[pulumi.Input[Mapping[str, Any]]] = None,
|
501
448
|
destinations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
502
449
|
display_name: Optional[pulumi.Input[str]] = None,
|
503
|
-
evaluation_slack_duration: Optional[pulumi.Input[str]] = None,
|
504
450
|
freeform_tags: Optional[pulumi.Input[Mapping[str, Any]]] = None,
|
505
451
|
is_enabled: Optional[pulumi.Input[bool]] = None,
|
506
452
|
is_notifications_per_metric_dimension_enabled: Optional[pulumi.Input[bool]] = None,
|
@@ -508,7 +454,6 @@ class _AlarmState:
|
|
508
454
|
metric_compartment_id: Optional[pulumi.Input[str]] = None,
|
509
455
|
metric_compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
|
510
456
|
namespace: Optional[pulumi.Input[str]] = None,
|
511
|
-
notification_title: Optional[pulumi.Input[str]] = None,
|
512
457
|
notification_version: Optional[pulumi.Input[str]] = None,
|
513
458
|
overrides: Optional[pulumi.Input[Sequence[pulumi.Input['AlarmOverrideArgs']]]] = None,
|
514
459
|
pending_duration: Optional[pulumi.Input[str]] = None,
|
@@ -524,8 +469,7 @@ class _AlarmState:
|
|
524
469
|
time_updated: Optional[pulumi.Input[str]] = None):
|
525
470
|
"""
|
526
471
|
Input properties used for looking up and filtering Alarm resources.
|
527
|
-
:param pulumi.Input[str]
|
528
|
-
:param pulumi.Input[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.`
|
472
|
+
:param pulumi.Input[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.`
|
529
473
|
:param pulumi.Input[str] compartment_id: (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm.
|
530
474
|
:param pulumi.Input[Mapping[str, Any]] defined_tags: (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}`
|
531
475
|
:param pulumi.Input[Sequence[pulumi.Input[str]]] destinations: (Updatable) 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.
|
@@ -534,7 +478,6 @@ class _AlarmState:
|
|
534
478
|
This value determines the title of each alarm notification.
|
535
479
|
|
536
480
|
Example: `High CPU Utilization`
|
537
|
-
:param pulumi.Input[str] evaluation_slack_duration: (Updatable) 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).
|
538
481
|
:param pulumi.Input[Mapping[str, Any]] freeform_tags: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}`
|
539
482
|
:param pulumi.Input[bool] is_enabled: (Updatable) Whether the alarm is enabled. Example: `true`
|
540
483
|
:param pulumi.Input[bool] is_notifications_per_metric_dimension_enabled: (Updatable) When set to `true`, splits alarm notifications per metric stream. When set to `false`, groups alarm notifications across metric streams. Example: `true`
|
@@ -545,7 +488,6 @@ class _AlarmState:
|
|
545
488
|
:param pulumi.Input[str] metric_compartment_id: (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric being evaluated by the alarm.
|
546
489
|
:param pulumi.Input[bool] metric_compartment_id_in_subtree: (Updatable) 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`
|
547
490
|
:param pulumi.Input[str] namespace: (Updatable) The source service or application emitting the metric that is evaluated by the alarm. Example: `oci_computeagent`
|
548
|
-
:param pulumi.Input[str] notification_title: (Updatable) 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.
|
549
491
|
:param pulumi.Input[str] notification_version: (Updatable) 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.
|
550
492
|
:param pulumi.Input[Sequence[pulumi.Input['AlarmOverrideArgs']]] overrides: (Updatable) A set of overrides that control evaluations of the alarm.
|
551
493
|
|
@@ -559,7 +501,7 @@ class _AlarmState:
|
|
559
501
|
The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute.
|
560
502
|
|
561
503
|
Example: `PT5M`
|
562
|
-
:param pulumi.Input[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.
|
504
|
+
:param pulumi.Input[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).
|
563
505
|
|
564
506
|
Example of threshold alarm:
|
565
507
|
|
@@ -575,9 +517,7 @@ class _AlarmState:
|
|
575
517
|
|
576
518
|
CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent()
|
577
519
|
|
578
|
-
-----
|
579
|
-
|
580
|
-
----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) -----
|
520
|
+
-----
|
581
521
|
:param pulumi.Input[str] repeat_notification_duration: (Updatable) 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.
|
582
522
|
|
583
523
|
Default value: null (notifications are not re-submitted).
|
@@ -585,15 +525,13 @@ class _AlarmState:
|
|
585
525
|
Example: `PT2H`
|
586
526
|
:param pulumi.Input[str] resolution: (Updatable) The time between calculated aggregation windows for the alarm. Supported value: `1m`
|
587
527
|
:param pulumi.Input[str] resource_group: (Updatable) Resource group that you want to match. A null value returns only metric data that has no resource groups. The alarm retrieves metric data associated with the specified resource group only. 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 ($). Avoid entering confidential information. Example: `frontend-fleet`
|
588
|
-
:param pulumi.Input[str] rule_name: (Updatable) 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).
|
528
|
+
:param pulumi.Input[str] rule_name: (Updatable) 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).
|
589
529
|
:param pulumi.Input[str] severity: (Updatable) The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL`
|
590
530
|
:param pulumi.Input[str] state: The current lifecycle state of the alarm. Example: `DELETED`
|
591
531
|
:param pulumi.Input['AlarmSuppressionArgs'] suppression: (Updatable) The configuration details for suppressing an alarm.
|
592
532
|
:param pulumi.Input[str] time_created: The date and time the alarm was created. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z`
|
593
533
|
:param pulumi.Input[str] time_updated: The date and time the alarm was last updated. Format defined by RFC3339. Example: `2023-02-03T01:02:29.600Z`
|
594
534
|
"""
|
595
|
-
if alarm_summary is not None:
|
596
|
-
pulumi.set(__self__, "alarm_summary", alarm_summary)
|
597
535
|
if body is not None:
|
598
536
|
pulumi.set(__self__, "body", body)
|
599
537
|
if compartment_id is not None:
|
@@ -604,8 +542,6 @@ class _AlarmState:
|
|
604
542
|
pulumi.set(__self__, "destinations", destinations)
|
605
543
|
if display_name is not None:
|
606
544
|
pulumi.set(__self__, "display_name", display_name)
|
607
|
-
if evaluation_slack_duration is not None:
|
608
|
-
pulumi.set(__self__, "evaluation_slack_duration", evaluation_slack_duration)
|
609
545
|
if freeform_tags is not None:
|
610
546
|
pulumi.set(__self__, "freeform_tags", freeform_tags)
|
611
547
|
if is_enabled is not None:
|
@@ -620,8 +556,6 @@ class _AlarmState:
|
|
620
556
|
pulumi.set(__self__, "metric_compartment_id_in_subtree", metric_compartment_id_in_subtree)
|
621
557
|
if namespace is not None:
|
622
558
|
pulumi.set(__self__, "namespace", namespace)
|
623
|
-
if notification_title is not None:
|
624
|
-
pulumi.set(__self__, "notification_title", notification_title)
|
625
559
|
if notification_version is not None:
|
626
560
|
pulumi.set(__self__, "notification_version", notification_version)
|
627
561
|
if overrides is not None:
|
@@ -649,23 +583,11 @@ class _AlarmState:
|
|
649
583
|
if time_updated is not None:
|
650
584
|
pulumi.set(__self__, "time_updated", time_updated)
|
651
585
|
|
652
|
-
@property
|
653
|
-
@pulumi.getter(name="alarmSummary")
|
654
|
-
def alarm_summary(self) -> Optional[pulumi.Input[str]]:
|
655
|
-
"""
|
656
|
-
(Updatable) 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).
|
657
|
-
"""
|
658
|
-
return pulumi.get(self, "alarm_summary")
|
659
|
-
|
660
|
-
@alarm_summary.setter
|
661
|
-
def alarm_summary(self, value: Optional[pulumi.Input[str]]):
|
662
|
-
pulumi.set(self, "alarm_summary", value)
|
663
|
-
|
664
586
|
@property
|
665
587
|
@pulumi.getter
|
666
588
|
def body(self) -> Optional[pulumi.Input[str]]:
|
667
589
|
"""
|
668
|
-
(Updatable) The human-readable content of the delivered alarm notification.
|
590
|
+
(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.`
|
669
591
|
"""
|
670
592
|
return pulumi.get(self, "body")
|
671
593
|
|
@@ -725,18 +647,6 @@ class _AlarmState:
|
|
725
647
|
def display_name(self, value: Optional[pulumi.Input[str]]):
|
726
648
|
pulumi.set(self, "display_name", value)
|
727
649
|
|
728
|
-
@property
|
729
|
-
@pulumi.getter(name="evaluationSlackDuration")
|
730
|
-
def evaluation_slack_duration(self) -> Optional[pulumi.Input[str]]:
|
731
|
-
"""
|
732
|
-
(Updatable) 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).
|
733
|
-
"""
|
734
|
-
return pulumi.get(self, "evaluation_slack_duration")
|
735
|
-
|
736
|
-
@evaluation_slack_duration.setter
|
737
|
-
def evaluation_slack_duration(self, value: Optional[pulumi.Input[str]]):
|
738
|
-
pulumi.set(self, "evaluation_slack_duration", value)
|
739
|
-
|
740
650
|
@property
|
741
651
|
@pulumi.getter(name="freeformTags")
|
742
652
|
def freeform_tags(self) -> Optional[pulumi.Input[Mapping[str, Any]]]:
|
@@ -824,18 +734,6 @@ class _AlarmState:
|
|
824
734
|
def namespace(self, value: Optional[pulumi.Input[str]]):
|
825
735
|
pulumi.set(self, "namespace", value)
|
826
736
|
|
827
|
-
@property
|
828
|
-
@pulumi.getter(name="notificationTitle")
|
829
|
-
def notification_title(self) -> Optional[pulumi.Input[str]]:
|
830
|
-
"""
|
831
|
-
(Updatable) 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.
|
832
|
-
"""
|
833
|
-
return pulumi.get(self, "notification_title")
|
834
|
-
|
835
|
-
@notification_title.setter
|
836
|
-
def notification_title(self, value: Optional[pulumi.Input[str]]):
|
837
|
-
pulumi.set(self, "notification_title", value)
|
838
|
-
|
839
737
|
@property
|
840
738
|
@pulumi.getter(name="notificationVersion")
|
841
739
|
def notification_version(self) -> Optional[pulumi.Input[str]]:
|
@@ -886,7 +784,7 @@ class _AlarmState:
|
|
886
784
|
@pulumi.getter
|
887
785
|
def query(self) -> Optional[pulumi.Input[str]]:
|
888
786
|
"""
|
889
|
-
(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.
|
787
|
+
(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).
|
890
788
|
|
891
789
|
Example of threshold alarm:
|
892
790
|
|
@@ -902,9 +800,7 @@ class _AlarmState:
|
|
902
800
|
|
903
801
|
CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent()
|
904
802
|
|
905
|
-
-----
|
906
|
-
|
907
|
-
----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) -----
|
803
|
+
-----
|
908
804
|
"""
|
909
805
|
return pulumi.get(self, "query")
|
910
806
|
|
@@ -956,7 +852,7 @@ class _AlarmState:
|
|
956
852
|
@pulumi.getter(name="ruleName")
|
957
853
|
def rule_name(self) -> Optional[pulumi.Input[str]]:
|
958
854
|
"""
|
959
|
-
(Updatable) 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).
|
855
|
+
(Updatable) 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).
|
960
856
|
"""
|
961
857
|
return pulumi.get(self, "rule_name")
|
962
858
|
|
@@ -1030,13 +926,11 @@ class Alarm(pulumi.CustomResource):
|
|
1030
926
|
def __init__(__self__,
|
1031
927
|
resource_name: str,
|
1032
928
|
opts: Optional[pulumi.ResourceOptions] = None,
|
1033
|
-
alarm_summary: Optional[pulumi.Input[str]] = None,
|
1034
929
|
body: Optional[pulumi.Input[str]] = None,
|
1035
930
|
compartment_id: Optional[pulumi.Input[str]] = None,
|
1036
931
|
defined_tags: Optional[pulumi.Input[Mapping[str, Any]]] = None,
|
1037
932
|
destinations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
1038
933
|
display_name: Optional[pulumi.Input[str]] = None,
|
1039
|
-
evaluation_slack_duration: Optional[pulumi.Input[str]] = None,
|
1040
934
|
freeform_tags: Optional[pulumi.Input[Mapping[str, Any]]] = None,
|
1041
935
|
is_enabled: Optional[pulumi.Input[bool]] = None,
|
1042
936
|
is_notifications_per_metric_dimension_enabled: Optional[pulumi.Input[bool]] = None,
|
@@ -1044,7 +938,6 @@ class Alarm(pulumi.CustomResource):
|
|
1044
938
|
metric_compartment_id: Optional[pulumi.Input[str]] = None,
|
1045
939
|
metric_compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
|
1046
940
|
namespace: Optional[pulumi.Input[str]] = None,
|
1047
|
-
notification_title: Optional[pulumi.Input[str]] = None,
|
1048
941
|
notification_version: Optional[pulumi.Input[str]] = None,
|
1049
942
|
overrides: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['AlarmOverrideArgs']]]]] = None,
|
1050
943
|
pending_duration: Optional[pulumi.Input[str]] = None,
|
@@ -1084,19 +977,16 @@ class Alarm(pulumi.CustomResource):
|
|
1084
977
|
namespace=alarm_namespace,
|
1085
978
|
query=alarm_query,
|
1086
979
|
severity=alarm_severity,
|
1087
|
-
alarm_summary=alarm_alarm_summary,
|
1088
980
|
body=alarm_body,
|
1089
981
|
defined_tags={
|
1090
982
|
"Operations.CostCenter": "42",
|
1091
983
|
},
|
1092
|
-
evaluation_slack_duration=alarm_evaluation_slack_duration,
|
1093
984
|
freeform_tags={
|
1094
985
|
"Department": "Finance",
|
1095
986
|
},
|
1096
987
|
is_notifications_per_metric_dimension_enabled=alarm_is_notifications_per_metric_dimension_enabled,
|
1097
988
|
message_format=alarm_message_format,
|
1098
989
|
metric_compartment_id_in_subtree=alarm_metric_compartment_id_in_subtree,
|
1099
|
-
notification_title=alarm_notification_title,
|
1100
990
|
notification_version=alarm_notification_version,
|
1101
991
|
overrides=[oci.monitoring.AlarmOverrideArgs(
|
1102
992
|
body=alarm_overrides_body,
|
@@ -1127,8 +1017,7 @@ class Alarm(pulumi.CustomResource):
|
|
1127
1017
|
|
1128
1018
|
:param str resource_name: The name of the resource.
|
1129
1019
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
1130
|
-
:param pulumi.Input[str]
|
1131
|
-
:param pulumi.Input[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.`
|
1020
|
+
:param pulumi.Input[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.`
|
1132
1021
|
:param pulumi.Input[str] compartment_id: (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm.
|
1133
1022
|
:param pulumi.Input[Mapping[str, Any]] defined_tags: (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}`
|
1134
1023
|
:param pulumi.Input[Sequence[pulumi.Input[str]]] destinations: (Updatable) 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.
|
@@ -1137,7 +1026,6 @@ class Alarm(pulumi.CustomResource):
|
|
1137
1026
|
This value determines the title of each alarm notification.
|
1138
1027
|
|
1139
1028
|
Example: `High CPU Utilization`
|
1140
|
-
:param pulumi.Input[str] evaluation_slack_duration: (Updatable) 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).
|
1141
1029
|
:param pulumi.Input[Mapping[str, Any]] freeform_tags: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}`
|
1142
1030
|
:param pulumi.Input[bool] is_enabled: (Updatable) Whether the alarm is enabled. Example: `true`
|
1143
1031
|
:param pulumi.Input[bool] is_notifications_per_metric_dimension_enabled: (Updatable) When set to `true`, splits alarm notifications per metric stream. When set to `false`, groups alarm notifications across metric streams. Example: `true`
|
@@ -1148,7 +1036,6 @@ class Alarm(pulumi.CustomResource):
|
|
1148
1036
|
:param pulumi.Input[str] metric_compartment_id: (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric being evaluated by the alarm.
|
1149
1037
|
:param pulumi.Input[bool] metric_compartment_id_in_subtree: (Updatable) 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`
|
1150
1038
|
:param pulumi.Input[str] namespace: (Updatable) The source service or application emitting the metric that is evaluated by the alarm. Example: `oci_computeagent`
|
1151
|
-
:param pulumi.Input[str] notification_title: (Updatable) 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.
|
1152
1039
|
:param pulumi.Input[str] notification_version: (Updatable) 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.
|
1153
1040
|
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['AlarmOverrideArgs']]]] overrides: (Updatable) A set of overrides that control evaluations of the alarm.
|
1154
1041
|
|
@@ -1162,7 +1049,7 @@ class Alarm(pulumi.CustomResource):
|
|
1162
1049
|
The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute.
|
1163
1050
|
|
1164
1051
|
Example: `PT5M`
|
1165
|
-
:param pulumi.Input[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.
|
1052
|
+
:param pulumi.Input[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).
|
1166
1053
|
|
1167
1054
|
Example of threshold alarm:
|
1168
1055
|
|
@@ -1178,9 +1065,7 @@ class Alarm(pulumi.CustomResource):
|
|
1178
1065
|
|
1179
1066
|
CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent()
|
1180
1067
|
|
1181
|
-
-----
|
1182
|
-
|
1183
|
-
----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) -----
|
1068
|
+
-----
|
1184
1069
|
:param pulumi.Input[str] repeat_notification_duration: (Updatable) 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.
|
1185
1070
|
|
1186
1071
|
Default value: null (notifications are not re-submitted).
|
@@ -1188,7 +1073,7 @@ class Alarm(pulumi.CustomResource):
|
|
1188
1073
|
Example: `PT2H`
|
1189
1074
|
:param pulumi.Input[str] resolution: (Updatable) The time between calculated aggregation windows for the alarm. Supported value: `1m`
|
1190
1075
|
:param pulumi.Input[str] resource_group: (Updatable) Resource group that you want to match. A null value returns only metric data that has no resource groups. The alarm retrieves metric data associated with the specified resource group only. 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 ($). Avoid entering confidential information. Example: `frontend-fleet`
|
1191
|
-
:param pulumi.Input[str] rule_name: (Updatable) 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).
|
1076
|
+
:param pulumi.Input[str] rule_name: (Updatable) 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).
|
1192
1077
|
:param pulumi.Input[str] severity: (Updatable) The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL`
|
1193
1078
|
:param pulumi.Input[pulumi.InputType['AlarmSuppressionArgs']] suppression: (Updatable) The configuration details for suppressing an alarm.
|
1194
1079
|
"""
|
@@ -1226,19 +1111,16 @@ class Alarm(pulumi.CustomResource):
|
|
1226
1111
|
namespace=alarm_namespace,
|
1227
1112
|
query=alarm_query,
|
1228
1113
|
severity=alarm_severity,
|
1229
|
-
alarm_summary=alarm_alarm_summary,
|
1230
1114
|
body=alarm_body,
|
1231
1115
|
defined_tags={
|
1232
1116
|
"Operations.CostCenter": "42",
|
1233
1117
|
},
|
1234
|
-
evaluation_slack_duration=alarm_evaluation_slack_duration,
|
1235
1118
|
freeform_tags={
|
1236
1119
|
"Department": "Finance",
|
1237
1120
|
},
|
1238
1121
|
is_notifications_per_metric_dimension_enabled=alarm_is_notifications_per_metric_dimension_enabled,
|
1239
1122
|
message_format=alarm_message_format,
|
1240
1123
|
metric_compartment_id_in_subtree=alarm_metric_compartment_id_in_subtree,
|
1241
|
-
notification_title=alarm_notification_title,
|
1242
1124
|
notification_version=alarm_notification_version,
|
1243
1125
|
overrides=[oci.monitoring.AlarmOverrideArgs(
|
1244
1126
|
body=alarm_overrides_body,
|
@@ -1282,13 +1164,11 @@ class Alarm(pulumi.CustomResource):
|
|
1282
1164
|
def _internal_init(__self__,
|
1283
1165
|
resource_name: str,
|
1284
1166
|
opts: Optional[pulumi.ResourceOptions] = None,
|
1285
|
-
alarm_summary: Optional[pulumi.Input[str]] = None,
|
1286
1167
|
body: Optional[pulumi.Input[str]] = None,
|
1287
1168
|
compartment_id: Optional[pulumi.Input[str]] = None,
|
1288
1169
|
defined_tags: Optional[pulumi.Input[Mapping[str, Any]]] = None,
|
1289
1170
|
destinations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
1290
1171
|
display_name: Optional[pulumi.Input[str]] = None,
|
1291
|
-
evaluation_slack_duration: Optional[pulumi.Input[str]] = None,
|
1292
1172
|
freeform_tags: Optional[pulumi.Input[Mapping[str, Any]]] = None,
|
1293
1173
|
is_enabled: Optional[pulumi.Input[bool]] = None,
|
1294
1174
|
is_notifications_per_metric_dimension_enabled: Optional[pulumi.Input[bool]] = None,
|
@@ -1296,7 +1176,6 @@ class Alarm(pulumi.CustomResource):
|
|
1296
1176
|
metric_compartment_id: Optional[pulumi.Input[str]] = None,
|
1297
1177
|
metric_compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
|
1298
1178
|
namespace: Optional[pulumi.Input[str]] = None,
|
1299
|
-
notification_title: Optional[pulumi.Input[str]] = None,
|
1300
1179
|
notification_version: Optional[pulumi.Input[str]] = None,
|
1301
1180
|
overrides: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['AlarmOverrideArgs']]]]] = None,
|
1302
1181
|
pending_duration: Optional[pulumi.Input[str]] = None,
|
@@ -1316,7 +1195,6 @@ class Alarm(pulumi.CustomResource):
|
|
1316
1195
|
raise TypeError('__props__ is only valid when passed in combination with a valid opts.id to get an existing resource')
|
1317
1196
|
__props__ = AlarmArgs.__new__(AlarmArgs)
|
1318
1197
|
|
1319
|
-
__props__.__dict__["alarm_summary"] = alarm_summary
|
1320
1198
|
__props__.__dict__["body"] = body
|
1321
1199
|
if compartment_id is None and not opts.urn:
|
1322
1200
|
raise TypeError("Missing required property 'compartment_id'")
|
@@ -1328,7 +1206,6 @@ class Alarm(pulumi.CustomResource):
|
|
1328
1206
|
if display_name is None and not opts.urn:
|
1329
1207
|
raise TypeError("Missing required property 'display_name'")
|
1330
1208
|
__props__.__dict__["display_name"] = display_name
|
1331
|
-
__props__.__dict__["evaluation_slack_duration"] = evaluation_slack_duration
|
1332
1209
|
__props__.__dict__["freeform_tags"] = freeform_tags
|
1333
1210
|
if is_enabled is None and not opts.urn:
|
1334
1211
|
raise TypeError("Missing required property 'is_enabled'")
|
@@ -1342,7 +1219,6 @@ class Alarm(pulumi.CustomResource):
|
|
1342
1219
|
if namespace is None and not opts.urn:
|
1343
1220
|
raise TypeError("Missing required property 'namespace'")
|
1344
1221
|
__props__.__dict__["namespace"] = namespace
|
1345
|
-
__props__.__dict__["notification_title"] = notification_title
|
1346
1222
|
__props__.__dict__["notification_version"] = notification_version
|
1347
1223
|
__props__.__dict__["overrides"] = overrides
|
1348
1224
|
__props__.__dict__["pending_duration"] = pending_duration
|
@@ -1370,13 +1246,11 @@ class Alarm(pulumi.CustomResource):
|
|
1370
1246
|
def get(resource_name: str,
|
1371
1247
|
id: pulumi.Input[str],
|
1372
1248
|
opts: Optional[pulumi.ResourceOptions] = None,
|
1373
|
-
alarm_summary: Optional[pulumi.Input[str]] = None,
|
1374
1249
|
body: Optional[pulumi.Input[str]] = None,
|
1375
1250
|
compartment_id: Optional[pulumi.Input[str]] = None,
|
1376
1251
|
defined_tags: Optional[pulumi.Input[Mapping[str, Any]]] = None,
|
1377
1252
|
destinations: Optional[pulumi.Input[Sequence[pulumi.Input[str]]]] = None,
|
1378
1253
|
display_name: Optional[pulumi.Input[str]] = None,
|
1379
|
-
evaluation_slack_duration: Optional[pulumi.Input[str]] = None,
|
1380
1254
|
freeform_tags: Optional[pulumi.Input[Mapping[str, Any]]] = None,
|
1381
1255
|
is_enabled: Optional[pulumi.Input[bool]] = None,
|
1382
1256
|
is_notifications_per_metric_dimension_enabled: Optional[pulumi.Input[bool]] = None,
|
@@ -1384,7 +1258,6 @@ class Alarm(pulumi.CustomResource):
|
|
1384
1258
|
metric_compartment_id: Optional[pulumi.Input[str]] = None,
|
1385
1259
|
metric_compartment_id_in_subtree: Optional[pulumi.Input[bool]] = None,
|
1386
1260
|
namespace: Optional[pulumi.Input[str]] = None,
|
1387
|
-
notification_title: Optional[pulumi.Input[str]] = None,
|
1388
1261
|
notification_version: Optional[pulumi.Input[str]] = None,
|
1389
1262
|
overrides: Optional[pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['AlarmOverrideArgs']]]]] = None,
|
1390
1263
|
pending_duration: Optional[pulumi.Input[str]] = None,
|
@@ -1405,8 +1278,7 @@ class Alarm(pulumi.CustomResource):
|
|
1405
1278
|
:param str resource_name: The unique name of the resulting resource.
|
1406
1279
|
:param pulumi.Input[str] id: The unique provider ID of the resource to lookup.
|
1407
1280
|
:param pulumi.ResourceOptions opts: Options for the resource.
|
1408
|
-
:param pulumi.Input[str]
|
1409
|
-
:param pulumi.Input[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.`
|
1281
|
+
:param pulumi.Input[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.`
|
1410
1282
|
:param pulumi.Input[str] compartment_id: (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm.
|
1411
1283
|
:param pulumi.Input[Mapping[str, Any]] defined_tags: (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}`
|
1412
1284
|
:param pulumi.Input[Sequence[pulumi.Input[str]]] destinations: (Updatable) 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.
|
@@ -1415,7 +1287,6 @@ class Alarm(pulumi.CustomResource):
|
|
1415
1287
|
This value determines the title of each alarm notification.
|
1416
1288
|
|
1417
1289
|
Example: `High CPU Utilization`
|
1418
|
-
:param pulumi.Input[str] evaluation_slack_duration: (Updatable) 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).
|
1419
1290
|
:param pulumi.Input[Mapping[str, Any]] freeform_tags: (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}`
|
1420
1291
|
:param pulumi.Input[bool] is_enabled: (Updatable) Whether the alarm is enabled. Example: `true`
|
1421
1292
|
:param pulumi.Input[bool] is_notifications_per_metric_dimension_enabled: (Updatable) When set to `true`, splits alarm notifications per metric stream. When set to `false`, groups alarm notifications across metric streams. Example: `true`
|
@@ -1426,7 +1297,6 @@ class Alarm(pulumi.CustomResource):
|
|
1426
1297
|
:param pulumi.Input[str] metric_compartment_id: (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the metric being evaluated by the alarm.
|
1427
1298
|
:param pulumi.Input[bool] metric_compartment_id_in_subtree: (Updatable) 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`
|
1428
1299
|
:param pulumi.Input[str] namespace: (Updatable) The source service or application emitting the metric that is evaluated by the alarm. Example: `oci_computeagent`
|
1429
|
-
:param pulumi.Input[str] notification_title: (Updatable) 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.
|
1430
1300
|
:param pulumi.Input[str] notification_version: (Updatable) 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.
|
1431
1301
|
:param pulumi.Input[Sequence[pulumi.Input[pulumi.InputType['AlarmOverrideArgs']]]] overrides: (Updatable) A set of overrides that control evaluations of the alarm.
|
1432
1302
|
|
@@ -1440,7 +1310,7 @@ class Alarm(pulumi.CustomResource):
|
|
1440
1310
|
The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute.
|
1441
1311
|
|
1442
1312
|
Example: `PT5M`
|
1443
|
-
:param pulumi.Input[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.
|
1313
|
+
:param pulumi.Input[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).
|
1444
1314
|
|
1445
1315
|
Example of threshold alarm:
|
1446
1316
|
|
@@ -1456,9 +1326,7 @@ class Alarm(pulumi.CustomResource):
|
|
1456
1326
|
|
1457
1327
|
CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent()
|
1458
1328
|
|
1459
|
-
-----
|
1460
|
-
|
1461
|
-
----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) -----
|
1329
|
+
-----
|
1462
1330
|
:param pulumi.Input[str] repeat_notification_duration: (Updatable) 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.
|
1463
1331
|
|
1464
1332
|
Default value: null (notifications are not re-submitted).
|
@@ -1466,7 +1334,7 @@ class Alarm(pulumi.CustomResource):
|
|
1466
1334
|
Example: `PT2H`
|
1467
1335
|
:param pulumi.Input[str] resolution: (Updatable) The time between calculated aggregation windows for the alarm. Supported value: `1m`
|
1468
1336
|
:param pulumi.Input[str] resource_group: (Updatable) Resource group that you want to match. A null value returns only metric data that has no resource groups. The alarm retrieves metric data associated with the specified resource group only. 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 ($). Avoid entering confidential information. Example: `frontend-fleet`
|
1469
|
-
:param pulumi.Input[str] rule_name: (Updatable) 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).
|
1337
|
+
:param pulumi.Input[str] rule_name: (Updatable) 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).
|
1470
1338
|
:param pulumi.Input[str] severity: (Updatable) The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL`
|
1471
1339
|
:param pulumi.Input[str] state: The current lifecycle state of the alarm. Example: `DELETED`
|
1472
1340
|
:param pulumi.Input[pulumi.InputType['AlarmSuppressionArgs']] suppression: (Updatable) The configuration details for suppressing an alarm.
|
@@ -1477,13 +1345,11 @@ class Alarm(pulumi.CustomResource):
|
|
1477
1345
|
|
1478
1346
|
__props__ = _AlarmState.__new__(_AlarmState)
|
1479
1347
|
|
1480
|
-
__props__.__dict__["alarm_summary"] = alarm_summary
|
1481
1348
|
__props__.__dict__["body"] = body
|
1482
1349
|
__props__.__dict__["compartment_id"] = compartment_id
|
1483
1350
|
__props__.__dict__["defined_tags"] = defined_tags
|
1484
1351
|
__props__.__dict__["destinations"] = destinations
|
1485
1352
|
__props__.__dict__["display_name"] = display_name
|
1486
|
-
__props__.__dict__["evaluation_slack_duration"] = evaluation_slack_duration
|
1487
1353
|
__props__.__dict__["freeform_tags"] = freeform_tags
|
1488
1354
|
__props__.__dict__["is_enabled"] = is_enabled
|
1489
1355
|
__props__.__dict__["is_notifications_per_metric_dimension_enabled"] = is_notifications_per_metric_dimension_enabled
|
@@ -1491,7 +1357,6 @@ class Alarm(pulumi.CustomResource):
|
|
1491
1357
|
__props__.__dict__["metric_compartment_id"] = metric_compartment_id
|
1492
1358
|
__props__.__dict__["metric_compartment_id_in_subtree"] = metric_compartment_id_in_subtree
|
1493
1359
|
__props__.__dict__["namespace"] = namespace
|
1494
|
-
__props__.__dict__["notification_title"] = notification_title
|
1495
1360
|
__props__.__dict__["notification_version"] = notification_version
|
1496
1361
|
__props__.__dict__["overrides"] = overrides
|
1497
1362
|
__props__.__dict__["pending_duration"] = pending_duration
|
@@ -1507,19 +1372,11 @@ class Alarm(pulumi.CustomResource):
|
|
1507
1372
|
__props__.__dict__["time_updated"] = time_updated
|
1508
1373
|
return Alarm(resource_name, opts=opts, __props__=__props__)
|
1509
1374
|
|
1510
|
-
@property
|
1511
|
-
@pulumi.getter(name="alarmSummary")
|
1512
|
-
def alarm_summary(self) -> pulumi.Output[str]:
|
1513
|
-
"""
|
1514
|
-
(Updatable) 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).
|
1515
|
-
"""
|
1516
|
-
return pulumi.get(self, "alarm_summary")
|
1517
|
-
|
1518
1375
|
@property
|
1519
1376
|
@pulumi.getter
|
1520
1377
|
def body(self) -> pulumi.Output[str]:
|
1521
1378
|
"""
|
1522
|
-
(Updatable) The human-readable content of the delivered alarm notification.
|
1379
|
+
(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.`
|
1523
1380
|
"""
|
1524
1381
|
return pulumi.get(self, "body")
|
1525
1382
|
|
@@ -1559,14 +1416,6 @@ class Alarm(pulumi.CustomResource):
|
|
1559
1416
|
"""
|
1560
1417
|
return pulumi.get(self, "display_name")
|
1561
1418
|
|
1562
|
-
@property
|
1563
|
-
@pulumi.getter(name="evaluationSlackDuration")
|
1564
|
-
def evaluation_slack_duration(self) -> pulumi.Output[str]:
|
1565
|
-
"""
|
1566
|
-
(Updatable) 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).
|
1567
|
-
"""
|
1568
|
-
return pulumi.get(self, "evaluation_slack_duration")
|
1569
|
-
|
1570
1419
|
@property
|
1571
1420
|
@pulumi.getter(name="freeformTags")
|
1572
1421
|
def freeform_tags(self) -> pulumi.Output[Mapping[str, Any]]:
|
@@ -1626,14 +1475,6 @@ class Alarm(pulumi.CustomResource):
|
|
1626
1475
|
"""
|
1627
1476
|
return pulumi.get(self, "namespace")
|
1628
1477
|
|
1629
|
-
@property
|
1630
|
-
@pulumi.getter(name="notificationTitle")
|
1631
|
-
def notification_title(self) -> pulumi.Output[str]:
|
1632
|
-
"""
|
1633
|
-
(Updatable) 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.
|
1634
|
-
"""
|
1635
|
-
return pulumi.get(self, "notification_title")
|
1636
|
-
|
1637
1478
|
@property
|
1638
1479
|
@pulumi.getter(name="notificationVersion")
|
1639
1480
|
def notification_version(self) -> pulumi.Output[str]:
|
@@ -1672,7 +1513,7 @@ class Alarm(pulumi.CustomResource):
|
|
1672
1513
|
@pulumi.getter
|
1673
1514
|
def query(self) -> pulumi.Output[str]:
|
1674
1515
|
"""
|
1675
|
-
(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.
|
1516
|
+
(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).
|
1676
1517
|
|
1677
1518
|
Example of threshold alarm:
|
1678
1519
|
|
@@ -1688,9 +1529,7 @@ class Alarm(pulumi.CustomResource):
|
|
1688
1529
|
|
1689
1530
|
CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent()
|
1690
1531
|
|
1691
|
-
-----
|
1692
|
-
|
1693
|
-
----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) -----
|
1532
|
+
-----
|
1694
1533
|
"""
|
1695
1534
|
return pulumi.get(self, "query")
|
1696
1535
|
|
@@ -1726,7 +1565,7 @@ class Alarm(pulumi.CustomResource):
|
|
1726
1565
|
@pulumi.getter(name="ruleName")
|
1727
1566
|
def rule_name(self) -> pulumi.Output[str]:
|
1728
1567
|
"""
|
1729
|
-
(Updatable) 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).
|
1568
|
+
(Updatable) 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).
|
1730
1569
|
"""
|
1731
1570
|
return pulumi.get(self, "rule_name")
|
1732
1571
|
|