Class CommonMetricOptions.Builder
java.lang.Object
software.amazon.awscdk.services.cloudwatch.CommonMetricOptions.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CommonMetricOptions>
- Enclosing interface:
- CommonMetricOptions
@Stability(Stable)
public static final class CommonMetricOptions.Builder
extends Object
implements software.amazon.jsii.Builder<CommonMetricOptions>
A builder for
CommonMetricOptions
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionSets the value ofCommonMetricOptions.getAccount()
build()
Builds the configured instance.Sets the value ofCommonMetricOptions.getColor()
dimensionsMap
(Map<String, String> dimensionsMap) Sets the value ofCommonMetricOptions.getDimensionsMap()
Sets the value ofCommonMetricOptions.getLabel()
Sets the value ofCommonMetricOptions.getPeriod()
Sets the value ofCommonMetricOptions.getRegion()
Sets the value ofCommonMetricOptions.getStatistic()
Sets the value ofCommonMetricOptions.getUnit()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
account
Sets the value ofCommonMetricOptions.getAccount()
- Parameters:
account
- Account which this metric comes from.- Returns:
this
-
color
Sets the value ofCommonMetricOptions.getColor()
- Parameters:
color
- The hex color code, prefixed with '#' (e.g. '#00ff00'), to use when this metric is rendered on a graph. TheColor
class has a set of standard colors that can be used here.- Returns:
this
-
dimensionsMap
@Stability(Stable) public CommonMetricOptions.Builder dimensionsMap(Map<String, String> dimensionsMap) Sets the value ofCommonMetricOptions.getDimensionsMap()
- Parameters:
dimensionsMap
- Dimensions of the metric.- Returns:
this
-
label
Sets the value ofCommonMetricOptions.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
Sets the value ofCommonMetricOptions.getPeriod()
- Parameters:
period
- The period over which the specified statistic is applied.- Returns:
this
-
region
Sets the value ofCommonMetricOptions.getRegion()
- Parameters:
region
- Region which this metric comes from.- Returns:
this
-
statistic
Sets the value ofCommonMetricOptions.getStatistic()
- Parameters:
statistic
- What function to use for aggregating. Use theaws_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
Sets the value ofCommonMetricOptions.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
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CommonMetricOptions>
- Returns:
- a new instance of
CommonMetricOptions
- Throws:
NullPointerException
- if any required attribute was not provided
-