Package software.amazon.awscdk.services.cloudwatch

Class GraphWidgetProps.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.GraphWidgetProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GraphWidgetProps>

Enclosing interface:

GraphWidgetProps

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

A builder for GraphWidgetProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GraphWidgetProps	build()	Builds the configured instance.
GraphWidgetProps.Builder	end(String end)	Sets the value of GraphWidgetProps.getEnd()
GraphWidgetProps.Builder	height(Number height)	Sets the value of MetricWidgetProps.getHeight()
GraphWidgetProps.Builder	left(List<? extends IMetric> left)	Sets the value of GraphWidgetProps.getLeft()
GraphWidgetProps.Builder	leftAnnotations(List<? extends HorizontalAnnotation> leftAnnotations)	Sets the value of GraphWidgetProps.getLeftAnnotations()
GraphWidgetProps.Builder	leftYAxis(YAxisProps leftYAxis)	Sets the value of GraphWidgetProps.getLeftYAxis()
GraphWidgetProps.Builder	legendPosition(LegendPosition legendPosition)	Sets the value of GraphWidgetProps.getLegendPosition()
GraphWidgetProps.Builder	liveData(Boolean liveData)	Sets the value of GraphWidgetProps.getLiveData()
GraphWidgetProps.Builder	period(Duration period)	Sets the value of GraphWidgetProps.getPeriod()
GraphWidgetProps.Builder	region(String region)	Sets the value of MetricWidgetProps.getRegion()
GraphWidgetProps.Builder	right(List<? extends IMetric> right)	Sets the value of GraphWidgetProps.getRight()
GraphWidgetProps.Builder	rightAnnotations(List<? extends HorizontalAnnotation> rightAnnotations)	Sets the value of GraphWidgetProps.getRightAnnotations()
GraphWidgetProps.Builder	rightYAxis(YAxisProps rightYAxis)	Sets the value of GraphWidgetProps.getRightYAxis()
GraphWidgetProps.Builder	setPeriodToTimeRange(Boolean setPeriodToTimeRange)	Sets the value of GraphWidgetProps.getSetPeriodToTimeRange()
GraphWidgetProps.Builder	stacked(Boolean stacked)	Sets the value of GraphWidgetProps.getStacked()
GraphWidgetProps.Builder	start(String start)	Sets the value of GraphWidgetProps.getStart()
GraphWidgetProps.Builder	statistic(String statistic)	Sets the value of GraphWidgetProps.getStatistic()
GraphWidgetProps.Builder	title(String title)	Sets the value of MetricWidgetProps.getTitle()
GraphWidgetProps.Builder	verticalAnnotations(List<? extends VerticalAnnotation> verticalAnnotations)	Sets the value of GraphWidgetProps.getVerticalAnnotations()
GraphWidgetProps.Builder	view(GraphWidgetView view)	Sets the value of GraphWidgetProps.getView()
GraphWidgetProps.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 GraphWidgetProps.Builder end(String end)

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

left

@Stability(Stable)
public GraphWidgetProps.Builder left(List<? extends IMetric> left)

Sets the value of GraphWidgetProps.getLeft()

Parameters:

left - Metrics to display on left Y axis.

Returns:

this

leftAnnotations

@Stability(Stable)
public GraphWidgetProps.Builder leftAnnotations(List<? extends HorizontalAnnotation> leftAnnotations)

Sets the value of GraphWidgetProps.getLeftAnnotations()

Parameters:

leftAnnotations - Annotations for the left Y axis.

Returns:

this

leftYAxis

@Stability(Stable)
public GraphWidgetProps.Builder leftYAxis(YAxisProps leftYAxis)

Sets the value of GraphWidgetProps.getLeftYAxis()

Parameters:

leftYAxis - Left Y axis.

Returns:

this

legendPosition

@Stability(Stable)
public GraphWidgetProps.Builder legendPosition(LegendPosition legendPosition)

Sets the value of GraphWidgetProps.getLegendPosition()

Parameters:

legendPosition - Position of the legend.

Returns:

this

liveData

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

Sets the value of GraphWidgetProps.getLiveData()

Parameters:

liveData - Whether the graph should show live data.

Returns:

this

period

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

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

right

@Stability(Stable)
public GraphWidgetProps.Builder right(List<? extends IMetric> right)

Sets the value of GraphWidgetProps.getRight()

Parameters:

right - Metrics to display on right Y axis.

Returns:

this

rightAnnotations

@Stability(Stable)
public GraphWidgetProps.Builder rightAnnotations(List<? extends HorizontalAnnotation> rightAnnotations)

Sets the value of GraphWidgetProps.getRightAnnotations()

Parameters:

rightAnnotations - Annotations for the right Y axis.

Returns:

this

rightYAxis

@Stability(Stable)
public GraphWidgetProps.Builder rightYAxis(YAxisProps rightYAxis)

Sets the value of GraphWidgetProps.getRightYAxis()

Parameters:

rightYAxis - Right Y axis.

Returns:

this

setPeriodToTimeRange

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

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

stacked

@Stability(Stable)
public GraphWidgetProps.Builder stacked(Boolean stacked)

Sets the value of GraphWidgetProps.getStacked()

Parameters:

stacked - Whether the graph should be shown as stacked lines.

Returns:

this

start

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

Sets the value of GraphWidgetProps.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 GraphWidgetProps.Builder statistic(String statistic)

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

verticalAnnotations

@Stability(Stable)
public GraphWidgetProps.Builder verticalAnnotations(List<? extends VerticalAnnotation> verticalAnnotations)

Sets the value of GraphWidgetProps.getVerticalAnnotations()

Parameters:

verticalAnnotations - Annotations for the X axis.

Returns:

this

view

@Stability(Stable)
public GraphWidgetProps.Builder view(GraphWidgetView view)

Sets the value of GraphWidgetProps.getView()

Parameters:

view - Display this metric.

Returns:

this

height

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

Sets the value of MetricWidgetProps.getHeight()

Parameters:

height - Height of the widget.

Returns:

this

region

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

Sets the value of MetricWidgetProps.getTitle()

Parameters:

title - Title for the graph.

Returns:

this

width

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

Builds the configured instance.

Specified by:

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

Returns:

a new instance of GraphWidgetProps

Throws:

NullPointerException - if any required attribute was not provided