software.amazon.awscdk.services.cloudwatch

Class MathExpressionProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.cloudwatch.MathExpressionProps.Jsii$Proxy

All Implemented Interfaces:

MathExpressionOptions, MathExpressionProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

MathExpressionProps

@Stability(value=Stable)
 @Internal
public static final class MathExpressionProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements MathExpressionProps

An implementation for MathExpressionProps

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

MathExpressionProps.Builder, MathExpressionProps.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
String	getColor() Color for this metric when added to a Graph in a Dashboard.
String	getExpression() The expression defining the metric.
String	getLabel() Label for this expression when added to a Graph in a Dashboard.
Duration	getPeriod() The period over which the expression's statistics are applied.
String	getSearchAccount() Account to evaluate search expressions within.
String	getSearchRegion() Region to evaluate search expressions within.
Map<String,IMetric>	getUsingMetrics() The metrics used in the expression, in a map.
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

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

builder

Constructor Detail

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(MathExpressionProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the MathExpressionProps.Builder.

Method Detail

getExpression

public final String getExpression()

Description copied from interface: MathExpressionProps

The expression defining the metric.

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

Specified by:

getExpression in interface MathExpressionProps

getUsingMetrics

public final Map<String,IMetric> getUsingMetrics()

Description copied from interface: MathExpressionProps

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.

Specified by:

getUsingMetrics in interface MathExpressionProps

getColor

public final String getColor()

Description copied from interface: MathExpressionOptions

Color for this metric when added to a Graph in a Dashboard.

Default: - Automatic color

Specified by:

getColor in interface MathExpressionOptions

getLabel

public final String getLabel()

Description copied from interface: MathExpressionOptions

Label for this expression when added to a Graph in a Dashboard.

If this expression evaluates to more than one time series (for example, through the use of METRICS() or SEARCH() expressions), each time series will appear in the graph using a combination of the expression label and the individual metric label. Specify the empty string ('') to suppress the expression label and only keep the metric label.

You can use dynamic labels to show summary information about the 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. If the math expression produces more than one time series, the maximum will be shown for each individual time series produce by this math expression.

Default: - Expression value is used as label

Specified by:

getLabel in interface MathExpressionOptions

getPeriod

public final Duration getPeriod()

Description copied from interface: MathExpressionOptions

The period over which the expression's statistics are applied.

This period overrides all periods in the metrics used in this math expression.

Default: Duration.minutes(5)

Specified by:

getPeriod in interface MathExpressionOptions

getSearchAccount

public final String getSearchAccount()

Description copied from interface: MathExpressionOptions

Account to evaluate search expressions within.

Specifying a searchAccount has no effect to the account used for metrics within the expression (passed via usingMetrics).

Default: - Deployment account.

Specified by:

getSearchAccount in interface MathExpressionOptions

getSearchRegion

public final String getSearchRegion()

Description copied from interface: MathExpressionOptions

Region to evaluate search expressions within.

Specifying a searchRegion has no effect to the region used for metrics within the expression (passed via usingMetrics).

Default: - Deployment region.

Specified by:

getSearchRegion in interface MathExpressionOptions

$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