AlarmWidget

class aws_cdk.aws_cloudwatch.AlarmWidget(*, alarm, left_y_axis=None, height=None, region=None, title=None, width=None)

Bases: ConcreteWidget

Display the metric associated with an alarm, including the alarm line.

ExampleMetadata:: infused

Example:

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


dashboard.add_widgets(cloudwatch.AlarmWidget(
    title="Errors",
    alarm=error_alarm
))

Parameters:

alarm (IAlarm) – The alarm to show.
left_y_axis (Union[YAxisProps, Dict[str, Any], None]) – Left Y axis. Default: - No minimum or maximum values for the left Y-axis
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 region
title (Optional[str]) – Title for the graph. Default: - None
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.

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

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