CreateAlarmSuppressionDetails

class oci.monitoring.models.CreateAlarmSuppressionDetails(**kwargs)

Bases: object

The configuration details for creating an alarm suppression.

Methods:

__init__(**kwargs)

Initializes a new CreateAlarmSuppressionDetails object with values from keyword arguments.

Attributes:

alarm_suppression_target

[Required] Gets the alarm_suppression_target of this CreateAlarmSuppressionDetails.

defined_tags

Gets the defined_tags of this CreateAlarmSuppressionDetails.

description

Gets the description of this CreateAlarmSuppressionDetails.

dimensions

Gets the dimensions of this CreateAlarmSuppressionDetails.

display_name

[Required] Gets the display_name of this CreateAlarmSuppressionDetails.

freeform_tags

Gets the freeform_tags of this CreateAlarmSuppressionDetails.

level

Gets the level of this CreateAlarmSuppressionDetails.

suppression_conditions

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

time_suppress_from

[Required] Gets the time_suppress_from of this CreateAlarmSuppressionDetails.

time_suppress_until

[Required] Gets the time_suppress_until of this CreateAlarmSuppressionDetails.

__init__(**kwargs)

Initializes a new CreateAlarmSuppressionDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • alarm_suppression_target (oci.monitoring.models.AlarmSuppressionTarget) – The value to assign to the alarm_suppression_target property of this CreateAlarmSuppressionDetails.

  • level (str) – The value to assign to the level property of this CreateAlarmSuppressionDetails.

  • display_name (str) – The value to assign to the display_name property of this CreateAlarmSuppressionDetails.

  • description (str) – The value to assign to the description property of this CreateAlarmSuppressionDetails.

  • dimensions (dict(str, str)) – The value to assign to the dimensions property of this CreateAlarmSuppressionDetails.

  • time_suppress_from (datetime) – The value to assign to the time_suppress_from property of this CreateAlarmSuppressionDetails.

  • time_suppress_until (datetime) – The value to assign to the time_suppress_until property of this CreateAlarmSuppressionDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateAlarmSuppressionDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateAlarmSuppressionDetails.

  • suppression_conditions (list[oci.monitoring.models.SuppressionCondition]) – The value to assign to the suppression_conditions property of this CreateAlarmSuppressionDetails.

property alarm_suppression_target

[Required] Gets the alarm_suppression_target of this CreateAlarmSuppressionDetails.

Returns

The alarm_suppression_target of this CreateAlarmSuppressionDetails.

Return type

oci.monitoring.models.AlarmSuppressionTarget

property defined_tags

Gets the defined_tags of this CreateAlarmSuppressionDetails. Usage of predefined tag keys. These predefined keys are scoped to namespaces. Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this CreateAlarmSuppressionDetails.

Return type

dict(str, dict(str, object))

property description

Gets the description of this CreateAlarmSuppressionDetails. 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.

Returns

The description of this CreateAlarmSuppressionDetails.

Return type

str

property dimensions

Gets the dimensions of this CreateAlarmSuppressionDetails. A filter to suppress only alarm state entries that include the set of specified dimension key-value pairs. If you specify {“availabilityDomain”: “phx-ad-1”} and the alarm state entry corresponds to the set {“availabilityDomain”: “phx-ad-1” and “resourceId”: “ocid1.instance.region1.phx.exampleuniqueID”}, then this alarm will be included for suppression.

This is required only when the value of level is DIMENSION. If required, the value cannot be an empty object. Only a single value is allowed per key. No grouping of multiple values is allowed under the same key. Maximum characters (after serialization): 4000. This maximum satisfies typical use cases. The response for an exceeded maximum is HTTP 400 with an “dimensions values are too long” message.

Returns

The dimensions of this CreateAlarmSuppressionDetails.

Return type

dict(str, str)

property display_name

[Required] Gets the display_name of this CreateAlarmSuppressionDetails. A user-friendly name for the alarm suppression. It does not have to be unique, and it’s changeable. Avoid entering confidential information.

Returns

The display_name of this CreateAlarmSuppressionDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateAlarmSuppressionDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“Department”: “Finance”}

Returns

The freeform_tags of this CreateAlarmSuppressionDetails.

Return type

dict(str, str)

property level

Gets the level of this CreateAlarmSuppressionDetails. 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.

Defaut: DIMENSION

Returns

The level of this CreateAlarmSuppressionDetails.

Return type

str

property suppression_conditions

Gets the suppression_conditions of this CreateAlarmSuppressionDetails. Array of all preconditions for alarm suppression. Example: `[{

conditionType: “RECURRENCE”, suppressionRecurrence: “FRQ=DAILY;BYHOUR=10”, suppressionDuration: “PT1H”

}]`

Returns

The suppression_conditions of this CreateAlarmSuppressionDetails.

Return type

list[oci.monitoring.models.SuppressionCondition]

property time_suppress_from

[Required] Gets the time_suppress_from of this CreateAlarmSuppressionDetails. The start date and time for the suppression to take place, inclusive. Format defined by RFC3339.

Example: 2023-02-01T01:02:29.600Z

Returns

The time_suppress_from of this CreateAlarmSuppressionDetails.

Return type

datetime

property time_suppress_until

[Required] Gets the time_suppress_until of this CreateAlarmSuppressionDetails. The end date and time for the suppression to take place, inclusive. Format defined by RFC3339.

Example: 2023-02-01T02:02:29.600Z

Returns

The time_suppress_until of this CreateAlarmSuppressionDetails.

Return type

datetime