CapacityProviderProps Struct
Properties for creating a Lambda capacity provider.
| Source | aws-lambda/lib/capacity-provider.ts |
|---|---|
| Type last changed |
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),
]),
});
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)
])
)
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();
// 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) })
});
// 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
architecturesoptionalArchitecture[]architecturesoptionaltyping.List[Architecture]architecturesoptionalList<Architecture>ArchitecturesoptionalArchitecture[]Architecturesoptional*[]Architecture #Default: No architecture constraints specified
Only one architecture can be specified per capacity provider.
capacityProviderNameoptionalstringcapacity_provider_nameoptionalstrcapacityProviderNameoptionalStringCapacityProviderNameoptionalstringCapacityProviderNameoptional*string #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 #Default: No instance type filtering applied
Default: No KMS key specified, uses an AWS-managed key instead
logGroupoptionalILogGroupReflog_groupoptionalILogGroupReflogGroupoptionalILogGroupRefLogGroupoptionalILogGroupRefLogGroupoptionalILogGroupRef #Default: Service creates a default log group at /aws/lambda/capacity-provider/<name>
maxVCpuCountoptionalnumbermax_v_cpu_countoptionalint | floatmaxVCpuCountoptionalNumberMaxVCpuCountoptionaldoubleMaxVCpuCountoptional*float64 #Default: No maximum limit specified, service default is 400
operatorRoleoptionalIRoleoperator_roleoptionalIRoleoperatorRoleoptionalIRoleOperatorRoleoptionalIRoleOperatorRoleoptionalIRole #Default: A role will be generated containing the AWSLambdaManagedEC2ResourceOperator managed policy
propagateTagsoptionalPropagateTagspropagate_tagsoptionalPropagateTagspropagateTagsoptionalPropagateTagsPropagateTagsoptionalPropagateTagsPropagateTagsoptionalPropagateTags #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 propagationPropagateTags.explicit(tags)- Propagate specified tags
scalingOptionsoptionalScalingOptionsscaling_optionsoptionalScalingOptionsscalingOptionsoptionalScalingOptionsScalingOptionsoptionalScalingOptionsScalingOptionsoptionalScalingOptions #Default: The Auto option is applied by default
securityGroupsISecurityGroup[]security_groupstyping.List[ISecurityGroup]securityGroupsList<ISecurityGroup>SecurityGroupsISecurityGroup[]SecurityGroups*[]ISecurityGroup required #Up to 5 security groups can be specified.
subnetsISubnet[]subnetstyping.List[ISubnet]subnetsList<ISubnet>SubnetsISubnet[]Subnets*[]ISubnet required #At least one subnet must be specified, and up to 16 subnets are supported.
systemLogLeveloptionalSystemLogLevelsystem_log_leveloptionalSystemLogLevelsystemLogLeveloptionalSystemLogLevelSystemLogLeveloptionalSystemLogLevelSystemLogLeveloptionalSystemLogLevel #Default: Service default applies (INFO)