GaugeWidgetProps

class aws_cdk.aws_cloudwatch.GaugeWidgetProps(*, height=None, region=None, title=None, width=None, annotations=None, end=None, left_y_axis=None, legend_position=None, live_data=None, metrics=None, period=None, set_period_to_time_range=None, start=None, statistic=None)

Bases: MetricWidgetProps

Properties for a GaugeWidget.

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
annotations (Optional[Sequence[Union[HorizontalAnnotation, Dict[str, Any]]]]) – Annotations for the left Y axis. Default: - No annotations
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_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
metrics (Optional[Sequence[IMetric]]) – Metrics to display on left Y axis. Default: - No metrics
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)
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
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

ExampleMetadata:

infused

Example:

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


dashboard.add_widgets(cloudwatch.GaugeWidget(
    metrics=[gauge_metric],
    left_yAxis=cloudwatch.YAxisProps(
        min=0,
        max=1000
    )
))

Attributes

annotations

Annotations for the left Y axis.

Default:

No annotations

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

metrics

Metrics to display on left Y axis.

Default:

No metrics

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

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

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

width

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

Default:: 6