software.amazon.awscdk.services.cloudwatch

Class MathExpression.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.MathExpression.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<MathExpression>

Enclosing class:

MathExpression

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

(experimental) A fluent builder for MathExpression.

Method Summary

Modifier and Type	Method and Description
MathExpression	build()
MathExpression.Builder	color(String color) (experimental) Color for this metric when added to a Graph in a Dashboard.
static MathExpression.Builder	create()
MathExpression.Builder	expression(String expression) (experimental) The expression defining the metric.
MathExpression.Builder	label(String label) (experimental) Label for this metric when added to a Graph in a Dashboard.
MathExpression.Builder	period(Duration period) (experimental) The period over which the expression's statistics are applied.
MathExpression.Builder	usingMetrics(Map<String,? extends IMetric> usingMetrics) (experimental) The metrics used in the expression, in a map.

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 MathExpression.Builder create()

Returns:

a new instance of MathExpression.Builder.

color

@Stability(value=Experimental)
public MathExpression.Builder color(String color)

(experimental) Color for this metric when added to a Graph in a Dashboard.

Default: - Automatic color

Parameters:

color - Color for this metric when added to a Graph in a Dashboard. This parameter is required.

Returns:

this

label

@Stability(value=Experimental)
public MathExpression.Builder label(String label)

(experimental) Label for this metric when added to a Graph in a Dashboard.

Default: - Expression value is used as label

Parameters:

label - Label for this metric when added to a Graph in a Dashboard. This parameter is required.

Returns:

this

period

@Stability(value=Experimental)
public MathExpression.Builder period(Duration period)

(experimental) The period over which the expression's statistics are applied.

This period overrides all periods in the metrics used in this math expression.

Default: Duration.minutes(5)

Parameters:

period - The period over which the expression's statistics are applied. This parameter is required.

Returns:

this

expression

@Stability(value=Experimental)
public MathExpression.Builder expression(String expression)

(experimental) The expression defining the metric.

Parameters:

expression - The expression defining the metric. This parameter is required.

Returns:

this

usingMetrics

@Stability(value=Experimental)
public MathExpression.Builder usingMetrics(Map<String,? extends IMetric> usingMetrics)

(experimental) The metrics used in the expression, in a map.

The key is the identifier that represents the given metric in the expression, and the value is the actual Metric object.

Parameters:

usingMetrics - The metrics used in the expression, in a map. This parameter is required.

Returns:

this

build

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

Specified by:

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