SingleValueWidgetProps¶
-
class
aws_cdk.aws_cloudwatch.
SingleValueWidgetProps
(*, height=None, region=None, title=None, width=None, metrics, full_precision=None, set_period_to_time_range=None)¶ Bases:
aws_cdk.aws_cloudwatch.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 regiontitle (
Optional
[str
]) – Title for the graph. Default: - Nonewidth (
Union
[int
,float
,None
]) – Width of the widget, in a grid of 24 units wide. Default: 6metrics (
Sequence
[IMetric
]) – Metrics to display.full_precision (
Optional
[bool
]) – Whether to show as many digits as can fit, before rounding. Default: falseset_period_to_time_range (
Optional
[bool
]) – Whether to show the value from the entire time range. Default: false
- ExampleMetadata
infused
Example:
# dashboard: cloudwatch.Dashboard # visitor_count: cloudwatch.Metric # purchase_count: cloudwatch.Metric dashboard.add_widgets(cloudwatch.SingleValueWidget( metrics=[visitor_count, purchase_count] ))
Attributes
-
full_precision
¶ Whether to show as many digits as can fit, before rounding.
- Default
false
- Return type
Optional
[bool
]
-
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
]
-
region
¶ The region the metrics of this graph should be taken from.
- Default
Current region
- Return type
Optional
[str
]
-
set_period_to_time_range
¶ Whether to show the value from the entire time range.
- Default
false
- Return type
Optional
[bool
]
-
title
¶ Title for the graph.
- Default
None
- Return type
Optional
[str
]
-
width
¶ Width of the widget, in a grid of 24 units wide.
- Default
6
- Return type
Union
[int
,float
,None
]