Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudWatch.Types.CompositeAlarm

Description

Synopsis

data CompositeAlarm = CompositeAlarm' {
- alarmName :: Maybe Text
- stateUpdatedTimestamp :: Maybe ISO8601
- alarmDescription :: Maybe Text
- alarmRule :: Maybe Text
- oKActions :: Maybe [Text]
- stateValue :: Maybe StateValue
- alarmConfigurationUpdatedTimestamp :: Maybe ISO8601
- actionsEnabled :: Maybe Bool
- insufficientDataActions :: Maybe [Text]
- stateReason :: Maybe Text
- stateReasonData :: Maybe Text
- alarmArn :: Maybe Text
- alarmActions :: Maybe [Text]
}
newCompositeAlarm :: CompositeAlarm
compositeAlarm_alarmName :: Lens' CompositeAlarm (Maybe Text)
compositeAlarm_stateUpdatedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime)
compositeAlarm_alarmDescription :: Lens' CompositeAlarm (Maybe Text)
compositeAlarm_alarmRule :: Lens' CompositeAlarm (Maybe Text)
compositeAlarm_oKActions :: Lens' CompositeAlarm (Maybe [Text])
compositeAlarm_stateValue :: Lens' CompositeAlarm (Maybe StateValue)
compositeAlarm_alarmConfigurationUpdatedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime)
compositeAlarm_actionsEnabled :: Lens' CompositeAlarm (Maybe Bool)
compositeAlarm_insufficientDataActions :: Lens' CompositeAlarm (Maybe [Text])
compositeAlarm_stateReason :: Lens' CompositeAlarm (Maybe Text)
compositeAlarm_stateReasonData :: Lens' CompositeAlarm (Maybe Text)
compositeAlarm_alarmArn :: Lens' CompositeAlarm (Maybe Text)
compositeAlarm_alarmActions :: Lens' CompositeAlarm (Maybe [Text])

Documentation

data CompositeAlarm Source #

The details about a composite alarm.

See: newCompositeAlarm smart constructor.

Constructors

CompositeAlarm'

Fields

alarmName :: Maybe Text
The name of the alarm.
stateUpdatedTimestamp :: Maybe ISO8601
The time stamp of the last update to the alarm state.
alarmDescription :: Maybe Text
The description of the alarm.
alarmRule :: Maybe Text
The rule that this alarm uses to evaluate its alarm state.
oKActions :: Maybe [Text]
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).
stateValue :: Maybe StateValue
The state value for the alarm.
alarmConfigurationUpdatedTimestamp :: Maybe ISO8601
The time stamp of the last update to the alarm configuration.
actionsEnabled :: Maybe Bool
Indicates whether actions should be executed during any changes to the alarm state.
insufficientDataActions :: Maybe [Text]
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).
stateReason :: Maybe Text
An explanation for the alarm state, in text format.
stateReasonData :: Maybe Text
An explanation for the alarm state, in JSON format.
alarmArn :: Maybe Text
The Amazon Resource Name (ARN) of the alarm.
alarmActions :: Maybe [Text]
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).

Instances

Instances details

Eq CompositeAlarm Source #
Instance details Defined in Amazonka.CloudWatch.Types.CompositeAlarm Methods (==) :: CompositeAlarm -> CompositeAlarm -> Bool # (/=) :: CompositeAlarm -> CompositeAlarm -> Bool #
Read CompositeAlarm Source #
Instance details Defined in Amazonka.CloudWatch.Types.CompositeAlarm Methods readsPrec :: Int -> ReadS CompositeAlarm # readList :: ReadS [CompositeAlarm] # readPrec :: ReadPrec CompositeAlarm # readListPrec :: ReadPrec [CompositeAlarm] #
Show CompositeAlarm Source #
Instance details Defined in Amazonka.CloudWatch.Types.CompositeAlarm Methods showsPrec :: Int -> CompositeAlarm -> ShowS # show :: CompositeAlarm -> String # showList :: [CompositeAlarm] -> ShowS #
Generic CompositeAlarm Source #
Instance details Defined in Amazonka.CloudWatch.Types.CompositeAlarm Associated Types type Rep CompositeAlarm :: Type -> Type # Methods from :: CompositeAlarm -> Rep CompositeAlarm x # to :: Rep CompositeAlarm x -> CompositeAlarm #
NFData CompositeAlarm Source #
Instance details Defined in Amazonka.CloudWatch.Types.CompositeAlarm Methods rnf :: CompositeAlarm -> () #
Hashable CompositeAlarm Source #
Instance details Defined in Amazonka.CloudWatch.Types.CompositeAlarm Methods hashWithSalt :: Int -> CompositeAlarm -> Int # hash :: CompositeAlarm -> Int #
FromXML CompositeAlarm Source #
Instance details Defined in Amazonka.CloudWatch.Types.CompositeAlarm Methods parseXML :: [Node] -> Either String CompositeAlarm #
type Rep CompositeAlarm Source #
Instance details Defined in Amazonka.CloudWatch.Types.CompositeAlarm type Rep CompositeAlarm = D1 ('MetaData "CompositeAlarm" "Amazonka.CloudWatch.Types.CompositeAlarm" "libZSservicesZSamazonka-cloudwatchZSamazonka-cloudwatch" 'False) (C1 ('MetaCons "CompositeAlarm'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "alarmName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "stateUpdatedTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "alarmDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "alarmRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "oKActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "stateValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StateValue))))) :: ((S1 ('MetaSel ('Just "alarmConfigurationUpdatedTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: (S1 ('MetaSel ('Just "actionsEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "insufficientDataActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "stateReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "stateReasonData") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "alarmArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "alarmActions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))))))

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:alarmName:CompositeAlarm', compositeAlarm_alarmName - The name of the alarm.

$sel:stateUpdatedTimestamp:CompositeAlarm', compositeAlarm_stateUpdatedTimestamp - The time stamp of the last update to the alarm state.

$sel:alarmDescription:CompositeAlarm', compositeAlarm_alarmDescription - The description of the alarm.

$sel:alarmRule:CompositeAlarm', compositeAlarm_alarmRule - The rule that this alarm uses to evaluate its alarm state.

$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:stateValue:CompositeAlarm', compositeAlarm_stateValue - The state value for the alarm.

$sel:alarmConfigurationUpdatedTimestamp:CompositeAlarm', compositeAlarm_alarmConfigurationUpdatedTimestamp - The time stamp of the last update to the alarm configuration.

$sel:actionsEnabled:CompositeAlarm', compositeAlarm_actionsEnabled - Indicates whether actions should be executed during any changes to the 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: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:alarmArn:CompositeAlarm', compositeAlarm_alarmArn - The Amazon Resource Name (ARN) of the alarm.

$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).

compositeAlarm_alarmName :: Lens' CompositeAlarm (Maybe Text) Source #

The name of the alarm.

compositeAlarm_stateUpdatedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime) Source #

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

compositeAlarm_alarmDescription :: Lens' CompositeAlarm (Maybe Text) Source #

The description of the alarm.

compositeAlarm_alarmRule :: Lens' CompositeAlarm (Maybe Text) Source #

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

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_stateValue :: Lens' CompositeAlarm (Maybe StateValue) Source #

The state value for the alarm.

compositeAlarm_alarmConfigurationUpdatedTimestamp :: Lens' CompositeAlarm (Maybe UTCTime) Source #

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

compositeAlarm_actionsEnabled :: Lens' CompositeAlarm (Maybe Bool) Source #

Indicates whether actions should be executed during any changes to the 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_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_alarmArn :: Lens' CompositeAlarm (Maybe Text) Source #

The Amazon Resource Name (ARN) of the alarm.

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).