Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data CompositeAlarm = CompositeAlarm' {
- actionsEnabled :: Maybe Bool
- actionsSuppressedBy :: Maybe ActionsSuppressedBy
- actionsSuppressedReason :: Maybe Text
- actionsSuppressor :: Maybe Text
- actionsSuppressorExtensionPeriod :: Maybe Int
- actionsSuppressorWaitPeriod :: Maybe Int
- alarmActions :: Maybe [Text]
- alarmArn :: Maybe Text
- alarmConfigurationUpdatedTimestamp :: Maybe ISO8601
- alarmDescription :: Maybe Text
- alarmName :: Maybe Text
- alarmRule :: Maybe Text
- insufficientDataActions :: Maybe [Text]
- oKActions :: Maybe [Text]
- stateReason :: Maybe Text
- stateReasonData :: Maybe Text
- stateTransitionedTimestamp :: Maybe ISO8601
- stateUpdatedTimestamp :: Maybe ISO8601
- stateValue :: Maybe StateValue
- newCompositeAlarm :: CompositeAlarm
- compositeAlarm_actionsEnabled :: Lens' CompositeAlarm (Maybe Bool)
- compositeAlarm_actionsSuppressedBy :: Lens' CompositeAlarm (Maybe ActionsSuppressedBy)
- compositeAlarm_actionsSuppressedReason :: Lens' CompositeAlarm (Maybe Text)
- compositeAlarm_actionsSuppressor :: Lens' CompositeAlarm (Maybe Text)
- compositeAlarm_actionsSuppressorExtensionPeriod :: Lens' CompositeAlarm (Maybe Int)
- compositeAlarm_actionsSuppressorWaitPeriod :: Lens' CompositeAlarm (Maybe Int)
- compositeAlarm_alarmActions :: Lens' CompositeAlarm (Maybe [Text])
- compositeAlarm_alarmArn :: Lens' CompositeAlarm (Maybe Text)
- compositeAlarm_alarmConfigurationUpdatedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime)
- compositeAlarm_alarmDescription :: Lens' CompositeAlarm (Maybe Text)
- compositeAlarm_alarmName :: Lens' CompositeAlarm (Maybe Text)
- compositeAlarm_alarmRule :: Lens' CompositeAlarm (Maybe Text)
- compositeAlarm_insufficientDataActions :: Lens' CompositeAlarm (Maybe [Text])
- compositeAlarm_oKActions :: Lens' CompositeAlarm (Maybe [Text])
- compositeAlarm_stateReason :: Lens' CompositeAlarm (Maybe Text)
- compositeAlarm_stateReasonData :: Lens' CompositeAlarm (Maybe Text)
- compositeAlarm_stateTransitionedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime)
- compositeAlarm_stateUpdatedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime)
- compositeAlarm_stateValue :: Lens' CompositeAlarm (Maybe StateValue)
Documentation
data CompositeAlarm Source #
The details about a composite alarm.
See: newCompositeAlarm
smart constructor.
CompositeAlarm' | |
|
Instances
newCompositeAlarm :: CompositeAlarm Source #
Create a value of CompositeAlarm
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:actionsEnabled:CompositeAlarm'
, compositeAlarm_actionsEnabled
- Indicates whether actions should be executed during any changes to the
alarm state.
$sel:actionsSuppressedBy:CompositeAlarm'
, compositeAlarm_actionsSuppressedBy
- 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.
$sel:actionsSuppressedReason:CompositeAlarm'
, compositeAlarm_actionsSuppressedReason
- Captures the reason for action suppression.
$sel:actionsSuppressor:CompositeAlarm'
, compositeAlarm_actionsSuppressor
- 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.
$sel:actionsSuppressorExtensionPeriod:CompositeAlarm'
, compositeAlarm_actionsSuppressorExtensionPeriod
- 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.
ExtensionPeriod
is required only when ActionsSuppressor
is
specified.
$sel:actionsSuppressorWaitPeriod:CompositeAlarm'
, compositeAlarm_actionsSuppressorWaitPeriod
- 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.
WaitPeriod
is required only when ActionsSuppressor
is specified.
$sel:alarmActions:CompositeAlarm'
, compositeAlarm_alarmActions
- 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).
$sel:alarmArn:CompositeAlarm'
, compositeAlarm_alarmArn
- The Amazon Resource Name (ARN) of the alarm.
$sel:alarmConfigurationUpdatedTimestamp:CompositeAlarm'
, compositeAlarm_alarmConfigurationUpdatedTimestamp
- The time stamp of the last update to the alarm configuration.
$sel:alarmDescription:CompositeAlarm'
, compositeAlarm_alarmDescription
- The description of the alarm.
$sel:alarmName:CompositeAlarm'
, compositeAlarm_alarmName
- The name of the alarm.
$sel:alarmRule:CompositeAlarm'
, compositeAlarm_alarmRule
- The rule that this alarm uses to evaluate its alarm state.
$sel:insufficientDataActions:CompositeAlarm'
, compositeAlarm_insufficientDataActions
- 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).
$sel:oKActions:CompositeAlarm'
, compositeAlarm_oKActions
- 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).
$sel:stateReason:CompositeAlarm'
, compositeAlarm_stateReason
- An explanation for the alarm state, in text format.
$sel:stateReasonData:CompositeAlarm'
, compositeAlarm_stateReasonData
- An explanation for the alarm state, in JSON format.
$sel:stateTransitionedTimestamp:CompositeAlarm'
, compositeAlarm_stateTransitionedTimestamp
- The timestamp of the last change to the alarm's StateValue
.
$sel:stateUpdatedTimestamp:CompositeAlarm'
, compositeAlarm_stateUpdatedTimestamp
- Tracks the timestamp of any state update, even if StateValue
doesn't
change.
$sel:stateValue:CompositeAlarm'
, compositeAlarm_stateValue
- The state value for the alarm.
compositeAlarm_actionsEnabled :: Lens' CompositeAlarm (Maybe Bool) Source #
Indicates whether actions should be executed during any changes to the alarm state.
compositeAlarm_actionsSuppressedBy :: Lens' CompositeAlarm (Maybe ActionsSuppressedBy) Source #
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.
compositeAlarm_actionsSuppressedReason :: Lens' CompositeAlarm (Maybe Text) Source #
Captures the reason for action suppression.
compositeAlarm_actionsSuppressor :: Lens' CompositeAlarm (Maybe Text) Source #
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.
compositeAlarm_actionsSuppressorExtensionPeriod :: Lens' CompositeAlarm (Maybe Int) Source #
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.
ExtensionPeriod
is required only when ActionsSuppressor
is
specified.
compositeAlarm_actionsSuppressorWaitPeriod :: Lens' CompositeAlarm (Maybe Int) Source #
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.
WaitPeriod
is required only when ActionsSuppressor
is specified.
compositeAlarm_alarmActions :: Lens' CompositeAlarm (Maybe [Text]) Source #
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).
compositeAlarm_alarmArn :: Lens' CompositeAlarm (Maybe Text) Source #
The Amazon Resource Name (ARN) of the alarm.
compositeAlarm_alarmConfigurationUpdatedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime) Source #
The time stamp of the last update to the alarm configuration.
compositeAlarm_alarmDescription :: Lens' CompositeAlarm (Maybe Text) Source #
The description of the alarm.
compositeAlarm_alarmName :: Lens' CompositeAlarm (Maybe Text) Source #
The name of the alarm.
compositeAlarm_alarmRule :: Lens' CompositeAlarm (Maybe Text) Source #
The rule that this alarm uses to evaluate its alarm state.
compositeAlarm_insufficientDataActions :: Lens' CompositeAlarm (Maybe [Text]) Source #
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).
compositeAlarm_oKActions :: Lens' CompositeAlarm (Maybe [Text]) Source #
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).
compositeAlarm_stateReason :: Lens' CompositeAlarm (Maybe Text) Source #
An explanation for the alarm state, in text format.
compositeAlarm_stateReasonData :: Lens' CompositeAlarm (Maybe Text) Source #
An explanation for the alarm state, in JSON format.
compositeAlarm_stateTransitionedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime) Source #
The timestamp of the last change to the alarm's StateValue
.
compositeAlarm_stateUpdatedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime) Source #
Tracks the timestamp of any state update, even if StateValue
doesn't
change.
compositeAlarm_stateValue :: Lens' CompositeAlarm (Maybe StateValue) Source #
The state value for the alarm.