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