Package software.amazon.awscdk.services.cloudwatch

Class SingleValueWidgetProps.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.SingleValueWidgetProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SingleValueWidgetProps>

Enclosing interface:

SingleValueWidgetProps

@Stability(Stable)
public static final class SingleValueWidgetProps.Builder
extends Object
implements software.amazon.jsii.Builder<SingleValueWidgetProps>

A builder for SingleValueWidgetProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SingleValueWidgetProps	build()	Builds the configured instance.
SingleValueWidgetProps.Builder	end(String end)	Sets the value of SingleValueWidgetProps.getEnd()
SingleValueWidgetProps.Builder	fullPrecision(Boolean fullPrecision)	Sets the value of SingleValueWidgetProps.getFullPrecision()
SingleValueWidgetProps.Builder	height(Number height)	Sets the value of MetricWidgetProps.getHeight()
SingleValueWidgetProps.Builder	metrics(List<? extends IMetric> metrics)	Sets the value of SingleValueWidgetProps.getMetrics()
SingleValueWidgetProps.Builder	period(Duration period)	Sets the value of SingleValueWidgetProps.getPeriod()
SingleValueWidgetProps.Builder	region(String region)	Sets the value of MetricWidgetProps.getRegion()
SingleValueWidgetProps.Builder	setPeriodToTimeRange(Boolean setPeriodToTimeRange)	Sets the value of SingleValueWidgetProps.getSetPeriodToTimeRange()
SingleValueWidgetProps.Builder	sparkline(Boolean sparkline)	Sets the value of SingleValueWidgetProps.getSparkline()
SingleValueWidgetProps.Builder	start(String start)	Sets the value of SingleValueWidgetProps.getStart()
SingleValueWidgetProps.Builder	title(String title)	Sets the value of MetricWidgetProps.getTitle()
SingleValueWidgetProps.Builder	width(Number width)	Sets the value of MetricWidgetProps.getWidth()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

metrics

@Stability(Stable)
public SingleValueWidgetProps.Builder metrics(List<? extends IMetric> metrics)

Sets the value of SingleValueWidgetProps.getMetrics()

Parameters:

metrics - Metrics to display. This parameter is required.

Returns:

this

end

@Stability(Stable)
public SingleValueWidgetProps.Builder end(String end)

Sets the value of SingleValueWidgetProps.getEnd()

Parameters:

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.

Returns:

this

fullPrecision

@Stability(Stable)
public SingleValueWidgetProps.Builder fullPrecision(Boolean fullPrecision)

Sets the value of SingleValueWidgetProps.getFullPrecision()

Parameters:

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

Returns:

this

period

@Stability(Stable)
public SingleValueWidgetProps.Builder period(Duration period)

Sets the value of SingleValueWidgetProps.getPeriod()

Parameters:

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.

Returns:

this

setPeriodToTimeRange

@Stability(Stable)
public SingleValueWidgetProps.Builder setPeriodToTimeRange(Boolean setPeriodToTimeRange)

Sets the value of SingleValueWidgetProps.getSetPeriodToTimeRange()

Parameters:

setPeriodToTimeRange - Whether to show the value from the entire time range.

Returns:

this

sparkline

@Stability(Stable)
public SingleValueWidgetProps.Builder sparkline(Boolean sparkline)

Sets the value of SingleValueWidgetProps.getSparkline()

Parameters:

sparkline - Whether to show a graph below the value illustrating the value for the whole time range. Cannot be used in combination with setPeriodToTimeRange

Returns:

this

start

@Stability(Stable)
public SingleValueWidgetProps.Builder start(String start)

Sets the value of SingleValueWidgetProps.getStart()

Parameters:

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.

Returns:

this

height

@Stability(Stable)
public SingleValueWidgetProps.Builder height(Number height)

Sets the value of MetricWidgetProps.getHeight()

Parameters:

height - Height of the widget.

Returns:

this

region

@Stability(Stable)
public SingleValueWidgetProps.Builder region(String region)

Sets the value of MetricWidgetProps.getRegion()

Parameters:

region - The region the metrics of this graph should be taken from.

Returns:

this

title

@Stability(Stable)
public SingleValueWidgetProps.Builder title(String title)

Sets the value of MetricWidgetProps.getTitle()

Parameters:

title - Title for the graph.

Returns:

this

width

@Stability(Stable)
public SingleValueWidgetProps.Builder width(Number width)

Sets the value of MetricWidgetProps.getWidth()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public SingleValueWidgetProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SingleValueWidgetProps

Throws:

NullPointerException - if any required attribute was not provided