Package software.amazon.awscdk.services.cloudwatch

Interface MetricGraphConfig

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
MetricGraphConfig.Jsii$Proxy
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:36.879Z") @Stability(Deprecated) @Deprecated public interface MetricGraphConfig extends software.amazon.jsii.JsiiSerializable
Deprecated.
Replaced by MetricConfig
(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();

  • Method Details

    • getMetricName

      @Stability(Deprecated) @Deprecated @NotNull String getMetricName()
      Deprecated.
      (deprecated) Name of the metric.

    • getNamespace

      @Stability(Deprecated) @Deprecated @NotNull String getNamespace()
      Deprecated.
      (deprecated) Namespace of the metric.

    • getPeriod

      @Stability(Deprecated) @Deprecated @NotNull Number getPeriod()
      Deprecated.
      Use period in renderingProperties
      (deprecated) How many seconds to aggregate over.

    • getRenderingProperties

      @Stability(Deprecated) @Deprecated @NotNull MetricRenderingProperties getRenderingProperties()
      Deprecated.
      (deprecated) Rendering properties override yAxis parameter of the widget object.

    • getColor

      @Stability(Deprecated) @Deprecated @Nullable default String getColor()
      Deprecated.
      Use color in renderingProperties
      (deprecated) Color for the graph line.

    • getDimensions

      @Stability(Deprecated) @Deprecated @Nullable default List<Dimension> getDimensions()
      Deprecated.
      (deprecated) The dimensions to apply to the alarm.

    • getLabel

      @Stability(Deprecated) @Deprecated @Nullable default String getLabel()
      Deprecated.
      Use label in renderingProperties
      (deprecated) Label for the metric.

    • getStatistic

      @Stability(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(Deprecated) @Deprecated @Nullable default Unit getUnit()
      Deprecated.
      not used in dashboard widgets
      (deprecated) The unit of the alarm.

    • builder

      @Stability(Deprecated) @Deprecated static MetricGraphConfig.Builder builder()
      Deprecated.
      Returns:
      a MetricGraphConfig.Builder of MetricGraphConfig