Package software.amazon.awscdk.services.cloudwatch

Class TableWidgetProps.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.TableWidgetProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<TableWidgetProps>

Enclosing interface:

TableWidgetProps

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

A builder for TableWidgetProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
TableWidgetProps	build()	Builds the configured instance.
TableWidgetProps.Builder	end(String end)	Sets the value of TableWidgetProps.getEnd()
TableWidgetProps.Builder	fullPrecision(Boolean fullPrecision)	Sets the value of TableWidgetProps.getFullPrecision()
TableWidgetProps.Builder	height(Number height)	Sets the value of MetricWidgetProps.getHeight()
TableWidgetProps.Builder	layout(TableLayout layout)	Sets the value of TableWidgetProps.getLayout()
TableWidgetProps.Builder	liveData(Boolean liveData)	Sets the value of TableWidgetProps.getLiveData()
TableWidgetProps.Builder	metrics(List<? extends IMetric> metrics)	Sets the value of TableWidgetProps.getMetrics()
TableWidgetProps.Builder	period(Duration period)	Sets the value of TableWidgetProps.getPeriod()
TableWidgetProps.Builder	region(String region)	Sets the value of MetricWidgetProps.getRegion()
TableWidgetProps.Builder	setPeriodToTimeRange(Boolean setPeriodToTimeRange)	Sets the value of TableWidgetProps.getSetPeriodToTimeRange()
TableWidgetProps.Builder	showUnitsInLabel(Boolean showUnitsInLabel)	Sets the value of TableWidgetProps.getShowUnitsInLabel()
TableWidgetProps.Builder	start(String start)	Sets the value of TableWidgetProps.getStart()
TableWidgetProps.Builder	statistic(String statistic)	Sets the value of TableWidgetProps.getStatistic()
TableWidgetProps.Builder	summary(TableSummaryProps summary)	Sets the value of TableWidgetProps.getSummary()
TableWidgetProps.Builder	thresholds(List<? extends TableThreshold> thresholds)	Sets the value of TableWidgetProps.getThresholds()
TableWidgetProps.Builder	title(String title)	Sets the value of MetricWidgetProps.getTitle()
TableWidgetProps.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

end

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

Sets the value of TableWidgetProps.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 TableWidgetProps.Builder fullPrecision(Boolean fullPrecision)

Sets the value of TableWidgetProps.getFullPrecision()

Parameters:

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

Returns:

this

layout

@Stability(Stable)
public TableWidgetProps.Builder layout(TableLayout layout)

Sets the value of TableWidgetProps.getLayout()

Parameters:

layout - Table layout.

Returns:

this

liveData

@Stability(Stable)
public TableWidgetProps.Builder liveData(Boolean liveData)

Sets the value of TableWidgetProps.getLiveData()

Parameters:

liveData - Whether the graph should show live data.

Returns:

this

metrics

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

Sets the value of TableWidgetProps.getMetrics()

Parameters:

metrics - Metrics to display in the table.

Returns:

this

period

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

Sets the value of TableWidgetProps.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 TableWidgetProps.Builder setPeriodToTimeRange(Boolean setPeriodToTimeRange)

Sets the value of TableWidgetProps.getSetPeriodToTimeRange()

Parameters:

setPeriodToTimeRange - Whether to show the value from the entire time range. Only applicable for Bar and Pie charts. If false, values will be from the most recent period of your chosen time range; if true, shows the value from the entire time range.

Returns:

this

showUnitsInLabel

@Stability(Stable)
public TableWidgetProps.Builder showUnitsInLabel(Boolean showUnitsInLabel)

Sets the value of TableWidgetProps.getShowUnitsInLabel()

Parameters:

showUnitsInLabel - Show the metrics units in the label column.

Returns:

this

start

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

Sets the value of TableWidgetProps.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

statistic

@Stability(Stable)
public TableWidgetProps.Builder statistic(String statistic)

Sets the value of TableWidgetProps.getStatistic()

Parameters:

statistic - The default statistic to be displayed for each metric. This default can be overridden within the definition of each individual metric

Returns:

this

summary

@Stability(Stable)
public TableWidgetProps.Builder summary(TableSummaryProps summary)

Sets the value of TableWidgetProps.getSummary()

Parameters:

summary - Properties for displaying summary columns.

Returns:

this

thresholds

@Stability(Stable)
public TableWidgetProps.Builder thresholds(List<? extends TableThreshold> thresholds)

Sets the value of TableWidgetProps.getThresholds()

Parameters:

thresholds - Thresholds for highlighting table cells.

Returns:

this

height

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

Sets the value of MetricWidgetProps.getHeight()

Parameters:

height - Height of the widget.

Returns:

this

region

@Stability(Stable)
public TableWidgetProps.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 TableWidgetProps.Builder title(String title)

Sets the value of MetricWidgetProps.getTitle()

Parameters:

title - Title for the graph.

Returns:

this

width

@Stability(Stable)
public TableWidgetProps.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 TableWidgetProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of TableWidgetProps

Throws:

NullPointerException - if any required attribute was not provided