interface MetricDataQueryProperty

Language	Type name
.NET	`Amazon.CDK.AWS.AutoScaling.CfnScalingPolicy.MetricDataQueryProperty`
Java	`software.amazon.awscdk.services.autoscaling.CfnScalingPolicy.MetricDataQueryProperty`
Python	`aws_cdk.aws_autoscaling.CfnScalingPolicy.MetricDataQueryProperty`
TypeScript	`@aws-cdk/aws-autoscaling` » `CfnScalingPolicy` » `MetricDataQueryProperty`

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.

MetricDataQuery is a property of the following property types:

Predictive scaling uses the time series data received from CloudWatch to understand how to schedule capacity based on your historical workload patterns.

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 and examples, see Advanced predictive scaling policy configurations using custom metrics 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 * as autoscaling from '@aws-cdk/aws-autoscaling';
const metricDataQueryProperty: autoscaling.CfnScalingPolicy.MetricDataQueryProperty = {
  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
    unit: 'unit',
  },
  returnData: false,
};

Properties

Name	Type	Description
id	`string`	A short name that identifies the object's results in the response.
expression?	`string`	The math expression to perform on the returned data, if this object is performing a math expression.
label?	`string`	A human-readable label for this metric or expression.
metricStat?	`IResolvable` `\|` `MetricStatProperty`	Information about the metric data to return.
returnData?	`boolean \|` `IResolvable`	Indicates whether to return the timestamps and raw data values of this metric.

id

Type: string

A short name that identifies the object's results in the response.

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

expression?

Type: string (optional)

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 MetricDataQuery object, you must specify either Expression or MetricStat , but not both.

label?

Type: string (optional)

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?

Type: IResolvable | MetricStatProperty (optional)

Information about the metric data to return.

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

returnData?

Type: boolean | IResolvable (optional)

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 ).