Interface CfnServiceLevelObjective.MetricDataQueryProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnServiceLevelObjective.MetricDataQueryProperty.Jsii$Proxy
- Enclosing class:
CfnServiceLevelObjective
Each MetricDataQuery
in the MetricDataQueries
array specifies either a metric to retrieve, or a metric math expression to be performed on retrieved metrics. A single MetricDataQueries
array can include as many as 20 MetricDataQuery
structures in the array. The 20 structures can include as many as 10 structures that contain a MetricStat
parameter to retrieve a metric, and as many as 10 structures that contain the Expression
parameter to perform a math expression. Of those Expression
structures, exactly one must have true as the value for ReturnData
. The result of this expression used for the SLO.
For more information about metric math expressions, see Use metric math .
Within each MetricDataQuery
object, you must specify either Expression
or MetricStat
but not both.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.applicationsignals.*; MetricDataQueryProperty metricDataQueryProperty = MetricDataQueryProperty.builder() .id("id") // the properties below are optional .accountId("accountId") .expression("expression") .metricStat(MetricStatProperty.builder() .metric(MetricProperty.builder() .dimensions(List.of(DimensionProperty.builder() .name("name") .value("value") .build())) .metricName("metricName") .namespace("namespace") .build()) .period(123) .stat("stat") // the properties below are optional .unit("unit") .build()) .returnData(false) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnServiceLevelObjective.MetricDataQueryProperty
static final class
An implementation forCfnServiceLevelObjective.MetricDataQueryProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default String
The ID of the account where this metric is located.default String
This field can contain a metric math expression to be performed on the other metrics that you are retrieving within thisMetricDataQueries
structure.getId()
A short name used to tie this object to the results in the response.default Object
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.default Object
Use this only if you are using a metric math expression for the SLO.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getId
A short name used to tie this object to the results in the response.This
Id
must be unique within aMetricDataQueries
array. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the metric math expression. The valid characters are letters, numbers, and underscore. The first character must be a lowercase letter.- See Also:
-
getAccountId
The ID of the account where this metric is located.If you are performing this operation in a monitoring account, use this to specify which source account to retrieve this metric from.
- See Also:
-
getExpression
This field can contain a metric math expression to be performed on the other metrics that you are retrieving within thisMetricDataQueries
structure.A math expression can use the
Id
of the other metrics or queries to refer to those metrics, and can also use theId
of other expressions to use the result of those expressions. For more information about metric math expressions, see Metric Math Syntax and Functions in the Amazon CloudWatch User Guide .Within each
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
but not both.- See Also:
-
getMetricStat
A metric to be used directly for the SLO, or to be used in the math expression that will be used for the SLO.Within one
MetricDataQuery
object, you must specify eitherExpression
orMetricStat
but not both.- See Also:
-
getReturnData
Use this only if you are using a metric math expression for the SLO.Specify
true
forReturnData
for only the one expression result to use as the alarm. For all other metrics and expressions in the sameCreateServiceLevelObjective
operation, specifyReturnData
asfalse
.- See Also:
-
builder
-