software.amazon.awscdk.services.cloudwatch

Class SingleValueWidget.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.SingleValueWidget.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SingleValueWidget>

Enclosing class:

SingleValueWidget

@Stability(value=Experimental)
public static final class SingleValueWidget.Builder
extends Object
implements software.amazon.jsii.Builder<SingleValueWidget>

(experimental) A fluent builder for SingleValueWidget.

Method Summary

Modifier and Type	Method and Description
SingleValueWidget	build()
static SingleValueWidget.Builder	create()
SingleValueWidget.Builder	fullPrecision(Boolean fullPrecision) (experimental) Whether to show as many digits as can fit, before rounding.
SingleValueWidget.Builder	height(Number height) (experimental) Height of the widget.
SingleValueWidget.Builder	metrics(List<? extends IMetric> metrics) (experimental) Metrics to display.
SingleValueWidget.Builder	region(String region) (experimental) The region the metrics of this graph should be taken from.
SingleValueWidget.Builder	setPeriodToTimeRange(Boolean setPeriodToTimeRange) (experimental) Whether to show the value from the entire time range.
SingleValueWidget.Builder	title(String title) (experimental) Title for the graph.
SingleValueWidget.Builder	width(Number width) (experimental) Width of the widget, in a grid of 24 units wide.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static SingleValueWidget.Builder create()

Returns:

a new instance of SingleValueWidget.Builder.

height

@Stability(value=Experimental)
public SingleValueWidget.Builder height(Number height)

(experimental) 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.

Parameters:

height - Height of the widget. This parameter is required.

Returns:

this

region

@Stability(value=Experimental)
public SingleValueWidget.Builder region(String region)

(experimental) The region the metrics of this graph should be taken from.

Default: - Current region

Parameters:

region - The region the metrics of this graph should be taken from. This parameter is required.

Returns:

this

title

@Stability(value=Experimental)
public SingleValueWidget.Builder title(String title)

(experimental) Title for the graph.

Default: - None

Parameters:

title - Title for the graph. This parameter is required.

Returns:

this

width

@Stability(value=Experimental)
public SingleValueWidget.Builder width(Number width)

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

Default: 6

Parameters:

width - Width of the widget, in a grid of 24 units wide. This parameter is required.

Returns:

this

metrics

@Stability(value=Experimental)
public SingleValueWidget.Builder metrics(List<? extends IMetric> metrics)

(experimental) Metrics to display.

Parameters:

metrics - Metrics to display. This parameter is required.

Returns:

this

fullPrecision

@Stability(value=Experimental)
public SingleValueWidget.Builder fullPrecision(Boolean fullPrecision)

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

Default: false

Parameters:

fullPrecision - Whether to show as many digits as can fit, before rounding. This parameter is required.

Returns:

this

setPeriodToTimeRange

@Stability(value=Experimental)
public SingleValueWidget.Builder setPeriodToTimeRange(Boolean setPeriodToTimeRange)

(experimental) Whether to show the value from the entire time range.

Default: false

Parameters:

setPeriodToTimeRange - Whether to show the value from the entire time range. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public SingleValueWidget build()

Specified by:

build in interface software.amazon.jsii.Builder<SingleValueWidget>