Package software.amazon.awscdk.services.cloudwatch

Class MetricOptions.Builder

java.lang.Object
software.amazon.awscdk.services.cloudwatch.MetricOptions.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<MetricOptions>
Enclosing interface:
MetricOptions
@Stability(Stable) public static final class MetricOptions.Builder extends Object implements software.amazon.jsii.Builder<MetricOptions>
A builder for MetricOptions

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • account

      @Stability(Stable) public MetricOptions.Builder account(String account)
      Sets the value of CommonMetricOptions.getAccount()
      Parameters:
      account - Account which this metric comes from.
      Returns:
      this

    • color

      @Stability(Stable) public MetricOptions.Builder color(String color)
      Sets the value of CommonMetricOptions.getColor()
      Parameters:
      color - 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.
      Returns:
      this

    • dimensionsMap

      @Stability(Stable) public MetricOptions.Builder dimensionsMap(Map<String,String> dimensionsMap)
      Sets the value of CommonMetricOptions.getDimensionsMap()
      Parameters:
      dimensionsMap - Dimensions of the metric.
      Returns:
      this

    • label

      @Stability(Stable) public MetricOptions.Builder label(String label)
      Sets the value of CommonMetricOptions.getLabel()
      Parameters:
      label - 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.

      Returns:
      this

    • period

      @Stability(Stable) public MetricOptions.Builder period(Duration period)
      Sets the value of CommonMetricOptions.getPeriod()
      Parameters:
      period - The period over which the specified statistic is applied.
      Returns:
      this

    • region

      @Stability(Stable) public MetricOptions.Builder region(String region)
      Sets the value of CommonMetricOptions.getRegion()
      Parameters:
      region - Region which this metric comes from.
      Returns:
      this

    • statistic

      @Stability(Stable) public MetricOptions.Builder statistic(String statistic)
      Sets the value of CommonMetricOptions.getStatistic()
      Parameters:
      statistic - 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%)"
      Returns:
      this

    • unit

      @Stability(Stable) public MetricOptions.Builder unit(Unit unit)
      Sets the value of CommonMetricOptions.getUnit()
      Parameters:
      unit - 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.

      Returns:
      this

    • build

      @Stability(Stable) public MetricOptions build()
      Builds the configured instance.
      Specified by:
      build in interface software.amazon.jsii.Builder<MetricOptions>
      Returns:
      a new instance of MetricOptions
      Throws:
      NullPointerException - if any required attribute was not provided