Skip to content
v2.277.0

CapacityProviderProps Struct ​

Properties for creating a Lambda capacity provider.

Example ​

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

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],
  logGroup: new logs.LogGroup(this, 'CpLogs', {
    logGroupName: '/aws/lambda/capacity-provider/my-cp',
  }),
  systemLogLevel: lambda.SystemLogLevel.DEBUG,
});
python
import aws_cdk.aws_ec2 as ec2
import aws_cdk.aws_logs as logs


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],
    log_group=logs.LogGroup(self, "CpLogs",
        log_group_name="/aws/lambda/capacity-provider/my-cp"
    ),
    system_log_level=lambda_.SystemLogLevel.DEBUG
)
java
import software.amazon.awscdk.services.ec2.*;
import software.amazon.awscdk.services.logs.*;


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))
        .logGroup(LogGroup.Builder.create(this, "CpLogs")
                .logGroupName("/aws/lambda/capacity-provider/my-cp")
                .build())
        .systemLogLevel(SystemLogLevel.DEBUG)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.Logs;


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 },
    LogGroup = new LogGroup(this, "CpLogs", new LogGroupProps {
        LogGroupName = "/aws/lambda/capacity-provider/my-cp"
    }),
    SystemLogLevel = SystemLogLevel.DEBUG
});
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import "github.com/aws/aws-cdk-go/awscdk"
import logs "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,
	},
	LogGroup: logs.NewLogGroup(this, jsii.String("CpLogs"), &LogGroupProps{
		LogGroupName: jsii.String("/aws/lambda/capacity-provider/my-cp"),
	}),
	SystemLogLevel: lambda.SystemLogLevel_DEBUG,
})

Properties ​

architecturesoptionalArchitecture[]architecturesoptionaltyping.List[Architecture]architecturesoptionalList<Architecture>ArchitecturesoptionalArchitecture[]Architecturesoptional*[]Architecture #
The instruction set architecture required for compute instances.

Default: No architecture constraints specified

Only one architecture can be specified per capacity provider.

capacityProviderNameoptionalstringcapacity_provider_nameoptionalstrcapacityProviderNameoptionalStringCapacityProviderNameoptionalstringCapacityProviderNameoptional*string #
The name of the capacity provider.

Default: AWS CloudFormation generates a unique physical ID and uses that ID for the capacity provider's name.

The name must be unique within the AWS account and region.

instanceTypeFilteroptionalInstanceTypeFilterinstance_type_filteroptionalInstanceTypeFilterinstanceTypeFilteroptionalInstanceTypeFilterInstanceTypeFilteroptionalInstanceTypeFilterInstanceTypeFilteroptionalInstanceTypeFilter #
Configuration for filtering instance types that the capacity provider can use.

Default: No instance type filtering applied

kmsKeyoptionalIKeykms_keyoptionalIKeykmsKeyoptionalIKeyKmsKeyoptionalIKeyKmsKeyoptionalIKey #
The AWS Key Management Service (KMS) key used to encrypt data associated with the capacity provider.

Default: No KMS key specified, uses an AWS-managed key instead

logGroupoptionalILogGroupReflog_groupoptionalILogGroupReflogGroupoptionalILogGroupRefLogGroupoptionalILogGroupRefLogGroupoptionalILogGroupRef #
The CloudWatch log group for capacity provider system logs.

Default: Service creates a default log group at /aws/lambda/capacity-provider/<name>

maxVCpuCountoptionalnumbermax_v_cpu_countoptionalint | floatmaxVCpuCountoptionalNumberMaxVCpuCountoptionaldoubleMaxVCpuCountoptional*float64 #
The maximum number of vCPUs that the capacity provider can scale up to.

Default: No maximum limit specified, service default is 400

operatorRoleoptionalIRoleoperator_roleoptionalIRoleoperatorRoleoptionalIRoleOperatorRoleoptionalIRoleOperatorRoleoptionalIRole #
The IAM role that the Lambda service assumes to manage the capacity provider.

Default: A role will be generated containing the AWSLambdaManagedEC2ResourceOperator managed policy

propagateTagsoptionalPropagateTagspropagate_tagsoptionalPropagateTagspropagateTagsoptionalPropagateTagsPropagateTagsoptionalPropagateTagsPropagateTagsoptionalPropagateTags #
Configuration for tag propagation to managed resources (EC2 instances, ENIs, EBS volumes).

Default: No tag propagation; tags are not propagated to managed resources.

Use the static factory methods on PropagateTags to create:

  • PropagateTags.none() - Explicitly disable tag propagation
  • PropagateTags.explicit(tags) - Propagate specified tags
scalingOptionsoptionalScalingOptionsscaling_optionsoptionalScalingOptionsscalingOptionsoptionalScalingOptionsScalingOptionsoptionalScalingOptionsScalingOptionsoptionalScalingOptions #
The options for scaling a capacity provider, including scaling policies.

Default: The Auto option is applied by default

securityGroupsISecurityGroup[]security_groupstyping.List[ISecurityGroup]securityGroupsList<ISecurityGroup>SecurityGroupsISecurityGroup[]SecurityGroups*[]ISecurityGroup required #
A list of security group IDs to associate with EC2 instances launched by the capacity provider.

Up to 5 security groups can be specified.

subnetsISubnet[]subnetstyping.List[ISubnet]subnetsList<ISubnet>SubnetsISubnet[]Subnets*[]ISubnet required #
A list of subnets where the capacity provider can launch EC2 instances.

At least one subnet must be specified, and up to 16 subnets are supported.

systemLogLeveloptionalSystemLogLevelsystem_log_leveloptionalSystemLogLevelsystemLogLeveloptionalSystemLogLevelSystemLogLeveloptionalSystemLogLevelSystemLogLeveloptionalSystemLogLevel #
The level of detail for capacity provider system logs.

Default: Service default applies (INFO)