MathExpressionOptions Struct
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 * as cdk from 'aws-cdk-lib';
import { aws_cloudwatch as cloudwatch } from 'aws-cdk-lib';
const mathExpressionOptions: cloudwatch.MathExpressionOptions = {
color: 'color',
label: 'label',
period: cdk.Duration.minutes(30),
searchAccount: 'searchAccount',
searchRegion: 'searchRegion',
visible: false,
};
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk as cdk
from aws_cdk import aws_cloudwatch as cloudwatch
math_expression_options = cloudwatch.MathExpressionOptions(
color="color",
label="label",
period=cdk.Duration.minutes(30),
search_account="searchAccount",
search_region="searchRegion",
visible=False
)
// 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")
.visible(false)
.build();
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.CloudWatch;
var mathExpressionOptions = new MathExpressionOptions {
Color = "color",
Label = "label",
Period = Duration.Minutes(30),
SearchAccount = "searchAccount",
SearchRegion = "searchRegion",
Visible = false
};
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
mathExpressionOptions := &MathExpressionOptions{
Color: jsii.String("color"),
Label: jsii.String("label"),
Period: cdk.Duration_Minutes(jsii.Number(30)),
SearchAccount: jsii.String("searchAccount"),
SearchRegion: jsii.String("searchRegion"),
Visible: jsii.Boolean(false),
}
Properties
Default: Automatic color
Default: Expression value is used as label
notes
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.
periodoptionalDurationperiodoptionalDurationperiodoptionalDurationPeriodoptionalDurationPeriodoptionalDuration= Duration.minutes(5)#This period overrides all periods in the metrics used in this math expression.
searchAccountoptionalstringsearch_accountoptionalstrsearchAccountoptionalStringSearchAccountoptionalstringSearchAccountoptional*string#Default: Deployment account.
Specifying a searchAccount has no effect to the account used for metrics within the expression (passed via usingMetrics).
searchRegionoptionalstringsearch_regionoptionalstrsearchRegionoptionalStringSearchRegionoptionalstringSearchRegionoptional*string#Default: Deployment region.
Specifying a searchRegion has no effect to the region used for metrics within the expression (passed via usingMetrics).
visibleoptionalbooleanvisibleoptionalboolvisibleoptionalBooleanVisibleoptionalboolVisibleoptional*bool= true#Setting this to false is useful when you want to hide raw metrics that are used in math expressions, and show only the expression results.