CompositeAlarm

The details about a composite alarm.

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Indicates whether actions should be executed during any changes to the alarm state.

Link copied to clipboard

When the value is ALARM, it means that the actions are suppressed because the suppressor alarm is in ALARM When the value is WaitPeriod, it means that the actions are suppressed because the composite alarm is waiting for the suppressor alarm to go into into the ALARM state. The maximum waiting time is as specified in ActionsSuppressorWaitPeriod. After this time, the composite alarm performs its actions. When the value is ExtensionPeriod, it means that the actions are suppressed because the composite alarm is waiting after the suppressor alarm went out of the ALARM state. The maximum waiting time is as specified in ActionsSuppressorExtensionPeriod. After this time, the composite alarm performs its actions.

Link copied to clipboard

Captures the reason for action suppression.

Link copied to clipboard

Actions will be suppressed if the suppressor alarm is in the ALARM state. ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.

Link copied to clipboard

The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state. After this time, the composite alarm performs its actions.

Link copied to clipboard

The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM state. After this time, the composite alarm performs its actions.

Link copied to clipboard

The actions to execute when this alarm transitions to the ALARM state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Link copied to clipboard

The Amazon Resource Name (ARN) of the alarm.

Link copied to clipboard

The time stamp of the last update to the alarm configuration.

Link copied to clipboard

The description of the alarm.

Link copied to clipboard

The name of the alarm.

Link copied to clipboard

The rule that this alarm uses to evaluate its alarm state.

Link copied to clipboard

The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Link copied to clipboard

The actions to execute when this alarm transitions to the OK state from any other state. Each action is specified as an Amazon Resource Name (ARN).

Link copied to clipboard

An explanation for the alarm state, in text format.

Link copied to clipboard

An explanation for the alarm state, in JSON format.

Link copied to clipboard

The timestamp of the last change to the alarm's StateValue.

Link copied to clipboard

Tracks the timestamp of any state update, even if StateValue doesn't change.

Link copied to clipboard

The state value for the alarm.

Functions

Link copied to clipboard
inline fun copy(block: CompositeAlarm.Builder.() -> Unit = {}): CompositeAlarm
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String