class ScalingOptions

Language	Type name
.NET	Amazon.CDK.AWS.Lambda.ScalingOptions
Go	github.com/aws/aws-cdk-go/awscdk/v2/awslambda#ScalingOptions
Java	software.amazon.awscdk.services.lambda.ScalingOptions
Python	aws_cdk.aws_lambda.ScalingOptions
TypeScript (source)	aws-cdk-lib » aws_lambda » ScalingOptions

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

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

Name	Type	Description
scalingMode	string	The scaling mode for the capacity provider.
scalingPolicies?	TargetTrackingScalingPolicy[]	The target tracking scaling policies used when scaling mode is 'Manual'.

---

scalingMode

Type: string

The scaling mode for the capacity provider.

---

scalingPolicies?

Type: TargetTrackingScalingPolicy[] (optional)

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

Methods

Name	Description
static auto()	Creates scaling options where the capacity provider manages scaling automatically.
static manual(scalingPolicies)	Creates manual scaling options with custom target tracking scaling policies.

---

static auto()

public static auto(): ScalingOptions

Returns

• ScalingOptions

Creates scaling options where the capacity provider manages scaling automatically.

---

static manual(scalingPolicies)

public static manual(scalingPolicies: TargetTrackingScalingPolicy[]): ScalingOptions

Parameters

• scalingPolicies TargetTrackingScalingPolicy[] — The target tracking scaling policies to use for manual scaling.

Returns

• ScalingOptions

Creates manual scaling options with custom target tracking scaling policies.

At least one policy is required.