software.amazon.awscdk.services.cloudwatch

Interface MetricGraphConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

MetricGraphConfig.Jsii$Proxy

Deprecated.

Replaced by MetricConfig

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:51.302Z")
 @Stability(value=Deprecated)
 @Deprecated
public interface MetricGraphConfig
extends software.amazon.jsii.JsiiSerializable

(deprecated) Properties used to construct the Metric identifying part of a Graph.

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.*;
 Object value;
 MetricGraphConfig metricGraphConfig = MetricGraphConfig.builder()
         .metricName("metricName")
         .namespace("namespace")
         .period(123)
         .renderingProperties(MetricRenderingProperties.builder()
                 .period(123)
                 // the properties below are optional
                 .color("color")
                 .label("label")
                 .stat("stat")
                 .build())
         // the properties below are optional
         .color("color")
         .dimensions(List.of(Dimension.builder()
                 .name("name")
                 .value(value)
                 .build()))
         .label("label")
         .statistic("statistic")
         .unit(Unit.SECONDS)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MetricGraphConfig.Builder Deprecated.
static class	MetricGraphConfig.Jsii$Proxy Deprecated.

Method Summary

Modifier and Type	Method and Description
static MetricGraphConfig.Builder	builder() Deprecated.
default String	getColor() Deprecated. Use `color` in `renderingProperties`
default List<Dimension>	getDimensions() Deprecated.
default String	getLabel() Deprecated. Use `label` in `renderingProperties`
String	getMetricName() Deprecated.
String	getNamespace() Deprecated.
Number	getPeriod() Deprecated. Use `period` in `renderingProperties`
MetricRenderingProperties	getRenderingProperties() Deprecated.
default String	getStatistic() Deprecated. Use `stat` in `renderingProperties`
default Unit	getUnit() Deprecated. not used in dashboard widgets

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getMetricName

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
String getMetricName()

Deprecated.

(deprecated) Name of the metric.

getNamespace

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
String getNamespace()

Deprecated.

(deprecated) Namespace of the metric.

getPeriod

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
Number getPeriod()

Deprecated. Use `period` in `renderingProperties`

(deprecated) How many seconds to aggregate over.

getRenderingProperties

@Stability(value=Deprecated)
 @Deprecated
 @NotNull
MetricRenderingProperties getRenderingProperties()

Deprecated.

(deprecated) Rendering properties override yAxis parameter of the widget object.

getColor

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

Deprecated. Use `color` in `renderingProperties`

(deprecated) Color for the graph line.

getDimensions

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default List<Dimension> getDimensions()

Deprecated.

(deprecated) The dimensions to apply to the alarm.

getLabel

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

Deprecated. Use `label` in `renderingProperties`

(deprecated) Label for the metric.

getStatistic

@Stability(value=Deprecated)
 @Deprecated
 @Nullable
default String getStatistic()

Deprecated. Use `stat` in `renderingProperties`

(deprecated) Aggregation function to use (can be either simple or a percentile).

getUnit

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

Deprecated. not used in dashboard widgets

(deprecated) The unit of the alarm.

builder

@Stability(value=Deprecated)
 @Deprecated
static MetricGraphConfig.Builder builder()

Deprecated.

Returns:

a MetricGraphConfig.Builder of MetricGraphConfig