interface PredictiveScalingMetricSpecificationProperty

Language	Type name
.NET	`Amazon.CDK.AWS.ApplicationAutoScaling.CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsapplicationautoscaling#CfnScalingPolicy_PredictiveScalingMetricSpecificationProperty`
Java	`software.amazon.awscdk.services.applicationautoscaling.CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty`
Python	`aws_cdk.aws_applicationautoscaling.CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty`
TypeScript	`aws-cdk-lib` » `aws_applicationautoscaling` » `CfnScalingPolicy` » `PredictiveScalingMetricSpecificationProperty`

This structure specifies the metrics and target utilization settings for a predictive scaling policy.

You must specify either a metric pair, or a load metric and a scaling metric individually. Specifying a metric pair instead of individual metrics provides a simpler way to configure metrics for a scaling policy. You choose the metric pair, and the policy automatically knows the correct sum and average statistics to use for the load metric and the scaling metric.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_applicationautoscaling as appscaling } from 'aws-cdk-lib';
const predictiveScalingMetricSpecificationProperty: appscaling.CfnScalingPolicy.PredictiveScalingMetricSpecificationProperty = {
  targetValue: 123,

  // the properties below are optional
  customizedCapacityMetricSpecification: {
    metricDataQueries: [{
      expression: 'expression',
      id: 'id',
      label: 'label',
      metricStat: {
        metric: {
          dimensions: [{
            name: 'name',
            value: 'value',
          }],
          metricName: 'metricName',
          namespace: 'namespace',
        },
        stat: 'stat',
        unit: 'unit',
      },
      returnData: false,
    }],
  },
  customizedLoadMetricSpecification: {
    metricDataQueries: [{
      expression: 'expression',
      id: 'id',
      label: 'label',
      metricStat: {
        metric: {
          dimensions: [{
            name: 'name',
            value: 'value',
          }],
          metricName: 'metricName',
          namespace: 'namespace',
        },
        stat: 'stat',
        unit: 'unit',
      },
      returnData: false,
    }],
  },
  customizedScalingMetricSpecification: {
    metricDataQueries: [{
      expression: 'expression',
      id: 'id',
      label: 'label',
      metricStat: {
        metric: {
          dimensions: [{
            name: 'name',
            value: 'value',
          }],
          metricName: 'metricName',
          namespace: 'namespace',
        },
        stat: 'stat',
        unit: 'unit',
      },
      returnData: false,
    }],
  },
  predefinedLoadMetricSpecification: {
    predefinedMetricType: 'predefinedMetricType',

    // the properties below are optional
    resourceLabel: 'resourceLabel',
  },
  predefinedMetricPairSpecification: {
    predefinedMetricType: 'predefinedMetricType',

    // the properties below are optional
    resourceLabel: 'resourceLabel',
  },
  predefinedScalingMetricSpecification: {
    predefinedMetricType: 'predefinedMetricType',

    // the properties below are optional
    resourceLabel: 'resourceLabel',
  },
};

Properties

Name	Type	Description
targetValue	`number`	Specifies the target utilization.
customizedCapacityMetricSpecification?	`IResolvable` `\|` `PredictiveScalingCustomizedCapacityMetricProperty`	The customized capacity metric specification.
customizedLoadMetricSpecification?	`IResolvable` `\|` `PredictiveScalingCustomizedLoadMetricProperty`	The customized load metric specification.
customizedScalingMetricSpecification?	`IResolvable` `\|` `PredictiveScalingCustomizedScalingMetricProperty`	The customized scaling metric specification.
predefinedLoadMetricSpecification?	`IResolvable` `\|` `PredictiveScalingPredefinedLoadMetricProperty`	The predefined load metric specification.
predefinedMetricPairSpecification?	`IResolvable` `\|` `PredictiveScalingPredefinedMetricPairProperty`	The predefined metric pair specification that determines the appropriate scaling metric and load metric to use.
predefinedScalingMetricSpecification?	`IResolvable` `\|` `PredictiveScalingPredefinedScalingMetricProperty`	The predefined scaling metric specification.