Package software.amazon.awscdk.services.cloudwatch

Class MetricOptions.Jsii$Proxy

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

  • Nested Class Summary

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudwatch.MetricOptions

    MetricOptions.Builder, MetricOptions.Jsii$Proxy

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    Jsii$Proxy(MetricOptions.Builder builder)
    Constructor that initializes the object based on literal property values passed by the MetricOptions.Builder.
    protected
    Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
    Constructor that initializes the object based on values retrieved from the JsiiObject.

  • Method Summary

    Modifier and Type
    Method
    Description
    com.fasterxml.jackson.databind.JsonNode
    $jsii$toJson()
     
    final boolean
    equals(Object o)
     
    final String
    getAccount()
    Account which this metric comes from.
    final String
    getColor()
    The hex color code, prefixed with '#' (e.g.
    final Map<String,String>
    getDimensionsMap()
    Dimensions of the metric.
    final String
    getId()
    Unique identifier for this metric when used in dashboard widgets.
    final String
    getLabel()
    Label for this metric when added to a Graph in a Dashboard.
    final Duration
    getPeriod()
    The period over which the specified statistic is applied.
    final String
    getRegion()
    Region which this metric comes from.
    final String
    getStackAccount()
    Account of the stack this metric is attached to.
    final String
    getStackRegion()
    Region of the stack this metric is attached to.
    final String
    getStatistic()
    What function to use for aggregating.
    final Unit
    getUnit()
    Unit used to filter the metric stream.
    final Boolean
    getVisible()
    Whether this metric should be visible in dashboard graphs.
    final int
    hashCode()
     

    Methods inherited from class software.amazon.jsii.JsiiObject

    jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

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

  • Method Details

    • 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

    • 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

    • getId

      public final String getId()
      Description copied from interface: CommonMetricOptions
      Unique identifier for this metric when used in dashboard widgets.

      The id can be used as a variable to represent this metric in math expressions. Valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.

      Default: - No ID

      Specified by:
      getId 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

    • getStackAccount

      public final String getStackAccount()
      Description copied from interface: CommonMetricOptions
      Account of the stack this metric is attached to.

      Default: - Deployment account.

      Specified by:
      getStackAccount in interface CommonMetricOptions

    • getStackRegion

      public final String getStackRegion()
      Description copied from interface: CommonMetricOptions
      Region of the stack this metric is attached to.

      Default: - Deployment region.

      Specified by:
      getStackRegion in interface CommonMetricOptions

    • getStatistic

      public final String getStatistic()
      Description copied from interface: CommonMetricOptions
      What function to use for aggregating.

      Use the aws_cloudwatch.Stats helper class to construct valid input strings.

      Can be one of the following:

      • "Minimum" | "min"
      • "Maximum" | "max"
      • "Average" | "avg"
      • "Sum" | "sum"
      • "SampleCount | "n"
      • "pNN.NN"
      • "tmNN.NN" | "tm(NN.NN%:NN.NN%)"
      • "iqm"
      • "wmNN.NN" | "wm(NN.NN%:NN.NN%)"
      • "tcNN.NN" | "tc(NN.NN%:NN.NN%)"
      • "tsNN.NN" | "ts(NN.NN%:NN.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

    • getVisible

      public final Boolean getVisible()
      Description copied from interface: CommonMetricOptions
      Whether this metric should be visible in dashboard graphs.

      Setting this to false is useful when you want to hide raw metrics that are used in math expressions, and show only the expression results.

      Default: true

      Specified by:
      getVisible 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