software.amazon.awscdk.services.cloudwatch

Class MetricProps.Builder

java.lang.Object

software.amazon.awscdk.services.cloudwatch.MetricProps.Builder

Enclosing interface:

MetricProps

@Stability(value=Experimental)
public static final class MetricProps.Builder
extends Object

A builder for MetricProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
MetricProps	build() Builds the configured instance.
MetricProps.Builder	withColor(String value) Sets the value of Color
MetricProps.Builder	withDimensions(Map<String,Object> value) Sets the value of Dimensions
MetricProps.Builder	withLabel(String value) Sets the value of Label
MetricProps.Builder	withMetricName(String value) Sets the value of MetricName
MetricProps.Builder	withNamespace(String value) Sets the value of Namespace
MetricProps.Builder	withPeriod(software.amazon.awscdk.core.Duration value) Sets the value of Period
MetricProps.Builder	withStatistic(String value) Sets the value of Statistic
MetricProps.Builder	withUnit(Unit value) Sets the value of Unit

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

withMetricName

@Stability(value=Experimental)
public MetricProps.Builder withMetricName(String value)

Sets the value of MetricName

Parameters:

value - Name of the metric.

Returns:

this

withNamespace

@Stability(value=Experimental)
public MetricProps.Builder withNamespace(String value)

Sets the value of Namespace

Parameters:

value - Namespace of the metric.

Returns:

this

withColor

@Stability(value=Experimental)
public MetricProps.Builder withColor(@Nullable
                                                                    String value)

Sets the value of Color

Parameters:

value - Color for this metric when added to a Graph in a Dashboard.

Returns:

this

withDimensions

@Stability(value=Experimental)
public MetricProps.Builder withDimensions(@Nullable
                                                                         Map<String,Object> value)

Sets the value of Dimensions

Parameters:

value - Dimensions of the metric.

Returns:

this

withLabel

@Stability(value=Experimental)
public MetricProps.Builder withLabel(@Nullable
                                                                    String value)

Sets the value of Label

Parameters:

value - Label for this metric when added to a Graph in a Dashboard.

Returns:

this

withPeriod

@Stability(value=Experimental)
public MetricProps.Builder withPeriod(@Nullable
                                                                     software.amazon.awscdk.core.Duration value)

Sets the value of Period

Parameters:

value - The period over which the specified statistic is applied.

Returns:

this

withStatistic

@Stability(value=Experimental)
public MetricProps.Builder withStatistic(@Nullable
                                                                        String value)

Sets the value of Statistic

Parameters:

value - What function to use for aggregating.

Returns:

this

withUnit

@Stability(value=Experimental)
public MetricProps.Builder withUnit(@Nullable
                                                                   Unit value)

Sets the value of Unit

Parameters:

value - Unit for the metric that is associated with the alarm.

Returns:

this

build

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

Builds the configured instance.

Returns:

a new instance of MetricProps

Throws:

NullPointerException - if any required attribute was not provided