software.amazon.awscdk.services.cloudwatch

Interface CommonMetricOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

MetricOptions, MetricProps

All Known Implementing Classes:

CommonMetricOptions.Jsii$Proxy, MetricOptions.Jsii$Proxy, MetricProps.Jsii$Proxy

@Generated(value="jsii-pacmak/0.13.2 (build a2116e9)",
           date="2019-07-01T16:58:11.749Z")
 @Stability(value=Experimental)
public interface CommonMetricOptions
extends software.amazon.jsii.JsiiSerializable

Options shared by most methods accepting metric options. EXPERIMENTAL

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CommonMetricOptions.Builder A builder for CommonMetricOptions
static class	CommonMetricOptions.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
static CommonMetricOptions.Builder	builder()
String	getColor() Color for this metric when added to a Graph in a Dashboard.
Map<String,Object>	getDimensions() Dimensions of the metric.
String	getLabel() Label for this metric when added to a Graph in a Dashboard.
software.amazon.awscdk.core.Duration	getPeriod() The period over which the specified statistic is applied.
String	getStatistic() What function to use for aggregating.
Unit	getUnit() Unit for the metric that is associated with the alarm.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getColor

@Stability(value=Experimental)
String getColor()

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

getDimensions

@Stability(value=Experimental)
Map<String,Object> getDimensions()

Dimensions of the metric. Default: - No dimensions. EXPERIMENTAL

getLabel

@Stability(value=Experimental)
String getLabel()

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

getPeriod

@Stability(value=Experimental)
software.amazon.awscdk.core.Duration getPeriod()

The period over which the specified statistic is applied. Default: Duration.minutes(5) EXPERIMENTAL

getStatistic

@Stability(value=Experimental)
String getStatistic()

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 EXPERIMENTAL

getUnit

@Stability(value=Experimental)
Unit getUnit()

Unit for the metric that is associated with the alarm. EXPERIMENTAL

builder

@Stability(value=Experimental)
static CommonMetricOptions.Builder builder()

Returns:

a CommonMetricOptions.Builder of CommonMetricOptions