SingleValueWidget

class aws_cdk.aws_cloudwatch.SingleValueWidget(*, metrics, full_precision=None, set_period_to_time_range=None, height=None, region=None, title=None, width=None)

Bases: ConcreteWidget

A dashboard widget that displays the most recent value for every metric.

ExampleMetadata:

infused

Example:

# dashboard: cloudwatch.Dashboard
# visitor_count: cloudwatch.Metric
# purchase_count: cloudwatch.Metric


dashboard.add_widgets(cloudwatch.SingleValueWidget(
    metrics=[visitor_count, purchase_count]
))
Parameters:

  • metrics (Sequence[IMetric]) – Metrics to display.

  • full_precision (Optional[bool]) – Whether to show as many digits as can fit, before rounding. Default: false

  • set_period_to_time_range (Optional[bool]) – Whether to show the value from the entire time range. Default: false

  • 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

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.

warnings

Any warnings that are produced as a result of putting together this widget.

width

The amount of horizontal grid units the widget will take up.