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/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:51.263Z")
 @Stability(value=Stable)
public interface CommonMetricOptions
extends software.amazon.jsii.JsiiSerializable

Options shared by most methods accepting metric options.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudwatch.*;
 import software.amazon.awscdk.core.*;
 Object dimensions;
 CommonMetricOptions commonMetricOptions = CommonMetricOptions.builder()
         .account("account")
         .color("color")
         .dimensions(Map.of(
                 "dimensionsKey", dimensions))
         .dimensionsMap(Map.of(
                 "dimensionsMapKey", "dimensionsMap"))
         .label("label")
         .period(Duration.minutes(30))
         .region("region")
         .statistic("statistic")
         .unit(Unit.SECONDS)
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CommonMetricOptions.Builder	builder()
default String	getAccount() Account which this metric comes from.
default String	getColor() The hex color code, prefixed with '#' (e.g.
default Map<String,Object>	getDimensions() Deprecated. Use 'dimensionsMap' instead.
default Map<String,String>	getDimensionsMap() Dimensions of the metric.
default String	getLabel() Label for this metric when added to a Graph in a Dashboard.
default Duration	getPeriod() The period over which the specified statistic is applied.
default String	getRegion() Region which this metric comes from.
default String	getStatistic() What function to use for aggregating.
default Unit	getUnit() Unit used to filter the metric stream.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAccount

@Stability(value=Stable)
 @Nullable
default String getAccount()

Account which this metric comes from.

Default: - Deployment account.

getColor

@Stability(value=Stable)
 @Nullable
default String getColor()

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

getDimensions

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default Map<String,Object> getDimensions()

Deprecated. Use 'dimensionsMap' instead.

(deprecated) Dimensions of the metric.

Default: - No dimensions.

getDimensionsMap

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

Dimensions of the metric.

Default: - No dimensions.

getLabel

@Stability(value=Stable)
 @Nullable
default String getLabel()

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

You can use dynamic labels to show summary information about the entire displayed time series in the legend. For example, if you use:

 [max: ${MAX}] MyMetric
 

As the metric label, the maximum value in the visible range will be shown next to the time series name in the graph's legend.

Default: - No label

getPeriod

@Stability(value=Stable)
 @Nullable
default Duration getPeriod()

The period over which the specified statistic is applied.

Default: Duration.minutes(5)

getRegion

@Stability(value=Stable)
 @Nullable
default String getRegion()

Region which this metric comes from.

Default: - Deployment region.

getStatistic

@Stability(value=Stable)
 @Nullable
default 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

getUnit

@Stability(value=Stable)
 @Nullable
default Unit getUnit()

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

builder

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

Returns:

a CommonMetricOptions.Builder of CommonMetricOptions