software.amazon.awscdk.services.cloudwatch

Interface MetricConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

MetricConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.31.0 (build 6fa403d)",
           date="2021-07-21T15:55:57.921Z")
 @Stability(value=Stable)
public interface MetricConfig
extends software.amazon.jsii.JsiiSerializable

Properties of a rendered metric.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MetricConfig.Builder A builder for MetricConfig
static class	MetricConfig.Jsii$Proxy An implementation for MetricConfig

Method Summary

Modifier and Type	Method and Description
static MetricConfig.Builder	builder()
default MetricExpressionConfig	getMathExpression() In case the metric is a math expression, the details of the math expression.
default MetricStatConfig	getMetricStat() In case the metric represents a query, the details of the query.
default Map<String,Object>	getRenderingProperties() Additional properties which will be rendered if the metric is used in a dashboard.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMathExpression

@Stability(value=Stable)
 @Nullable
default MetricExpressionConfig getMathExpression()

In case the metric is a math expression, the details of the math expression.

Default: - None

getMetricStat

@Stability(value=Stable)
 @Nullable
default MetricStatConfig getMetricStat()

In case the metric represents a query, the details of the query.

Default: - None

getRenderingProperties

@Stability(value=Stable)
 @Nullable
default Map<String,Object> getRenderingProperties()

Additional properties which will be rendered if the metric is used in a dashboard.

Examples are 'label' and 'color', but any key in here will be added to dashboard graphs.

Default: - None

builder

@Stability(value=Stable)
static MetricConfig.Builder builder()

Returns:

a MetricConfig.Builder of MetricConfig