Class AlarmStatusWidgetProps
Properties for an Alarm Status Widget.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class AlarmStatusWidgetProps : Object, IAlarmStatusWidgetProps
Syntax (vb)
Public Class AlarmStatusWidgetProps
Inherits Object
Implements IAlarmStatusWidgetProps
Remarks
ExampleMetadata: infused
Examples
Dashboard dashboard;
Alarm errorAlarm;
dashboard.AddWidgets(
new AlarmStatusWidget(new AlarmStatusWidgetProps {
Alarms = new [] { errorAlarm }
}));
Synopsis
Constructors
AlarmStatusWidgetProps() |
Properties
Alarms | CloudWatch Alarms to show in widget. |
Height | Height of the widget. |
SortBy | Specifies how to sort the alarms in the widget. |
States | Use this field to filter the list of alarms displayed in the widget to only those alarms currently in the specified states. |
Title | The title of the widget. |
Width | Width of the widget, in a grid of 24 units wide. |
Constructors
AlarmStatusWidgetProps()
public AlarmStatusWidgetProps()
Properties
Alarms
Height
Height of the widget.
public Nullable<double> Height { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 3
SortBy
Specifies how to sort the alarms in the widget.
public Nullable<AlarmStatusWidgetSortBy> SortBy { get; set; }
Property Value
System.Nullable<AlarmStatusWidgetSortBy>
Remarks
Default: - alphabetical order
States
Use this field to filter the list of alarms displayed in the widget to only those alarms currently in the specified states.
public AlarmState[] States { get; set; }
Property Value
Remarks
You can specify one or more alarm states in the value for this field. The alarm states that you can specify are ALARM, INSUFFICIENT_DATA, and OK.
If you omit this field or specify an empty array, all the alarms specifed in alarms are displayed.
Default: - all the alarms specified in alarms are displayed.
Title
The title of the widget.
public string Title { get; set; }
Property Value
System.String
Remarks
Default: 'Alarm Status'
Width
Width of the widget, in a grid of 24 units wide.
public Nullable<double> Width { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 6