# TargetTrackingMetricDataQueryProperty

The metric data to return.

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](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_PutScalingPolicy.html) operation when you specify a [TargetTrackingConfiguration](https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_TargetTrackingConfiguration.html) 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](https://docs.aws.amazon.com/autoscaling/ec2/userguide/ec2-auto-scaling-target-tracking-metric-math.html) in the *Amazon EC2 Auto Scaling User Guide* .

- Source: Generated code
- Type last changed: v2.169.0 · 21 Nov 2024

## Example

```ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_autoscaling as autoscaling } from 'aws-cdk-lib';
const targetTrackingMetricDataQueryProperty: autoscaling.CfnScalingPolicy.TargetTrackingMetricDataQueryProperty = {
  id: 'id',

  // the properties below are optional
  expression: 'expression',
  label: 'label',
  metricStat: {
    metric: {
      metricName: 'metricName',
      namespace: 'namespace',

      // the properties below are optional
      dimensions: [{
        name: 'name',
        value: 'value',
      }],
    },
    stat: 'stat',

    // the properties below are optional
    period: 123,
    unit: 'unit',
  },
  period: 123,
  returnData: false,
};
```

## Properties

- `expression`: string — The math expression to perform on the returned data, if this object is performing a math expression.

  This expression can use the `Id` of the other metrics to refer to those metrics, and can also use the `Id` of other expressions to use the result of those expressions.

  Conditional: Within each `TargetTrackingMetricDataQuery` object, you must specify either `Expression` or `MetricStat` , but not both.

- `id`: string (required) — A short name that identifies the object's results in the response.

  This name must be unique among all `TargetTrackingMetricDataQuery` objects 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.

- `label`: string — 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.

- `metricStat`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnScalingPolicy.TargetTrackingMetricStatProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_autoscaling.CfnScalingPolicy.TargetTrackingMetricStatProperty.html) — Information about the metric data to return.

  Conditional: Within each `TargetTrackingMetricDataQuery` object, you must specify either `Expression` or `MetricStat` , but not both.

- `period`: number — 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](https://docs.aws.amazon.com/autoscaling/ec2/userguide/policy-creating-high-resolution-metrics.html) .

- `returnData`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — Indicates whether to return the timestamps and raw data values of this metric.

  If you use any math expressions, specify `true` for this value for only the final math expression that the metric specification is based on. You must specify `false` for `ReturnData` for 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` ).