SingleValueWidgetProps

class aws_cdk.aws_cloudwatch.SingleValueWidgetProps(*, height=None, region=None, title=None, width=None, metrics, end=None, full_precision=None, period=None, set_period_to_time_range=None, sparkline=None, start=None)

Bases: MetricWidgetProps

Properties for a SingleValueWidget.

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
metrics (Sequence[IMetric]) – Metrics to display.
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.
full_precision (Optional[bool]) – Whether to show as many digits as can fit, before rounding. 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)
set_period_to_time_range (Optional[bool]) – Whether to show the value from the entire time range. Default: false
sparkline (Optional[bool]) – Whether to show a graph below the value illustrating the value for the whole time range. Cannot be used in combination with setPeriodToTimeRange 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.

ExampleMetadata:

infused

Example:

# dashboard: cloudwatch.Dashboard


dashboard.add_widgets(cloudwatch.SingleValueWidget(
    metrics=[],

    period=Duration.minutes(15)
))

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.

full_precision

Whether to show as many digits as can fit, before rounding.

Default:: false

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.

metrics: Metrics to display.

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.

Default:: false

sparkline

Whether to show a graph below the value illustrating the value for the whole time range.

Cannot be used in combination with setPeriodToTimeRange

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.

title

Title for the graph.

Default:

None

width

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

Default:: 6