software.amazon.awscdk.services.cloudwatch

Class Metric.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.Metric.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<Metric>

Enclosing class:

Metric

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

(experimental) A fluent builder for Metric.

Method Summary

Modifier and Type	Method and Description
Metric.Builder	account(String account) (experimental) Account which this metric comes from.
Metric	build()
Metric.Builder	color(String color) (experimental) The hex color code, prefixed with '#' (e.g.
static Metric.Builder	create()
Metric.Builder	dimensions(Map<String,? extends Object> dimensions) (experimental) Dimensions of the metric.
Metric.Builder	label(String label) (experimental) Label for this metric when added to a Graph in a Dashboard.
Metric.Builder	metricName(String metricName) (experimental) Name of the metric.
Metric.Builder	namespace(String namespace) (experimental) Namespace of the metric.
Metric.Builder	period(Duration period) (experimental) The period over which the specified statistic is applied.
Metric.Builder	region(String region) (experimental) Region which this metric comes from.
Metric.Builder	statistic(String statistic) (experimental) What function to use for aggregating.
Metric.Builder	unit(Unit unit) (experimental) Unit used to filter the metric stream.

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

Returns:

a new instance of Metric.Builder.

account

@Stability(value=Experimental)
public Metric.Builder account(String account)

(experimental) Account which this metric comes from.

Default: - Deployment account.

Parameters:

account - Account which this metric comes from. This parameter is required.

Returns:

this

color

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

(experimental) The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The `Color` class has a set of standard colors that can be used here.

Default: - Automatic color

Parameters:

color - The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. The `Color` class has a set of standard colors that can be used here. This parameter is required.

Returns:

this

dimensions

@Stability(value=Experimental)
public Metric.Builder dimensions(Map<String,? extends Object> dimensions)

(experimental) Dimensions of the metric.

Default: - No dimensions.

Parameters:

dimensions - Dimensions of the metric. This parameter is required.

Returns:

this

label

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

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

Default: - No 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 Metric.Builder period(Duration period)

(experimental) The period over which the specified statistic is applied.

Default: Duration.minutes(5)

Parameters:

period - The period over which the specified statistic is applied. This parameter is required.

Returns:

this

region

@Stability(value=Experimental)
public Metric.Builder region(String region)

(experimental) Region which this metric comes from.

Default: - Deployment region.

Parameters:

region - Region which this metric comes from. This parameter is required.

Returns:

this

statistic

@Stability(value=Experimental)
public Metric.Builder statistic(String statistic)

(experimental) What function to use for aggregating.

Can be one of the following:

• "Minimum" | "min"
• "Maximum" | "max"
• "Average" | "avg"
• "Sum" | "sum"
• "SampleCount | "n"
• "pNN.NN"

Default: Average

Parameters:

statistic - What function to use for aggregating. This parameter is required.

Returns:

this

unit

@Stability(value=Experimental)
public Metric.Builder unit(Unit unit)

(experimental) Unit used to filter the metric stream.

Only refer to datums emitted to the metric stream with the given unit and ignore all others. Only useful when datums are being emitted to the same metric stream under different units.

The default is to use all matric datums in the stream, regardless of unit, which is recommended in nearly all cases.

CloudWatch does not honor this property for graphs.

Default: - All metric datums in the given metric stream

Parameters:

unit - Unit used to filter the metric stream. This parameter is required.

Returns:

this

metricName

@Stability(value=Experimental)
public Metric.Builder metricName(String metricName)

(experimental) Name of the metric.

Parameters:

metricName - Name of the metric. This parameter is required.

Returns:

this

namespace

@Stability(value=Experimental)
public Metric.Builder namespace(String namespace)

(experimental) Namespace of the metric.

Parameters:

namespace - Namespace of the metric. This parameter is required.

Returns:

this

build

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

Specified by:

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