aws-cdk-lib.aws_autoscaling.BasicTargetTrackingScalingPolicyProps

BasicTargetTrackingScalingPolicyProps Struct

Properties for a Target Tracking policy that include the metric but exclude the target.

BasicTargetTrackingScalingPolicyProps

extends

• BaseTargetTrackingProps

Source

aws-autoscaling/lib/target-tracking-scaling-policy.ts

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_autoscaling as autoscaling } from 'aws-cdk-lib';
import { aws_cloudwatch as cloudwatch } from 'aws-cdk-lib';

declare const metric: cloudwatch.Metric;
const basicTargetTrackingScalingPolicyProps: autoscaling.BasicTargetTrackingScalingPolicyProps = {
  targetValue: 123,

  // the properties below are optional
  cooldown: cdk.Duration.minutes(30),
  customMetric: metric,
  disableScaleIn: false,
  estimatedInstanceWarmup: cdk.Duration.minutes(30),
  predefinedMetric: autoscaling.PredefinedMetric.ASG_AVERAGE_CPU_UTILIZATION,
  resourceLabel: 'resourceLabel',
};

Properties

cooldown?optionalDurationcooldown?optionalDurationcooldown?optionalDurationCooldown?optionalDurationCooldown?optionalDuration#

Period after a scaling completes before another scaling activity can start.

Default: The default cooldown configured on the AutoScalingGroup.

customMetric?optionalIMetriccustom_metric?optionalIMetriccustomMetric?optionalIMetricCustomMetric?optionalIMetricCustomMetric?optionalIMetric#

A custom metric for application autoscaling.

Default: No custom metric.

notes

The metric must track utilization. Scaling out will happen if the metric is higher than the target value, scaling in will happen in the metric is lower than the target value.

Exactly one of customMetric or predefinedMetric must be specified.

disableScaleIn?optionalbooleandisable_scale_in?optionalbooldisableScaleIn?optionalBooleanDisableScaleIn?optionalboolDisableScaleIn?optional*bool= false#

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

If the value is true, scale in is disabled and the target tracking policy won't remove capacity from the autoscaling group. Otherwise, scale in is enabled and the target tracking policy can remove capacity from the group.

estimatedInstanceWarmup?optionalDurationestimated_instance_warmup?optionalDurationestimatedInstanceWarmup?optionalDurationEstimatedInstanceWarmup?optionalDurationEstimatedInstanceWarmup?optionalDuration#

Estimated time until a newly launched instance can send metrics to CloudWatch.

Default: Same as the cooldown.

predefinedMetric?optionalPredefinedMetricpredefined_metric?optionalPredefinedMetricpredefinedMetric?optionalPredefinedMetricPredefinedMetric?optionalPredefinedMetricPredefinedMetric?optionalPredefinedMetric#

A predefined metric for application autoscaling.

Default: No predefined metric.

notes

The metric must track utilization. Scaling out will happen if the metric is higher than the target value, scaling in will happen in the metric is lower than the target value.

Exactly one of customMetric or predefinedMetric must be specified.

resourceLabel?optionalstringresource_label?optionalstrresourceLabel?optionalStringResourceLabel?optionalstringResourceLabel?optional*string#

The resource label associated with the predefined metric.

Default: No resource label.

Should be supplied if the predefined metric is ALBRequestCountPerTarget, and the format should be:

app/<load-balancer-name>/<load-balancer-id>/targetgroup/<target-group-name>/<target-group-id>

targetValuenumbertarget_valueint | floattargetValueNumberTargetValuedoubleTargetValue*float64required#

The target value for the metric.