software.amazon.awscdk.services.cloudwatch

Class GraphWidget.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.GraphWidget.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GraphWidget>

Enclosing class:

GraphWidget

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

A fluent builder for GraphWidget.

Method Summary

Modifier and Type	Method and Description
GraphWidget	build()
static GraphWidget.Builder	create()
GraphWidget.Builder	height(Number height) Height of the widget.
GraphWidget.Builder	left(List<? extends IMetric> left) Metrics to display on left Y axis.
GraphWidget.Builder	leftAnnotations(List<? extends HorizontalAnnotation> leftAnnotations) Annotations for the left Y axis.
GraphWidget.Builder	leftYAxis(YAxisProps leftYAxis) Left Y axis.
GraphWidget.Builder	legendPosition(LegendPosition legendPosition) Position of the legend.
GraphWidget.Builder	liveData(Boolean liveData) Whether the graph should show live data.
GraphWidget.Builder	period(Duration period) The default period for all metrics in this widget.
GraphWidget.Builder	region(String region) The region the metrics of this graph should be taken from.
GraphWidget.Builder	right(List<? extends IMetric> right) Metrics to display on right Y axis.
GraphWidget.Builder	rightAnnotations(List<? extends HorizontalAnnotation> rightAnnotations) Annotations for the right Y axis.
GraphWidget.Builder	rightYAxis(YAxisProps rightYAxis) Right Y axis.
GraphWidget.Builder	setPeriodToTimeRange(Boolean setPeriodToTimeRange) Whether to show the value from the entire time range.
GraphWidget.Builder	stacked(Boolean stacked) Whether the graph should be shown as stacked lines.
GraphWidget.Builder	statistic(String statistic) The default statistic to be displayed for each metric.
GraphWidget.Builder	title(String title) Title for the graph.
GraphWidget.Builder	view(GraphWidgetView view) Display this metric.
GraphWidget.Builder	width(Number width) 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=Stable)
public static GraphWidget.Builder create()

Returns:

a new instance of GraphWidget.Builder.

height

@Stability(value=Stable)
public GraphWidget.Builder height(Number height)

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=Stable)
public GraphWidget.Builder region(String region)

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=Stable)
public GraphWidget.Builder title(String title)

Title for the graph.

Default: - None

Parameters:

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

Returns:

this

width

@Stability(value=Stable)
public GraphWidget.Builder width(Number width)

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

left

@Stability(value=Stable)
public GraphWidget.Builder left(List<? extends IMetric> left)

Metrics to display on left Y axis.

Default: - No metrics

Parameters:

left - Metrics to display on left Y axis. This parameter is required.

Returns:

this

leftAnnotations

@Stability(value=Stable)
public GraphWidget.Builder leftAnnotations(List<? extends HorizontalAnnotation> leftAnnotations)

Annotations for the left Y axis.

Default: - No annotations

Parameters:

leftAnnotations - Annotations for the left Y axis. This parameter is required.

Returns:

this

leftYAxis

@Stability(value=Stable)
public GraphWidget.Builder leftYAxis(YAxisProps leftYAxis)

Left Y axis.

Default: - None

Parameters:

leftYAxis - Left Y axis. This parameter is required.

Returns:

this

legendPosition

@Stability(value=Stable)
public GraphWidget.Builder legendPosition(LegendPosition legendPosition)

Position of the legend.

Default: - bottom

Parameters:

legendPosition - Position of the legend. This parameter is required.

Returns:

this

liveData

@Stability(value=Stable)
public GraphWidget.Builder liveData(Boolean liveData)

Whether the graph should show live data.

Default: false

Parameters:

liveData - Whether the graph should show live data. This parameter is required.

Returns:

this

period

@Stability(value=Stable)
public GraphWidget.Builder period(Duration 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.

Default: cdk.Duration.seconds(300)

Parameters:

period - The default period for all metrics in this widget. This parameter is required.

Returns:

this

right

@Stability(value=Stable)
public GraphWidget.Builder right(List<? extends IMetric> right)

Metrics to display on right Y axis.

Default: - No metrics

Parameters:

right - Metrics to display on right Y axis. This parameter is required.

Returns:

this

rightAnnotations

@Stability(value=Stable)
public GraphWidget.Builder rightAnnotations(List<? extends HorizontalAnnotation> rightAnnotations)

Annotations for the right Y axis.

Default: - No annotations

Parameters:

rightAnnotations - Annotations for the right Y axis. This parameter is required.

Returns:

this

rightYAxis

@Stability(value=Stable)
public GraphWidget.Builder rightYAxis(YAxisProps rightYAxis)

Right Y axis.

Default: - None

Parameters:

rightYAxis - Right Y axis. This parameter is required.

Returns:

this

setPeriodToTimeRange

@Stability(value=Stable)
public GraphWidget.Builder setPeriodToTimeRange(Boolean 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.

Default: false

Parameters:

setPeriodToTimeRange - Whether to show the value from the entire time range. Only applicable for Bar and Pie charts. This parameter is required.

Returns:

this

stacked

@Stability(value=Stable)
public GraphWidget.Builder stacked(Boolean stacked)

Whether the graph should be shown as stacked lines.

Default: false

Parameters:

stacked - Whether the graph should be shown as stacked lines. This parameter is required.

Returns:

this

statistic

@Stability(value=Stable)
public GraphWidget.Builder statistic(String statistic)

The default statistic to be displayed for each metric.

This default can be overridden within the definition of each individual metric

Default: - The statistic for each metric is used

Parameters:

statistic - The default statistic to be displayed for each metric. This parameter is required.

Returns:

this

view

@Stability(value=Stable)
public GraphWidget.Builder view(GraphWidgetView view)

Display this metric.

Default: TimeSeries

Parameters:

view - Display this metric. This parameter is required.

Returns:

this

build

@Stability(value=Stable)
public GraphWidget build()

Specified by:

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