Package software.amazon.awscdk.services.cloudwatch

Interface MathExpressionOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

MathExpressionProps

All Known Implementing Classes:

MathExpressionOptions.Jsii$Proxy, MathExpressionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-24T21:00:26.913Z")
@Stability(Stable)
public interface MathExpressionOptions
extends software.amazon.jsii.JsiiSerializable

Configurable options for MathExpressions.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 import software.amazon.awscdk.services.cloudwatch.*;
 MathExpressionOptions mathExpressionOptions = MathExpressionOptions.builder()
         .color("color")
         .label("label")
         .period(Duration.minutes(30))
         .searchAccount("searchAccount")
         .searchRegion("searchRegion")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static MathExpressionOptions.Builder	builder()
default String	getColor()	Color for this metric when added to a Graph in a Dashboard.
default String	getLabel()	Label for this expression when added to a Graph in a Dashboard.
default Duration	getPeriod()	The period over which the expression's statistics are applied.
default String	getSearchAccount()	Account to evaluate search expressions within.
default String	getSearchRegion()	Region to evaluate search expressions within.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getColor

@Stability(Stable)
@Nullable
default String getColor()

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

Default: - Automatic color

getLabel

@Stability(Stable)
@Nullable
default String getLabel()

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

getPeriod

@Stability(Stable)
@Nullable
default Duration getPeriod()

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)

getSearchAccount

@Stability(Stable)
@Nullable
default String getSearchAccount()

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.

getSearchRegion

@Stability(Stable)
@Nullable
default String getSearchRegion()

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.

builder

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

Returns:

a MathExpressionOptions.Builder of MathExpressionOptions