Skip to content
v2.277.0

TargetTrackingScalingPolicy Class ​

A target tracking scaling policy that automatically adjusts the capacity provider's compute resources to maintain a specified target value by tracking the required CloudWatch metric.

Example ​

ts
import * as ec2 from 'aws-cdk-lib/aws-ec2';

const vpc = new ec2.Vpc(this, 'MyVpc');
const securityGroup = new ec2.SecurityGroup(this, 'SecurityGroup', { vpc });

const capacityProvider = new lambda.CapacityProvider(this, 'MyCapacityProvider', {
  subnets: vpc.privateSubnets,
  securityGroups: [securityGroup],
  scalingOptions: lambda.ScalingOptions.manual([
    lambda.TargetTrackingScalingPolicy.cpuUtilization(70),
  ]),
});
python
import aws_cdk.aws_ec2 as ec2


vpc = ec2.Vpc(self, "MyVpc")
security_group = ec2.SecurityGroup(self, "SecurityGroup", vpc=vpc)

capacity_provider = lambda_.CapacityProvider(self, "MyCapacityProvider",
    subnets=vpc.private_subnets,
    security_groups=[security_group],
    scaling_options=lambda_.ScalingOptions.manual([
        lambda_.TargetTrackingScalingPolicy.cpu_utilization(70)
    ])
)
java
import software.amazon.awscdk.services.ec2.*;


Vpc vpc = new Vpc(this, "MyVpc");
SecurityGroup securityGroup = SecurityGroup.Builder.create(this, "SecurityGroup").vpc(vpc).build();

CapacityProvider capacityProvider = CapacityProvider.Builder.create(this, "MyCapacityProvider")
        .subnets(vpc.getPrivateSubnets())
        .securityGroups(List.of(securityGroup))
        .scalingOptions(ScalingOptions.manual(List.of(TargetTrackingScalingPolicy.cpuUtilization(70))))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.EC2;


var vpc = new Vpc(this, "MyVpc");
var securityGroup = new SecurityGroup(this, "SecurityGroup", new SecurityGroupProps { Vpc = vpc });

var capacityProvider = new CapacityProvider(this, "MyCapacityProvider", new CapacityProviderProps {
    Subnets = vpc.PrivateSubnets,
    SecurityGroups = new [] { securityGroup },
    ScalingOptions = ScalingOptions.Manual(new [] { TargetTrackingScalingPolicy.CpuUtilization(70) })
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import "github.com/aws/aws-cdk-go/awscdk"


vpc := ec2.NewVpc(this, jsii.String("MyVpc"))
securityGroup := ec2.NewSecurityGroup(this, jsii.String("SecurityGroup"), &SecurityGroupProps{
	Vpc: Vpc,
})

capacityProvider := lambda.NewCapacityProvider(this, jsii.String("MyCapacityProvider"), &CapacityProviderProps{
	Subnets: vpc.PrivateSubnets,
	SecurityGroups: []ISecurityGroup{
		securityGroup,
	},
	ScalingOptions: lambda.ScalingOptions_Manual([]TargetTrackingScalingPolicy{
		lambda.TargetTrackingScalingPolicy_CpuUtilization(jsii.Number(70)),
	}),
})

Properties ​

metricTypestringmetric_typestrmetricTypeStringMetricTypestringMetricType*string #
The predefined metric type.
predefinedMetricTypestringpredefined_metric_typestrpredefinedMetricTypeStringPredefinedMetricTypestringPredefinedMetricType*string #
The predefined metric type for this scaling policy.
targetValuenumbertarget_valueint | floattargetValueNumberTargetValuedoubleTargetValue*float64 #
The target value for the specified metric as a percentage.

The capacity provider will scale resources to maintain this target value.

valuenumbervalueint | floatvalueNumberValuedoubleValue*float64 #
The target value for the metric.

Methods ​

cpuUtilization(targetCpuUtilization: number): TargetTrackingScalingPolicy // chainable@staticmethod def cpu_utilization(target_cpu_utilization: int | float) -> TargetTrackingScalingPolicypublic static TargetTrackingScalingPolicy cpuUtilization(Number targetCpuUtilization)public static TargetTrackingScalingPolicy CpuUtilization(double targetCpuUtilization)func CpuUtilization(TargetCpuUtilization *float64) TargetTrackingScalingPolicy static #
Creates a target tracking scaling policy for CPU utilization.
1 parameter

Parameters

  • targetCpuUtilizationtarget_cpu_utilizationtargetCpuUtilizationtargetCpuUtilizationTargetCpuUtilization — The target value for CPU utilization.