aws-cdk-lib.aws_lambda.ScalingOptions

ScalingOptions Class

Configuration options for scaling a capacity provider, including scaling mode and policies.

Source

aws-lambda/lib/capacity-provider.ts

Type last changed

v2.231.0 · 1 Dec 2025

Example

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),
  ]),
});

Properties

scalingModestringscaling_modestrscalingModeStringScalingModestringScalingMode*stringrequired#

The scaling mode for the capacity provider.

scalingPoliciesTargetTrackingScalingPolicy[]scaling_policiestyping.List[TargetTrackingScalingPolicy]scalingPoliciesList<TargetTrackingScalingPolicy>ScalingPoliciesTargetTrackingScalingPolicy[]ScalingPolicies*[]TargetTrackingScalingPolicy#

The target tracking scaling policies used when scaling mode is 'Manual'.

Methods

auto(): ScalingOptions // chainable@staticmethod def auto() -> ScalingOptionspublic static ScalingOptions auto()public static ScalingOptions Auto()func Auto() ScalingOptionsstatic#

Creates scaling options where the capacity provider manages scaling automatically.

manual(scalingPolicies: TargetTrackingScalingPolicy[]): ScalingOptions // chainable@staticmethod def manual(scaling_policies: typing.List[TargetTrackingScalingPolicy]) -> ScalingOptionspublic static ScalingOptions manual(List<TargetTrackingScalingPolicy> scalingPolicies)public static ScalingOptions Manual(TargetTrackingScalingPolicy[] scalingPolicies)func Manual(ScalingPolicies *[]TargetTrackingScalingPolicy) ScalingOptionsstatic#

Creates manual scaling options with custom target tracking scaling policies.

At least one policy is required.

1 parameter

Parameters

• scalingPoliciesscaling_policiesscalingPoliciesscalingPoliciesScalingPolicies — The target tracking scaling policies to use for manual scaling.