Interface IAlarmStatusWidgetProps

Properties for an Alarm Status Widget.

Namespace: Amazon.CDK.AWS.CloudWatch

Assembly: Amazon.CDK.AWS.CloudWatch.dll

Syntax (csharp)

public interface IAlarmStatusWidgetProps

Syntax (vb)

Public Interface IAlarmStatusWidgetProps

Remarks

ExampleMetadata: infused

Examples

Dashboard dashboard;
Alarm errorAlarm;


dashboard.AddWidgets(
new AlarmStatusWidget(new AlarmStatusWidgetProps {
    Alarms = new [] { errorAlarm }
}));

Synopsis

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.

Properties

Alarms

CloudWatch Alarms to show in widget.

IAlarm[] Alarms { get; }

Property Value

IAlarm[]

Height

Height of the widget.

virtual Nullable<double> Height { get; }

Property Value

System.Nullable<System.Double>

Remarks

Default: 3

SortBy

Specifies how to sort the alarms in the widget.

virtual Nullable<AlarmStatusWidgetSortBy> SortBy { get; }

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.

virtual AlarmState[] States { get; }

Property Value

AlarmState[]

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.

virtual string Title { get; }

Property Value

System.String

Remarks

Default: 'Alarm Status'

Width

Width of the widget, in a grid of 24 units wide.

virtual Nullable<double> Width { get; }

Property Value

System.Nullable<System.Double>

Remarks

Default: 6