import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * This data source provides details about a specific Alarm resource in Oracle Cloud Infrastructure Monitoring service. * * Gets the specified alarm. * For more information, see * [Getting an Alarm](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/get-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 = oci.monitoring.getAlarm({ * alarmId: testAlarmOciMonitoringAlarm.id, * }); * ``` */ export declare function getAlarm(args: GetAlarmArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getAlarm. */ export interface GetAlarmArgs { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm. */ alarmId: string; } /** * A collection of values returned by getAlarm. */ export interface GetAlarmResult { readonly alarmId: string; /** * 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: string; /** * 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: string; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment containing the alarm. */ readonly compartmentId: string; /** * Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: { [key: string]: string; }; /** * 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: string[]; /** * A user-friendly name for the alarm. It does not have to be unique, and it's changeable. */ readonly displayName: string; /** * 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: string; /** * Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"Department": "Finance"}` */ readonly freeformTags: { [key: string]: string; }; /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the alarm. */ readonly id: string; /** * Whether the alarm is enabled. Example: `true` */ readonly isEnabled: boolean; /** * Whether the alarm sends a separate message for each metric stream. See [Creating an Alarm That Splits Messages by Metric Stream](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/create-alarm-split.htm). Example: `true` */ readonly isNotificationsPerMetricDimensionEnabled: boolean; /** * 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: string; /** * 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: string; /** * 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: boolean; /** * The source service or application emitting the metric that is evaluated by the alarm. Example: `ociComputeagent` */ readonly namespace: string; /** * 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: string; /** * 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: string; /** * A set of overrides that control evaluations of the alarm. */ readonly overrides: outputs.Monitoring.GetAlarmOverride[]; /** * 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". */ readonly pendingDuration: string; /** * 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). */ readonly query: string; /** * 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. */ readonly repeatNotificationDuration: string; /** * The time between calculated aggregation windows for the alarm. Supported value: `1m` */ readonly resolution: string; /** * Resource group that you want to match. A null value returns only metric data that has no resource groups. The specified resource group must exist in the definition of the posted metric. Only one resource group can be applied per metric. A valid resourceGroup value starts with an alphabetical character and includes only alphanumeric characters, periods (.), underscores (_), hyphens (-), and dollar signs ($). Example: `frontend-fleet` */ readonly resourceGroup: string; /** * 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: string; /** * The perceived type of response required when the alarm is in the "FIRING" state. Example: `CRITICAL` */ readonly severity: string; /** * The current lifecycle state of the alarm. Example: `DELETED` */ readonly state: string; /** * The configuration details for suppressing an alarm. */ readonly suppressions: outputs.Monitoring.GetAlarmSuppression[]; /** * The date and time the alarm was created. Format defined by RFC3339. Example: `2023-02-01T01:02:29.600Z` */ readonly timeCreated: string; /** * The date and time the alarm was last updated. Format defined by RFC3339. Example: `2023-02-03T01:02:29.600Z` */ readonly timeUpdated: string; } /** * This data source provides details about a specific Alarm resource in Oracle Cloud Infrastructure Monitoring service. * * Gets the specified alarm. * For more information, see * [Getting an Alarm](https://docs.cloud.oracle.com/iaas/Content/Monitoring/Tasks/get-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 = oci.monitoring.getAlarm({ * alarmId: testAlarmOciMonitoringAlarm.id, * }); * ``` */ export declare function getAlarmOutput(args: GetAlarmOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getAlarm. */ export interface GetAlarmOutputArgs { /** * The [OCID](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of an alarm. */ alarmId: pulumi.Input; } //# sourceMappingURL=getAlarm.d.ts.map