AlarmWidgetProps¶
-
class
aws_cdk.aws_cloudwatch.
AlarmWidgetProps
(*, height=None, region=None, title=None, width=None, alarm, left_y_axis=None)¶ Bases:
aws_cdk.aws_cloudwatch.MetricWidgetProps
Properties for an AlarmWidget.
- Parameters
height (
Union
[int
,float
,None
]) – Height of the widget. Default: - 6 for Alarm and Graph widgets. 3 for single value widgets where most recent value of a metric is displayed.region (
Optional
[str
]) – The region the metrics of this graph should be taken from. Default: - Current regiontitle (
Optional
[str
]) – Title for the graph. Default: - Nonewidth (
Union
[int
,float
,None
]) – Width of the widget, in a grid of 24 units wide. Default: 6alarm (
IAlarm
) – The alarm to show.left_y_axis (
Optional
[YAxisProps
]) – Left Y axis. Default: - No minimum or maximum values for the left Y-axis
- ExampleMetadata
infused
Example:
# dashboard: cloudwatch.Dashboard # error_alarm: cloudwatch.Alarm dashboard.add_widgets(cloudwatch.AlarmWidget( title="Errors", alarm=error_alarm ))
Attributes
-
height
¶ Height of the widget.
- Default
6 for Alarm and Graph widgets.
3 for single value widgets where most recent value of a metric is displayed.
- Return type
Union
[int
,float
,None
]
-
left_y_axis
¶ Left Y axis.
- Default
No minimum or maximum values for the left Y-axis
- Return type
Optional
[YAxisProps
]
-
region
¶ The region the metrics of this graph should be taken from.
- Default
Current region
- Return type
Optional
[str
]
-
title
¶ Title for the graph.
- Default
None
- Return type
Optional
[str
]
-
width
¶ Width of the widget, in a grid of 24 units wide.
- Default
6
- Return type
Union
[int
,float
,None
]