Class MathExpressionProps
Properties for a MathExpression.
Inheritance
Namespace: Amazon.CDK.AWS.CloudWatch
Assembly: Amazon.CDK.AWS.CloudWatch.dll
Syntax (csharp)
public class MathExpressionProps : Object, IMathExpressionProps, IMathExpressionOptions
Syntax (vb)
Public Class MathExpressionProps
Inherits Object
Implements IMathExpressionProps, IMathExpressionOptions
Remarks
ExampleMetadata: infused
Examples
Function fn;
var allProblems = new MathExpression(new MathExpressionProps {
Expression = "errors + throttles",
UsingMetrics = new Dictionary<string, IMetric> {
{ "errors", fn.MetricErrors() },
{ "faults", fn.MetricThrottles() }
}
});
Synopsis
Constructors
MathExpressionProps() |
Properties
Color | Color for this metric when added to a Graph in a Dashboard. |
Expression | The expression defining the metric. |
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. |
UsingMetrics | The metrics used in the expression, in a map. |
Constructors
MathExpressionProps()
public MathExpressionProps()
Properties
Color
Color for this metric when added to a Graph in a Dashboard.
public string Color { get; set; }
Property Value
System.String
Remarks
Default: - Automatic color
Expression
The expression defining the metric.
public string Expression { get; set; }
Property Value
System.String
Remarks
When an expression contains a SEARCH function, it cannot be used within an Alarm.
Label
Label for this expression when added to a Graph in a Dashboard.
public string Label { get; set; }
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.
public Duration Period { get; set; }
Property Value
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.
public string SearchAccount { get; set; }
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.
public string SearchRegion { get; set; }
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.
UsingMetrics
The metrics used in the expression, in a map.
public IDictionary<string, IMetric> UsingMetrics { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, IMetric>
Remarks
The key is the identifier that represents the given metric in the expression, and the value is the actual Metric object.
Default: - Empty map.