Package software.amazon.awscdk.services.cloudwatch

Class AnomalyDetectionMetricOptions.Jsii$Proxy

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

  • 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(AnomalyDetectionMetricOptions.Builder builder)
      Constructor that initializes the object based on literal property values passed by the AnomalyDetectionMetricOptions.Builder.

  • Method Details

    • getMetric

      public final IMetric getMetric()
      Description copied from interface: AnomalyDetectionMetricOptions
      The metric to add the alarm on.

      Metric objects can be obtained from most resources, or you can construct custom Metric objects by instantiating one.

      Specified by:
      getMetric in interface AnomalyDetectionMetricOptions

    • getStdDevs

      public final Number getStdDevs()
      Description copied from interface: AnomalyDetectionMetricOptions
      The number of standard deviations to use for the anomaly detection band.

      The higher the value, the wider the band.

      • Must be greater than 0. A value of 0 or negative values would not make sense in the context of calculating standard deviations.
      • There is no strict maximum value defined, as standard deviations can theoretically extend infinitely. However, in practice, values beyond 5 or 6 standard deviations are rarely used, as they would result in an extremely wide anomaly detection band, potentially missing significant anomalies.

      Default: 2

      Specified by:
      getStdDevs in interface AnomalyDetectionMetricOptions

    • getColor

      public final String getColor()
      Description copied from interface: MathExpressionOptions
      Color for this metric when added to a Graph in a Dashboard.

      Default: - Automatic color

      Specified by:
      getColor in interface MathExpressionOptions

    • getLabel

      public final String getLabel()
      Description copied from interface: MathExpressionOptions
      Label for this expression when added to a Graph in a Dashboard.

      If this expression evaluates to more than one time series (for example, through the use of METRICS() or SEARCH() expressions), each time series will appear in the graph using a combination of the expression label and the individual metric label. Specify the empty string ('') to suppress the expression label and only keep the metric label.

      You can use dynamic labels to show summary information about the 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. If the math expression produces more than one time series, the maximum will be shown for each individual time series produce by this math expression.

      Default: - Expression value is used as label

      Specified by:
      getLabel in interface MathExpressionOptions

    • getPeriod

      public final Duration getPeriod()
      Description copied from interface: MathExpressionOptions
      The period over which the math expression's statistics are applied.

      This period overrides all periods in the metrics used in this math expression.

      Default: Duration.minutes(5)

      Specified by:
      getPeriod in interface MathExpressionOptions

    • getSearchAccount

      public final String getSearchAccount()
      Description copied from interface: MathExpressionOptions
      Account to evaluate search expressions within.

      Specifying a searchAccount has no effect to the account used for metrics within the expression (passed via usingMetrics).

      Default: - Deployment account.

      Specified by:
      getSearchAccount in interface MathExpressionOptions

    • getSearchRegion

      public final String getSearchRegion()
      Description copied from interface: MathExpressionOptions
      Region to evaluate search expressions within.

      Specifying a searchRegion has no effect to the region used for metrics within the expression (passed via usingMetrics).

      Default: - Deployment region.

      Specified by:
      getSearchRegion in interface MathExpressionOptions

    • $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