AlarmStatusWidgetProps¶
-
class
aws_cdk.aws_cloudwatch.
AlarmStatusWidgetProps
(*, alarms, height=None, sort_by=None, states=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: 3sort_by (
Optional
[AlarmStatusWidgetSortBy
]) – Specifies how to sort the alarms in the widget. Default: - alphabetical orderstates (
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
- ExampleMetadata
infused
Example:
# dashboard: cloudwatch.Dashboard # error_alarm: cloudwatch.Alarm dashboard.add_widgets( cloudwatch.AlarmStatusWidget( alarms=[error_alarm] ))
Attributes
-
height
¶ Height of the widget.
- Default
3
- Return type
Union
[int
,float
,None
]
-
sort_by
¶ Specifies how to sort the alarms in the widget.
- Default
alphabetical order
- Return type
Optional
[AlarmStatusWidgetSortBy
]
-
states
¶ 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.
- Return type
Optional
[List
[AlarmState
]]
-
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
]