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.

__init__(*, alarm, left_y_axis=None, height=None, region=None, title=None, width=None)
Parameters
  • props

  • alarm (IAlarm) – The alarm to show.

  • left_y_axis (Optional[YAxisProps]) – Left Y axis.

  • height (Union[int, float, None]) – Height of the widget. Default: Depends on the type of widget

  • region (Optional[str]) – The region the metrics of this graph should be taken from. Default: Current region

  • title (Optional[str]) – Title for the graph.

  • width (Union[int, float, None]) – Width of the widget, in a grid of 24 units wide. Default: 6

Return type

None

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]