GraphWidget

class aws_cdk.aws_cloudwatch.GraphWidget(*, left=None, left_annotations=None, left_y_axis=None, legend_position=None, live_data=None, period=None, right=None, right_annotations=None, right_y_axis=None, set_period_to_time_range=None, stacked=None, statistic=None, view=None, height=None, region=None, title=None, width=None)

Bases: aws_cdk.aws_cloudwatch.ConcreteWidget

A dashboard widget that displays metrics.

Parameters
  • left (Optional[Sequence[IMetric]]) – Metrics to display on left Y axis. Default: - No metrics

  • left_annotations (Optional[Sequence[HorizontalAnnotation]]) – Annotations for the left Y axis. Default: - No annotations

  • left_y_axis (Optional[YAxisProps]) – Left Y axis. Default: - None

  • legend_position (Optional[LegendPosition]) – Position of the legend. Default: - bottom

  • live_data (Optional[bool]) – Whether the graph should show live data. Default: false

  • period (Optional[Duration]) – The default period for all metrics in this widget. The period is the length of time represented by one data point on the graph. This default can be overridden within each metric definition. Default: cdk.Duration.seconds(300)

  • right (Optional[Sequence[IMetric]]) – Metrics to display on right Y axis. Default: - No metrics

  • right_annotations (Optional[Sequence[HorizontalAnnotation]]) – Annotations for the right Y axis. Default: - No annotations

  • right_y_axis (Optional[YAxisProps]) – Right Y axis. Default: - None

  • set_period_to_time_range (Optional[bool]) – Whether to show the value from the entire time range. Only applicable for Bar and Pie charts. If false, values will be from the most recent period of your chosen time range; if true, shows the value from the entire time range. Default: false

  • stacked (Optional[bool]) – Whether the graph should be shown as stacked lines. Default: false

  • statistic (Optional[str]) – The default statistic to be displayed for each metric. This default can be overridden within the definition of each individual metric Default: - The statistic for each metric is used

  • view (Optional[GraphWidgetView]) – Display this metric. Default: TimeSeries

  • 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

add_left_metric(metric)

Add another metric to the left Y axis of the GraphWidget.

Parameters

metric (IMetric) – the metric to add.

Return type

None

add_right_metric(metric)

Add another metric to the right Y axis of the GraphWidget.

Parameters

metric (IMetric) – the metric to add.

Return type

None

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]