GraphWidgetProps

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

Bases: aws_cdk.aws_cloudwatch.MetricWidgetProps

Properties for a GraphWidget.

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 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

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

  • left_annotations (Optional[List[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

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

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

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

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

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

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

Metrics to display on left Y axis.

Default

  • No metrics

Return type

Optional[List[IMetric]]

left_annotations

Annotations for the left Y axis.

Default

  • No annotations

Return type

Optional[List[HorizontalAnnotation]]

left_y_axis

Left Y axis.

Default

  • None

Return type

Optional[YAxisProps]

legend_position

Position of the legend.

Default

  • bottom

Return type

Optional[LegendPosition]

live_data

Whether the graph should show live data.

Default

false

Return type

Optional[bool]

region

The region the metrics of this graph should be taken from.

Default

  • Current region

Return type

Optional[str]

right

Metrics to display on right Y axis.

Default

  • No metrics

Return type

Optional[List[IMetric]]

right_annotations

Annotations for the right Y axis.

Default

  • No annotations

Return type

Optional[List[HorizontalAnnotation]]

right_y_axis

Right Y axis.

Default

  • None

Return type

Optional[YAxisProps]

stacked

Whether the graph should be shown as stacked lines.

Default

false

Return type

Optional[bool]

title

Title for the graph.

Default

  • None

Return type

Optional[str]

view

Display this metric.

Default

TimeSeries

Return type

Optional[GraphWidgetView]

width

Width of the widget, in a grid of 24 units wide.

Default

6

Return type

Union[int, float, None]