Data Source: oci_monitoring_alarm_suppression

This data source provides details about a specific Alarm Suppression resource in Oracle Cloud Infrastructure Monitoring service.

Gets the specified alarm suppression. For more information, see Getting an Alarm-wide Suppression.

For important limits information, see Limits on Monitoring.

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

data "oci_monitoring_alarm_suppression" "test_alarm_suppression" {
	#Required
	alarm_suppression_id = oci_monitoring_alarm_suppression.test_alarm_suppression.id
}

Argument Reference

The following arguments are supported:

• alarm_suppression_id - (Required) The OCID of the alarm suppression.

Attributes Reference

The following attributes are exported:

• alarm_suppression_target - The target of the alarm suppression.

  • alarm_id - The OCID of the alarm that is the target of the alarm suppression.
  • compartment_id - The OCID of the compartment or tenancy that is the target of the alarm suppression. Example: ocid1.compartment.oc1..exampleuniqueID
  • compartment_id_in_subtree - When true, the alarm suppression targets all alarms under all compartments and subcompartments of the tenancy specified. The parameter can only be set to true when compartmentId is the tenancy OCID (the tenancy is the root compartment). When false, the alarm suppression targets only the alarms under the specified compartment.
  • target_type - The type of the alarm suppression target.

• compartment_id - The OCID of the compartment containing the alarm suppression.

• defined_tags - Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {"Operations.CostCenter": "42"}

• description - Human-readable reason for this alarm suppression. It does not have to be unique, and it’s changeable. Avoid entering confidential information.

  Oracle recommends including tracking information for the event or associated work, such as a ticket number.

  Example: Planned outage due to change IT-1234.

• dimensions - Configured dimension filter for suppressing alarm state entries that include the set of specified dimension key-value pairs. Example: {"resourceId": "instance.region1.phx.exampleuniqueID"}

• display_name - A user-friendly name for the alarm suppression. It does not have to be unique, and it’s changeable. Avoid entering confidential information.

• freeform_tags - Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {"Department": "Finance"}

• id - The OCID of the alarm suppression.

• level - The level of this alarm suppression. ALARM indicates a suppression of the entire alarm, regardless of dimension. DIMENSION indicates a suppression configured for specified dimensions.

• state - The current lifecycle state of the alarm suppression. Example: DELETED

• suppression_conditions - Array of all preconditions for alarm suppression. Example: [{ conditionType: "RECURRENCE", suppressionRecurrence: "FRQ=DAILY;BYHOUR=10", suppressionDuration: "PT1H" }]

  • condition_type - Type of suppression condition.
  • suppression_duration - Duration of the recurring suppression. Specified as a string in ISO 8601 format. Minimum: PT1M (1 minute). Maximum: PT24H (24 hours).
  • suppression_recurrence - Frequency and start time of the recurring suppression. The format follows the iCalendar specification (RFC 5545, section 3.3.10). Supported rule parts:
    • FREQ: Frequency of the recurring suppression: WEEKLY or DAILY only.
    • BYDAY: Comma separated days. Use with weekly suppressions only. Supported values: MO, TU, WE, TH, FR, SA ,SU.
    • BYHOUR, BYMINUTE, BYSECOND: Start time in UTC, after timeSuppressFrom value. Default is 00:00:00 UTC after timeSuppressFrom.

• time_created - The date and time the alarm suppression was created. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z

• time_suppress_from - The start date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T01:02:29.600Z

• time_suppress_until - The end date and time for the suppression to take place, inclusive. Format defined by RFC3339. Example: 2018-02-01T02:02:29.600Z

• time_updated - The date and time the alarm suppression was last updated (deleted). Format defined by RFC3339. Example: 2018-02-03T01:02:29.600Z