import * as pulumi from "@pulumi/pulumi"; import * as inputs from "../types/input"; import * as outputs from "../types/output"; /** * This resource provides the Alarm resource in Oracle Cloud Infrastructure Monitoring service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/monitoring/latest/Alarm * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/monitoring * * Creates a new alarm in the specified compartment. * For more information, see * [Creating an Alarm](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-alarm.htm). * For important limits information, see * [Limits on Monitoring](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Concepts/monitoringoverview.htm#limits). * * This call is subject to a Monitoring limit that applies to the total number of requests across all alarm operations. * Monitoring might throttle this call to reject an otherwise valid request when the total rate of alarm operations exceeds 10 requests, * or transactions, per second (TPS) for a given tenancy. * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testAlarm = new oci.monitoring.Alarm("test_alarm", { * compartmentId: compartmentId, * destinations: [testNotificationTopic.id], * displayName: alarmDisplayName, * isEnabled: alarmIsEnabled === "true", * metricCompartmentId: alarmMetricCompartmentId, * namespace: alarmNamespace, * query: alarmQuery, * severity: alarmSeverity, * alarmSummary: alarmAlarmSummary, * body: alarmBody, * definedTags: { * "Operations.CostCenter": "42", * }, * evaluationSlackDuration: alarmEvaluationSlackDuration, * freeformTags: { * Department: "Finance", * }, * isNotificationsPerMetricDimensionEnabled: alarmIsNotificationsPerMetricDimensionEnabled === "true", * messageFormat: alarmMessageFormat, * metricCompartmentIdInSubtree: alarmMetricCompartmentIdInSubtree === "true", * notificationTitle: alarmNotificationTitle, * notificationVersion: alarmNotificationVersion, * overrides: [{ * body: alarmOverridesBody, * pendingDuration: alarmOverridesPendingDuration, * query: alarmOverridesQuery, * ruleName: testRule.name, * severity: alarmOverridesSeverity, * }], * pendingDuration: alarmPendingDuration, * repeatNotificationDuration: alarmRepeatNotificationDuration, * resolution: alarmResolution, * resourceGroup: alarmResourceGroup, * ruleName: testRule.name, * suppression: { * timeSuppressFrom: alarmSuppressionTimeSuppressFrom, * timeSuppressUntil: alarmSuppressionTimeSuppressUntil, * description: alarmSuppressionDescription, * }, * }); * ``` * * ## Import * * Alarms can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:Monitoring/alarm:Alarm test_alarm "id" * ``` */ export declare class Alarm extends pulumi.CustomResource { /** * Get an existing Alarm resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: AlarmState, opts?: pulumi.CustomResourceOptions): Alarm; /** * Returns true if the given object is an instance of Alarm. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is Alarm; /** * (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). */ readonly alarmSummary: pulumi.Output; /** * (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.` */ readonly body: pulumi.Output; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm. */ readonly compartmentId: pulumi.Output; /** * (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (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. */ readonly destinations: pulumi.Output; /** * (Updatable) A user-friendly name for the alarm. It does not have to be unique, and it's changeable. Avoid entering confidential information. * * This value determines the title of each alarm notification. * * Example: `High CPU Utilization` */ readonly displayName: pulumi.Output; /** * (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). */ readonly evaluationSlackDuration: pulumi.Output; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) Whether the alarm is enabled. Example: `true` */ readonly isEnabled: pulumi.Output; /** * (Updatable) When set to `true`, splits alarm notifications per metric stream. When set to `false`, groups alarm notifications across metric streams. Example: `true` */ readonly isNotificationsPerMetricDimensionEnabled: pulumi.Output; /** * (Updatable) The format to use for alarm notifications. The formats are: * * `RAW` - Raw JSON blob. Default value. When the `destinations` attribute specifies `Streaming`, all alarm notifications use this format. * * `PRETTY_JSON`: JSON with new lines and indents. Available when the `destinations` attribute specifies `Notifications` only. * * `ONS_OPTIMIZED`: Simplified, user-friendly layout. Available when the `destinations` attribute specifies `Notifications` only. Applies to Email subscription types only. */ readonly messageFormat: pulumi.Output; /** * (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. */ readonly metricCompartmentId: pulumi.Output; /** * (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` */ readonly metricCompartmentIdInSubtree: pulumi.Output; /** * (Updatable) The source service or application emitting the metric that is evaluated by the alarm. Example: `ociComputeagent` */ readonly namespace: pulumi.Output; /** * (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. */ readonly notificationTitle: pulumi.Output; /** * (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. */ readonly notificationVersion: pulumi.Output; /** * (Updatable) A set of overrides that control evaluations of the alarm. * * Each override can specify values for query, severity, body, and pending duration. When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position `0`), and then evaluates the alarm's base values (`ruleName` value of `BASE`). */ readonly overrides: pulumi.Output; /** * (Updatable) The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING". * * The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M. * * Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to "FIRING". * * The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute. * * Example: `PT5M` */ readonly pendingDuration: pulumi.Output; /** * (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). * * Example of threshold alarm: * * *** * * CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85 * * *** * * Example of absence alarm: * * *** * * CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent() * * ----- Example of absence alarm with custom absence detection period of 20 hours: * * ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) ----- */ readonly query: pulumi.Output; /** * (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. * * Default value: null (notifications are not re-submitted). * * Example: `PT2H` */ readonly repeatNotificationDuration: pulumi.Output; /** * (Updatable) The time between calculated aggregation windows for the alarm. Supported value: `1m` */ readonly resolution: pulumi.Output; /** * (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` */ readonly resourceGroup: pulumi.Output; /** * (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). */ readonly ruleName: pulumi.Output; /** * (Updatable) The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL` */ readonly severity: pulumi.Output; /** * The current lifecycle state of the alarm. Example: `DELETED` */ readonly state: pulumi.Output; /** * (Updatable) The configuration details for suppressing an alarm. */ readonly suppression: pulumi.Output; /** * The date and time the alarm was created. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z` */ readonly timeCreated: pulumi.Output; /** * The date and time the alarm was last updated. Format defined by RFC3339. Example: `2023-02-03T01:02:29.600Z` */ readonly timeUpdated: pulumi.Output; /** * Create a Alarm resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: AlarmArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering Alarm resources. */ export interface AlarmState { /** * (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). */ alarmSummary?: pulumi.Input; /** * (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.` */ body?: pulumi.Input; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm. */ compartmentId?: pulumi.Input; /** * (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (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. */ destinations?: pulumi.Input[] | undefined>; /** * (Updatable) A user-friendly name for the alarm. It does not have to be unique, and it's changeable. Avoid entering confidential information. * * This value determines the title of each alarm notification. * * Example: `High CPU Utilization` */ displayName?: pulumi.Input; /** * (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). */ evaluationSlackDuration?: pulumi.Input; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Whether the alarm is enabled. Example: `true` */ isEnabled?: pulumi.Input; /** * (Updatable) When set to `true`, splits alarm notifications per metric stream. When set to `false`, groups alarm notifications across metric streams. Example: `true` */ isNotificationsPerMetricDimensionEnabled?: pulumi.Input; /** * (Updatable) The format to use for alarm notifications. The formats are: * * `RAW` - Raw JSON blob. Default value. When the `destinations` attribute specifies `Streaming`, all alarm notifications use this format. * * `PRETTY_JSON`: JSON with new lines and indents. Available when the `destinations` attribute specifies `Notifications` only. * * `ONS_OPTIMIZED`: Simplified, user-friendly layout. Available when the `destinations` attribute specifies `Notifications` only. Applies to Email subscription types only. */ messageFormat?: pulumi.Input; /** * (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. */ metricCompartmentId?: pulumi.Input; /** * (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` */ metricCompartmentIdInSubtree?: pulumi.Input; /** * (Updatable) The source service or application emitting the metric that is evaluated by the alarm. Example: `ociComputeagent` */ namespace?: pulumi.Input; /** * (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. */ notificationTitle?: pulumi.Input; /** * (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. */ notificationVersion?: pulumi.Input; /** * (Updatable) A set of overrides that control evaluations of the alarm. * * Each override can specify values for query, severity, body, and pending duration. When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position `0`), and then evaluates the alarm's base values (`ruleName` value of `BASE`). */ overrides?: pulumi.Input[] | undefined>; /** * (Updatable) The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING". * * The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M. * * Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to "FIRING". * * The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute. * * Example: `PT5M` */ pendingDuration?: pulumi.Input; /** * (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). * * Example of threshold alarm: * * *** * * CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85 * * *** * * Example of absence alarm: * * *** * * CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent() * * ----- Example of absence alarm with custom absence detection period of 20 hours: * * ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) ----- */ query?: pulumi.Input; /** * (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. * * Default value: null (notifications are not re-submitted). * * Example: `PT2H` */ repeatNotificationDuration?: pulumi.Input; /** * (Updatable) The time between calculated aggregation windows for the alarm. Supported value: `1m` */ resolution?: pulumi.Input; /** * (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` */ resourceGroup?: pulumi.Input; /** * (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). */ ruleName?: pulumi.Input; /** * (Updatable) The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL` */ severity?: pulumi.Input; /** * The current lifecycle state of the alarm. Example: `DELETED` */ state?: pulumi.Input; /** * (Updatable) The configuration details for suppressing an alarm. */ suppression?: pulumi.Input; /** * The date and time the alarm was created. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z` */ timeCreated?: pulumi.Input; /** * The date and time the alarm was last updated. Format defined by RFC3339. Example: `2023-02-03T01:02:29.600Z` */ timeUpdated?: pulumi.Input; } /** * The set of arguments for constructing a Alarm resource. */ export interface AlarmArgs { /** * (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). */ alarmSummary?: pulumi.Input; /** * (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.` */ body?: pulumi.Input; /** * (Updatable) The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm. */ compartmentId: pulumi.Input; /** * (Updatable) Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (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. */ destinations: pulumi.Input[]>; /** * (Updatable) A user-friendly name for the alarm. It does not have to be unique, and it's changeable. Avoid entering confidential information. * * This value determines the title of each alarm notification. * * Example: `High CPU Utilization` */ displayName: pulumi.Input; /** * (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). */ evaluationSlackDuration?: pulumi.Input; /** * (Updatable) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) Whether the alarm is enabled. Example: `true` */ isEnabled: pulumi.Input; /** * (Updatable) When set to `true`, splits alarm notifications per metric stream. When set to `false`, groups alarm notifications across metric streams. Example: `true` */ isNotificationsPerMetricDimensionEnabled?: pulumi.Input; /** * (Updatable) The format to use for alarm notifications. The formats are: * * `RAW` - Raw JSON blob. Default value. When the `destinations` attribute specifies `Streaming`, all alarm notifications use this format. * * `PRETTY_JSON`: JSON with new lines and indents. Available when the `destinations` attribute specifies `Notifications` only. * * `ONS_OPTIMIZED`: Simplified, user-friendly layout. Available when the `destinations` attribute specifies `Notifications` only. Applies to Email subscription types only. */ messageFormat?: pulumi.Input; /** * (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. */ metricCompartmentId: pulumi.Input; /** * (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` */ metricCompartmentIdInSubtree?: pulumi.Input; /** * (Updatable) The source service or application emitting the metric that is evaluated by the alarm. Example: `ociComputeagent` */ namespace: pulumi.Input; /** * (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. */ notificationTitle?: pulumi.Input; /** * (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. */ notificationVersion?: pulumi.Input; /** * (Updatable) A set of overrides that control evaluations of the alarm. * * Each override can specify values for query, severity, body, and pending duration. When an alarm contains overrides, the Monitoring service evaluates each override in order, beginning with the first override in the array (index position `0`), and then evaluates the alarm's base values (`ruleName` value of `BASE`). */ overrides?: pulumi.Input[] | undefined>; /** * (Updatable) The period of time that the condition defined in the alarm must persist before the alarm state changes from "OK" to "FIRING". For example, a value of 5 minutes means that the alarm must persist in breaching the condition for five minutes before the alarm updates its state to "FIRING". * * The duration is specified as a string in ISO 8601 format (`PT10M` for ten minutes or `PT1H` for one hour). Minimum: PT1M. Maximum: PT1H. Default: PT1M. * * Under the default value of PT1M, the first evaluation that breaches the alarm updates the state to "FIRING". * * The alarm updates its status to "OK" when the breaching condition has been clear for the most recent minute. * * Example: `PT5M` */ pendingDuration?: pulumi.Input; /** * (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). * * Example of threshold alarm: * * *** * * CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.groupBy(availabilityDomain).percentile(0.9) > 85 * * *** * * Example of absence alarm: * * *** * * CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent() * * ----- Example of absence alarm with custom absence detection period of 20 hours: * * ----- CpuUtilization[1m]{availabilityDomain="cumS:PHX-AD-1"}.absent(20h) ----- */ query: pulumi.Input; /** * (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. * * Default value: null (notifications are not re-submitted). * * Example: `PT2H` */ repeatNotificationDuration?: pulumi.Input; /** * (Updatable) The time between calculated aggregation windows for the alarm. Supported value: `1m` */ resolution?: pulumi.Input; /** * (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` */ resourceGroup?: pulumi.Input; /** * (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). */ ruleName?: pulumi.Input; /** * (Updatable) The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL` */ severity: pulumi.Input; /** * (Updatable) The configuration details for suppressing an alarm. */ suppression?: pulumi.Input; } //# sourceMappingURL=alarm.d.ts.map