CompositeAlarm
The details about a composite alarm.
Contents
- ActionsEnabled
-
Indicates whether actions should be executed during any changes to the alarm state.
Type: Boolean
Required: No
- AlarmActions.member.N
-
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).
Type: Array of strings
Array Members: Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- AlarmArn
-
The Amazon Resource Name (ARN) of the alarm.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1600.
Required: No
- AlarmConfigurationUpdatedTimestamp
-
The time stamp of the last update to the alarm configuration.
Type: Timestamp
Required: No
- AlarmDescription
-
The description of the alarm.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
Required: No
- AlarmName
-
The name of the alarm.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No
- AlarmRule
-
The rule that this alarm uses to evaluate its alarm state.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 10240.
Required: No
- InsufficientDataActions.member.N
-
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).
Type: Array of strings
Array Members: Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- OKActions.member.N
-
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).
Type: Array of strings
Array Members: Maximum number of 5 items.
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- StateReason
-
An explanation for the alarm state, in text format.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1023.
Required: No
- StateReasonData
-
An explanation for the alarm state, in JSON format.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 4000.
Required: No
- StateUpdatedTimestamp
-
The time stamp of the last update to the alarm state.
Type: Timestamp
Required: No
- StateValue
-
The state value for the alarm.
Type: String
Valid Values:
OK | ALARM | INSUFFICIENT_DATARequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
