AlarmStatusWidgetProps¶

class aws_cdk.aws_cloudwatch.AlarmStatusWidgetProps(*, alarms, height=None, title=None, width=None)¶

Bases: object

Properties for an Alarm Status Widget.

Parameters

alarms (Sequence[IAlarm]) – CloudWatch Alarms to show in widget.
height (Union[int, float, None]) – Height of the widget. Default: 3
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

ExampleMetadata

infused

Example:

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


dashboard.add_widgets(
    cloudwatch.AlarmStatusWidget(
        alarms=[error_alarm]
    ))

Attributes

alarms¶

CloudWatch Alarms to show in widget.

Return type: List[IAlarm]

height¶

Height of the widget.

Default: 3
Return type: Union[int, float, None]

title¶

The title of the widget.

Default: ‘Alarm Status’
Return type: Optional[str]

width¶

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

Default: 6
Return type: Union[int, float, None]