SingleValueWidget
- class aws_cdk.aws_cloudwatch.SingleValueWidget(*, metrics, end=None, full_precision=None, period=None, set_period_to_time_range=None, sparkline=None, start=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 dashboard.add_widgets(cloudwatch.SingleValueWidget( metrics=[], period=Duration.minutes(15) ))
- Parameters:
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: falseperiod (
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: falsesparkline (
Optional
[bool
]) – Whether to show a graph below the value illustrating the value for the whole time range. Cannot be used in combination withsetPeriodToTimeRange
Default: falsestart (
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.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: 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.
- warnings_v2
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.