software.amazon.awscdk.services.cloudwatch

Class MathExpression

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cloudwatch.MathExpression

All Implemented Interfaces:

IMetric, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.30.0 (build adae23f)",
           date="2021-06-30T10:00:50.348Z")
 @Stability(value=Experimental)
public class MathExpression
extends software.amazon.jsii.JsiiObject
implements IMetric

(experimental) A math expression built with metric(s) emitted by a service.

The math expression is a combination of an expression (x+y) and metrics to apply expression on. It also contains metadata which is used only in graphs, such as color and label. It makes sense to embed this in here, so that compound constructs can attach that metadata to metrics they expose.

This class does not represent a resource, so hence is not a construct. Instead, MathExpression is an abstraction that makes it easy to specify metrics for use in both alarms and graphs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MathExpression.Builder (experimental) A fluent builder for MathExpression.

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.IMetric

IMetric.Jsii$Default, IMetric.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MathExpression(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	MathExpression(software.amazon.jsii.JsiiObjectRef objRef)
	MathExpression(MathExpressionProps props)

Method Summary

Modifier and Type	Method and Description
Alarm	createAlarm(software.constructs.Construct scope, String id, CreateAlarmOptions props) (experimental) Make a new Alarm for this metric.
String	getColor() (experimental) The hex color code, prefixed with '#' (e.g.
String	getExpression() (experimental) The expression defining the metric.
String	getLabel() (experimental) Label for this metric when added to a Graph.
Duration	getPeriod() (experimental) Aggregation period of this metric.
Map<String,IMetric>	getUsingMetrics() (experimental) The metrics used in the expression as KeyValuePair .
MetricConfig	toMetricConfig() (experimental) Inspect the details of the metric object.
String	toString() (experimental) Returns a string representation of an object.
MathExpression	with(MathExpressionOptions props) (experimental) Return a copy of Metric with properties changed.

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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

MathExpression

protected MathExpression(software.amazon.jsii.JsiiObjectRef objRef)

MathExpression

protected MathExpression(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

MathExpression

@Stability(value=Experimental)
public MathExpression(@NotNull
                                                     MathExpressionProps props)

Parameters:

props - This parameter is required.

Method Detail

createAlarm

@Stability(value=Experimental)
 @NotNull
public Alarm createAlarm(@NotNull
                                                                  software.constructs.Construct scope,
                                                                  @NotNull
                                                                  String id,
                                                                  @NotNull
                                                                  CreateAlarmOptions props)

(experimental) Make a new Alarm for this metric.

Combines both properties that may adjust the metric (aggregation) as well as alarm properties.

Parameters:

scope - This parameter is required.

id - This parameter is required.

props - This parameter is required.

toMetricConfig

@Stability(value=Experimental)
 @NotNull
public MetricConfig toMetricConfig()

(experimental) Inspect the details of the metric object.

Specified by:

toMetricConfig in interface IMetric

toString

@Stability(value=Experimental)
 @NotNull
public String toString()

(experimental) Returns a string representation of an object.

Overrides:

toString in class Object

with

@Stability(value=Experimental)
 @NotNull
public MathExpression with(@NotNull
                                                                    MathExpressionOptions props)

(experimental) Return a copy of Metric with properties changed.

All properties except namespace and metricName can be changed.

Parameters:

props - The set of properties to change. This parameter is required.

getExpression

@Stability(value=Experimental)
 @NotNull
public String getExpression()

(experimental) The expression defining the metric.

getPeriod

@Stability(value=Experimental)
 @NotNull
public Duration getPeriod()

(experimental) Aggregation period of this metric.

getUsingMetrics

@Stability(value=Experimental)
 @NotNull
public Map<String,IMetric> getUsingMetrics()

(experimental) The metrics used in the expression as KeyValuePair .

getColor

@Stability(value=Experimental)
 @Nullable
public String getColor()

(experimental) 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.

getLabel

@Stability(value=Experimental)
 @Nullable
public String getLabel()

(experimental) Label for this metric when added to a Graph.