interface TargetTrackingScalingPolicyConfigurationProperty

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

TargetTrackingScalingPolicyConfiguration is a property of the AWS::ApplicationAutoScaling::ScalingPolicy resource that specifies a target tracking scaling policy configuration for Application Auto Scaling. Use a target tracking scaling policy to adjust the capacity of the specified scalable target in response to actual workloads, so that resource utilization remains at or near the target utilization value.

For more information, see Target tracking scaling policies in the Application 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 { aws_applicationautoscaling as appscaling } from 'aws-cdk-lib';
const targetTrackingScalingPolicyConfigurationProperty: appscaling.CfnScalingPolicy.TargetTrackingScalingPolicyConfigurationProperty = {
  targetValue: 123,

  // the properties below are optional
  customizedMetricSpecification: {
    dimensions: [{
      name: 'name',
      value: 'value',
    }],
    metricName: 'metricName',
    metrics: [{
      expression: 'expression',
      id: 'id',
      label: 'label',
      metricStat: {
        metric: {
          dimensions: [{
            name: 'name',
            value: 'value',
          }],
          metricName: 'metricName',
          namespace: 'namespace',
        },
        stat: 'stat',
        unit: 'unit',
      },
      returnData: false,
    }],
    namespace: 'namespace',
    statistic: 'statistic',
    unit: 'unit',
  },
  disableScaleIn: false,
  predefinedMetricSpecification: {
    predefinedMetricType: 'predefinedMetricType',

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

Properties

Name	Type	Description
targetValue	`number`	The target value for the metric.
customizedMetricSpecification?	`IResolvable` `\|` `CustomizedMetricSpecificationProperty`	A customized metric.
disableScaleIn?	`boolean \|` `IResolvable`	Indicates whether scale in by the target tracking scaling policy is disabled.
predefinedMetricSpecification?	`IResolvable` `\|` `PredefinedMetricSpecificationProperty`	A predefined metric.
scaleInCooldown?	`number`	The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.
scaleOutCooldown?	`number`	The amount of time, in seconds, to wait for a previous scale-out activity to take effect.

targetValue

Type: number

The target value for the metric.

Although this property accepts numbers of type Double, it won't accept values that are either too small or too large. Values must be in the range of -2^360 to 2^360. The value must be a valid number based on the choice of metric. For example, if the metric is CPU utilization, then the target value is a percent value that represents how much of the CPU can be used before scaling out.

customizedMetricSpecification?

Type: IResolvable | CustomizedMetricSpecificationProperty (optional)

A customized metric.

You can specify either a predefined metric or a customized metric.

disableScaleIn?

Type: boolean | IResolvable (optional)

Indicates whether scale in by the target tracking scaling policy is disabled.

If the value is true , scale in is disabled and the target tracking scaling policy won't remove capacity from the scalable target. Otherwise, scale in is enabled and the target tracking scaling policy can remove capacity from the scalable target. The default value is false .

predefinedMetricSpecification?

Type: IResolvable | PredefinedMetricSpecificationProperty (optional)

A predefined metric.

You can specify either a predefined metric or a customized metric.

scaleInCooldown?

Type: number (optional)

The amount of time, in seconds, after a scale-in activity completes before another scale-in activity can start.

For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide .

scaleOutCooldown?

Type: number (optional)

The amount of time, in seconds, to wait for a previous scale-out activity to take effect.

For more information and for default values, see Define cooldown periods in the Application Auto Scaling User Guide .