Skip to content
v2.274.0

CapacityProviderFunctionOptions Struct ​

Options for creating a function associated with a capacity provider.

Example ​

ts
declare const capacityProvider: lambda.CapacityProvider;

const fn = new lambda.Function(this, 'MyFunction', {
  // Runtime must be equal to or newer than NODEJS_LATEST
  runtime: lambda.Runtime.NODEJS_LATEST,
  handler: 'index.handler',
  code: lambda.Code.fromAsset(path.join(__dirname, 'lambda-handler')),
});

// Associate the function with the capacity provider
capacityProvider.addFunction(fn, {
  perExecutionEnvironmentMaxConcurrency: 10,
  executionEnvironmentMemoryGiBPerVCpu: 4,
});

Properties ​

executionEnvironmentMemoryGiBPerVCpuoptionalnumberexecution_environment_memory_gi_b_per_v_cpuoptionalint | floatexecutionEnvironmentMemoryGiBPerVCpuoptionalNumberExecutionEnvironmentMemoryGiBPerVCpuoptionaldoubleExecutionEnvironmentMemoryGiBPerVCpuoptional*float64= 2.0#
Specifies the execution environment memory per VCPU, in GiB.
latestPublishedScalingConfigoptionalLatestPublishedScalingConfiglatest_published_scaling_configoptionalLatestPublishedScalingConfiglatestPublishedScalingConfigoptionalLatestPublishedScalingConfigLatestPublishedScalingConfigoptionalLatestPublishedScalingConfigLatestPublishedScalingConfigoptionalLatestPublishedScalingConfig#
The scaling options that are applied to the $LATEST.PUBLISHED version.

Default: No scaling limitations are applied to the $LATEST.PUBLISHED version.

perExecutionEnvironmentMaxConcurrencyoptionalnumberper_execution_environment_max_concurrencyoptionalint | floatperExecutionEnvironmentMaxConcurrencyoptionalNumberPerExecutionEnvironmentMaxConcurrencyoptionaldoublePerExecutionEnvironmentMaxConcurrencyoptional*float64#
Specifies the maximum number of concurrent invokes a single execution environment can handle.

Default: Maximum is set to 10

publishToLatestPublishedoptionalbooleanpublish_to_latest_publishedoptionalboolpublishToLatestPublishedoptionalBooleanPublishToLatestPublishedoptionalboolPublishToLatestPublishedoptional*bool= True#
A boolean determining whether or not to automatically publish to the $LATEST.PUBLISHED version.