Interface IMathExpressionOptions

Configurable options for MathExpressions.

Namespace: Amazon.CDK.AWS.CloudWatch

Assembly: Amazon.CDK.AWS.CloudWatch.dll

Syntax (csharp)

public interface IMathExpressionOptions

Syntax (vb)

Public Interface IMathExpressionOptions

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CloudWatch;
using Amazon.CDK;
var mathExpressionOptions = new MathExpressionOptions {
    Color = "color",
    Label = "label",
    Period = Duration.Minutes(30),
    SearchAccount = "searchAccount",
    SearchRegion = "searchRegion"
};

Synopsis

Properties

Color	Color for this metric when added to a Graph in a Dashboard.
Label	Label for this expression when added to a Graph in a Dashboard.
Period	The period over which the expression's statistics are applied.
SearchAccount	Account to evaluate search expressions within.
SearchRegion	Region to evaluate search expressions within.

Properties

Color

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

virtual string Color { get; }

Property Value

System.String

Remarks

Default: - Automatic color

Label

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

virtual string Label { get; }

Property Value

System.String

Remarks

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

Period

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

virtual Duration Period { get; }

Property Value

Duration

Remarks

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

Default: Duration.minutes(5)

SearchAccount

Account to evaluate search expressions within.

virtual string SearchAccount { get; }

Property Value

System.String

Remarks

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

Default: - Deployment account.

SearchRegion

Region to evaluate search expressions within.

virtual string SearchRegion { get; }

Property Value

System.String

Remarks

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

Default: - Deployment region.