Interface CfnScalingPolicy.TargetTrackingMetricDataQueryProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnScalingPolicy.TargetTrackingMetricDataQueryProperty.Jsii$Proxy
- Enclosing class:
CfnScalingPolicy
Also defines whether this call is returning data for one metric only, or whether it is performing a math expression on the values of returned metric statistics to create a new time series. A time series is a series of data points, each of which is associated with a timestamp.
You can use TargetTrackingMetricDataQuery structures with a PutScalingPolicy operation when you specify a TargetTrackingConfiguration in the request.
You can call for a single metric or perform math expressions on multiple metrics. Any expressions used in a metric specification must eventually return a single time series.
For more information, see the Create a target tracking scaling policy for Amazon EC2 Auto Scaling using metric math in the Amazon EC2 Auto Scaling User Guide .
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.autoscaling.*;
TargetTrackingMetricDataQueryProperty targetTrackingMetricDataQueryProperty = TargetTrackingMetricDataQueryProperty.builder()
.id("id")
// the properties below are optional
.expression("expression")
.label("label")
.metricStat(TargetTrackingMetricStatProperty.builder()
.metric(MetricProperty.builder()
.metricName("metricName")
.namespace("namespace")
// the properties below are optional
.dimensions(List.of(MetricDimensionProperty.builder()
.name("name")
.value("value")
.build()))
.build())
.stat("stat")
// the properties below are optional
.period(123)
.unit("unit")
.build())
.period(123)
.returnData(false)
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forCfnScalingPolicy.TargetTrackingMetricDataQueryPropertystatic final classAn implementation forCfnScalingPolicy.TargetTrackingMetricDataQueryProperty -
Method Summary
Modifier and TypeMethodDescriptionbuilder()default StringThe math expression to perform on the returned data, if this object is performing a math expression.getId()A short name that identifies the object's results in the response.default StringgetLabel()A human-readable label for this metric or expression.default ObjectInformation about the metric data to return.default NumberThe period of the metric in seconds.default ObjectIndicates whether to return the timestamps and raw data values of this metric.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getId
A short name that identifies the object's results in the response.This name must be unique among all
TargetTrackingMetricDataQueryobjects specified for a single scaling policy. If you are performing math expressions on this set of data, this name represents that data and can serve as a variable in the mathematical expression. The valid characters are letters, numbers, and underscores. The first character must be a lowercase letter.- See Also:
-
getExpression
The math expression to perform on the returned data, if this object is performing a math expression.This expression can use the
Idof the other metrics to refer to those metrics, and can also use theIdof other expressions to use the result of those expressions.Conditional: Within each
TargetTrackingMetricDataQueryobject, you must specify eitherExpressionorMetricStat, but not both.- See Also:
-
getLabel
A human-readable label for this metric or expression.This is especially useful if this is a math expression, so that you know what the value represents.
- See Also:
-
getMetricStat
Information about the metric data to return.Conditional: Within each
TargetTrackingMetricDataQueryobject, you must specify eitherExpressionorMetricStat, but not both.Returns union: either
IResolvableorCfnScalingPolicy.TargetTrackingMetricStatProperty- See Also:
-
getPeriod
The period of the metric in seconds.The default value is 60. Accepted values are 10, 30, and 60. For high resolution metric, set the value to less than 60. For more information, see Create a target tracking policy using high-resolution metrics for faster response .
- See Also:
-
getReturnData
Indicates whether to return the timestamps and raw data values of this metric.If you use any math expressions, specify
truefor this value for only the final math expression that the metric specification is based on. You must specifyfalseforReturnDatafor all the other metrics and expressions used in the metric specification.If you are only retrieving metrics and not performing any math expressions, do not specify anything for
ReturnData. This sets it to its default (true).Returns union: either
BooleanorIResolvable- See Also:
-
builder
-