Class CfnCompositeAlarmProps
Properties for defining a CfnCompositeAlarm.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCompositeAlarmProps : Object, ICfnCompositeAlarmPropsSyntax (vb)
Public Class CfnCompositeAlarmProps
Inherits Object
Implements ICfnCompositeAlarmPropsRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudWatch;
var cfnCompositeAlarmProps = new CfnCompositeAlarmProps {
AlarmRule = "alarmRule",
// the properties below are optional
ActionsEnabled = false,
ActionsSuppressor = "actionsSuppressor",
ActionsSuppressorExtensionPeriod = 123,
ActionsSuppressorWaitPeriod = 123,
AlarmActions = new [] { "alarmActions" },
AlarmDescription = "alarmDescription",
AlarmName = "alarmName",
InsufficientDataActions = new [] { "insufficientDataActions" },
OkActions = new [] { "okActions" },
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};Synopsis
Constructors
| Cfn |
Properties
| Actions |
Indicates whether actions should be executed during any changes to the alarm state of the composite alarm. |
| Actions |
Actions will be suppressed if the suppressor alarm is in the |
| Actions |
The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the |
| Actions |
The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the |
| Alarm |
The actions to execute when this alarm transitions to the ALARM state from any other state. |
| Alarm |
The description for the composite alarm. |
| Alarm |
The name for the composite alarm. |
| Alarm |
An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state. |
| Insufficient |
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state. |
| Ok |
The actions to execute when this alarm transitions to the OK state from any other state. |
| Tags | A list of key-value pairs to associate with the alarm. |
Constructors
CfnCompositeAlarmProps()
public CfnCompositeAlarmProps()Properties
ActionsEnabled
Indicates whether actions should be executed during any changes to the alarm state of the composite alarm.
public object ActionsEnabled { get; set; }Property Value
System.
Remarks
ActionsSuppressor
Actions will be suppressed if the suppressor alarm is in the ALARM state.
public string ActionsSuppressor { get; set; }Property Value
System.
Remarks
ActionsSuppressor can be an AlarmName or an Amazon Resource Name (ARN) from an existing alarm.
ActionsSuppressorExtensionPeriod
The maximum time in seconds that the composite alarm waits after suppressor alarm goes out of the ALARM state.
public Nullable<double> ActionsSuppressorExtensionPeriod { get; set; }Property Value
System.
Remarks
After this time, the composite alarm performs its actions.
ExtensionPeriod is required only when ActionsSuppressor is specified.
ActionsSuppressorWaitPeriod
The maximum time in seconds that the composite alarm waits for the suppressor alarm to go into the ALARM state.
public Nullable<double> ActionsSuppressorWaitPeriod { get; set; }Property Value
System.
Remarks
After this time, the composite alarm performs its actions.
WaitPeriod is required only when ActionsSuppressor is specified.
AlarmActions
The actions to execute when this alarm transitions to the ALARM state from any other state.
public string[] AlarmActions { get; set; }Property Value
System.
Remarks
Each action is specified as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see PutCompositeAlarm in the Amazon CloudWatch API Reference .
AlarmDescription
The description for the composite alarm.
public string AlarmDescription { get; set; }Property Value
System.
Remarks
AlarmName
The name for the composite alarm.
public string AlarmName { get; set; }Property Value
System.
Remarks
This name must be unique within your AWS account.
AlarmRule
An expression that specifies which other alarms are to be evaluated to determine this composite alarm's state.
public string AlarmRule { get; set; }Property Value
System.
Remarks
For each alarm that you reference, you designate a function that specifies whether that alarm needs to be in ALARM state, OK state, or INSUFFICIENT_DATA state. You can use operators (AND, OR and NOT) to combine multiple functions in a single expression. You can use parenthesis to logically group the functions in your expression.
You can use either alarm names or ARNs to reference the other alarms that are to be evaluated.
Functions can include the following:
TRUE and FALSE are useful for testing a complex AlarmRule structure, and for testing your alarm actions.
For more information about AlarmRule syntax, see PutCompositeAlarm in the Amazon CloudWatch API Reference .
InsufficientDataActions
The actions to execute when this alarm transitions to the INSUFFICIENT_DATA state from any other state.
public string[] InsufficientDataActions { get; set; }Property Value
System.
Remarks
Each action is specified as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see PutCompositeAlarm in the Amazon CloudWatch API Reference .
OkActions
The actions to execute when this alarm transitions to the OK state from any other state.
public string[] OkActions { get; set; }Property Value
System.
Remarks
Each action is specified as an Amazon Resource Name (ARN). For more information about creating alarms and the actions that you can specify, see PutCompositeAlarm in the Amazon CloudWatch API Reference .
Tags
A list of key-value pairs to associate with the alarm.
public ICfnTag[] Tags { get; set; }Property Value
ICfn
Remarks
You can associate as many as 50 tags with an alarm. To be able to associate tags with the alarm when you create the alarm, you must have the cloudwatch:TagResource permission.
Tags can help you organize and categorize your resources. You can also use them to scope user permissions by granting a user permission to access or change only resources with certain tag values.