Package software.amazon.awscdk.services.cloudwatch

Class MetricProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.cloudwatch.MetricProps.Jsii$Proxy
All Implemented Interfaces:
CommonMetricOptions, MetricProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
MetricProps
@Stability(Stable) @Internal public static final class MetricProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements MetricProps
An implementation for MetricProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(MetricProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the MetricProps.Builder.

  • Method Details

    • getMetricName

      public final String getMetricName()
      Description copied from interface: MetricProps
      Name of the metric.
      Specified by:
      getMetricName in interface MetricProps

    • getNamespace

      public final String getNamespace()
      Description copied from interface: MetricProps
      Namespace of the metric.
      Specified by:
      getNamespace in interface MetricProps

    • getAccount

      public final String getAccount()
      Description copied from interface: CommonMetricOptions
      Account which this metric comes from.

      Default: - Deployment account.

      Specified by:
      getAccount in interface CommonMetricOptions

    • getColor

      public final String getColor()
      Description copied from interface: CommonMetricOptions
      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

      Specified by:
      getColor in interface CommonMetricOptions

    • getDimensions

      public final Map<String,Object> getDimensions()
      Description copied from interface: CommonMetricOptions
      (deprecated) Dimensions of the metric.

      Default: - No dimensions.

      Specified by:
      getDimensions in interface CommonMetricOptions

    • getDimensionsMap

      public final Map<String,String> getDimensionsMap()
      Description copied from interface: CommonMetricOptions
      Dimensions of the metric.

      Default: - No dimensions.

      Specified by:
      getDimensionsMap in interface CommonMetricOptions

    • getLabel

      public final String getLabel()
      Description copied from interface: CommonMetricOptions
      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

      Specified by:
      getLabel in interface CommonMetricOptions

    • getPeriod

      public final Duration getPeriod()
      Description copied from interface: CommonMetricOptions
      The period over which the specified statistic is applied.

      Default: Duration.minutes(5)

      Specified by:
      getPeriod in interface CommonMetricOptions

    • getRegion

      public final String getRegion()
      Description copied from interface: CommonMetricOptions
      Region which this metric comes from.

      Default: - Deployment region.

      Specified by:
      getRegion in interface CommonMetricOptions

    • getStatistic

      public final String getStatistic()
      Description copied from interface: CommonMetricOptions
      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

      Specified by:
      getStatistic in interface CommonMetricOptions

    • getUnit

      public final Unit getUnit()
      Description copied from interface: CommonMetricOptions
      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

      Specified by:
      getUnit in interface CommonMetricOptions

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object