Package software.amazon.awscdk.services.cloudwatch

Interface MathExpressionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable, MathExpressionOptions

All Known Implementing Classes:

MathExpressionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:36.873Z")
@Stability(Stable)
public interface MathExpressionProps
extends software.amazon.jsii.JsiiSerializable, MathExpressionOptions

Properties for a MathExpression.

Example:

 Function fn;
 MathExpression allProblems = MathExpression.Builder.create()
         .expression("errors + throttles")
         .usingMetrics(Map.of(
                 "errors", fn.metricErrors(),
                 "faults", fn.metricThrottles()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	MathExpressionProps.Builder	A builder for MathExpressionProps
static final class	MathExpressionProps.Jsii$Proxy	An implementation for MathExpressionProps

Method Summary

Modifier and Type	Method	Description
static MathExpressionProps.Builder	builder()
String	getExpression()	The expression defining the metric.
default Map<String,IMetric>	getUsingMetrics()	The metrics used in the expression, in a map.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.cloudwatch.MathExpressionOptions

getColor, getLabel, getPeriod, getSearchAccount, getSearchRegion

Method Details

getExpression

@Stability(Stable)
@NotNull
String getExpression()

The expression defining the metric.

When an expression contains a SEARCH function, it cannot be used within an Alarm.

getUsingMetrics

@Stability(Stable)
@Nullable
default Map<String,IMetric> getUsingMetrics()

The metrics used in the expression, in a map.

The key is the identifier that represents the given metric in the expression, and the value is the actual Metric object.

Default: - Empty map.

builder

@Stability(Stable)
static MathExpressionProps.Builder builder()

Returns:

a MathExpressionProps.Builder of MathExpressionProps