GraphWidgetProps

class aws_cdk.aws_cloudwatch.GraphWidgetProps(*, height=None, region=None, title=None, width=None, end=None, 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, start=None, statistic=None, vertical_annotations=None, view=None)

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

  • end (Optional[str]) – The end of the time range to use for each widget independently from those of the dashboard. If you specify a value for end, you must also specify a value for start. Specify an absolute time in the ISO 8601 format. For example, 2018-12-17T06:00:00.000Z. Default: When the dashboard loads, the end date will be the current time.

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

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

  • left_y_axis (Union[YAxisProps, Dict[str, Any], None]) – 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[Union[HorizontalAnnotation, Dict[str, Any]]]]) – Annotations for the right Y axis. Default: - No annotations

  • right_y_axis (Union[YAxisProps, Dict[str, Any], None]) – 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

  • start (Optional[str]) – The start of the time range to use for each widget independently from those of the dashboard. You can specify start without specifying end to specify a relative time range that ends with the current time. In this case, the value of start must begin with -P, and you can use M, H, D, W and M as abbreviations for minutes, hours, days, weeks and months. For example, -PT8H shows the last 8 hours and -P3M shows the last three months. You can also use start along with an end field, to specify an absolute time range. When specifying an absolute time range, use the ISO 8601 format. For example, 2018-12-17T06:00:00.000Z. Default: When the dashboard loads, the start time will be the default time range.

  • 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

  • vertical_annotations (Optional[Sequence[Union[VerticalAnnotation, Dict[str, Any]]]]) – Annotations for the X axis. Default: - No annotations

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

ExampleMetadata:

infused

Example:

# dashboard: cloudwatch.Dashboard


dashboard.add_widgets(cloudwatch.GraphWidget(
    # ...

    legend_position=cloudwatch.LegendPosition.RIGHT
))

Attributes

end

The end of the time range to use for each widget independently from those of the dashboard.

If you specify a value for end, you must also specify a value for start. Specify an absolute time in the ISO 8601 format. For example, 2018-12-17T06:00:00.000Z.

Default:

When the dashboard loads, the end date will be the current time.

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.

left

Metrics to display on left Y axis.

Default:

  • No metrics

left_annotations

Annotations for the left Y axis.

Default:

  • No annotations

left_y_axis

Left Y axis.

Default:

  • None

legend_position

Position of the legend.

Default:

  • bottom

live_data

Whether the graph should show live data.

Default:

false

period

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)

region

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

Default:

  • Current region

right

Metrics to display on right Y axis.

Default:

  • No metrics

right_annotations

Annotations for the right Y axis.

Default:

  • No annotations

right_y_axis

Right Y axis.

Default:

  • None

set_period_to_time_range

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

Whether the graph should be shown as stacked lines.

Default:

false

start

The start of the time range to use for each widget independently from those of the dashboard.

You can specify start without specifying end to specify a relative time range that ends with the current time. In this case, the value of start must begin with -P, and you can use M, H, D, W and M as abbreviations for minutes, hours, days, weeks and months. For example, -PT8H shows the last 8 hours and -P3M shows the last three months. You can also use start along with an end field, to specify an absolute time range. When specifying an absolute time range, use the ISO 8601 format. For example, 2018-12-17T06:00:00.000Z.

Default:

When the dashboard loads, the start time will be the default time range.

statistic

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

title

Title for the graph.

Default:

  • None

vertical_annotations

Annotations for the X axis.

Default:

  • No annotations

view

Display this metric.

Default:

TimeSeries

width

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

Default:

6