AlarmStatusWidget

class aws_cdk.aws_cloudwatch.AlarmStatusWidget(*, alarms, height=None, sort_by=None, states=None, title=None, width=None)

Bases: aws_cdk.aws_cloudwatch.ConcreteWidget

A dashboard widget that displays alarms in a grid view.

ExampleMetadata

infused

Example:

# dashboard: cloudwatch.Dashboard
# error_alarm: cloudwatch.Alarm


dashboard.add_widgets(
    cloudwatch.AlarmStatusWidget(
        alarms=[error_alarm]
    ))
Parameters
  • alarms (Sequence[IAlarm]) – CloudWatch Alarms to show in widget.

  • height (Union[int, float, None]) – Height of the widget. Default: 3

  • sort_by (Optional[AlarmStatusWidgetSortBy]) – Specifies how to sort the alarms in the widget. Default: - alphabetical order

  • states (Optional[Sequence[AlarmState]]) – Use this field to filter the list of alarms displayed in the widget to only those alarms currently in the specified states. 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 (Optional[str]) – The title of the widget. Default: ‘Alarm Status’

  • width (Union[int, float, None]) – Width of the widget, in a grid of 24 units wide. Default: 6

Methods

position(x, y)

Place the widget at a given position.

Parameters
  • x (Union[int, float]) –

  • y (Union[int, float]) –

Return type

None

to_json()

Return the widget JSON for use in the dashboard.

Return type

List[Any]

Attributes

height

The amount of vertical grid units the widget will take up.

Return type

Union[int, float]

warnings

Any warnings that are produced as a result of putting together this widget.

Return type

Optional[List[str]]

width

The amount of horizontal grid units the widget will take up.

Return type

Union[int, float]