AlarmWidget¶
-
class
aws_cdk.aws_cloudwatch.
AlarmWidget
(*, alarm, left_y_axis=None, height=None, region=None, title=None, width=None)¶ Bases:
aws_cdk.aws_cloudwatch.ConcreteWidget
Display the metric associated with an alarm, including the alarm line.
- Parameters
alarm (
IAlarm
) – The alarm to show.left_y_axis (
Optional
[YAxisProps
]) – Left Y axis. Default: - No minimum or maximum values for the left Y-axisheight (
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: 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
]
-
width
¶ The amount of horizontal grid units the widget will take up.
- Return type
Union
[int
,float
]