Package software.amazon.awscdk.services.lambda

Interface CapacityProviderFunctionOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CapacityProviderFunctionOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)",
           date="2025-12-12T17:54:16.193Z")
@Stability(Stable)
public interface CapacityProviderFunctionOptions
extends software.amazon.jsii.JsiiSerializable

Options for creating a function associated with a capacity provider.

Example:

 CapacityProvider capacityProvider;
 Function fn = Function.Builder.create(this, "MyFunction")
         // Runtime must be equal to or newer than NODEJS_22_X
         .runtime(Runtime.NODEJS_22_X)
         .handler("index.handler")
         .code(Code.fromAsset(join(__dirname, "lambda-handler")))
         .build();
 // Associate the function with the capacity provider
 capacityProvider.addFunction(fn, CapacityProviderFunctionOptions.builder()
         .perExecutionEnvironmentMaxConcurrency(10)
         .executionEnvironmentMemoryGiBPerVCpu(4)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CapacityProviderFunctionOptions.Builder	A builder for CapacityProviderFunctionOptions
static final class	CapacityProviderFunctionOptions.Jsii$Proxy	An implementation for CapacityProviderFunctionOptions

Method Summary

Modifier and Type	Method	Description
static CapacityProviderFunctionOptions.Builder	builder()
default Number	getExecutionEnvironmentMemoryGiBPerVCpu()	Specifies the execution environment memory per VCPU, in GiB.
default LatestPublishedScalingConfig	getLatestPublishedScalingConfig()	The scaling options that are applied to the $LATEST.PUBLISHED version.
default Number	getPerExecutionEnvironmentMaxConcurrency()	Specifies the maximum number of concurrent invokes a single execution environment can handle.
default Boolean	getPublishToLatestPublished()	A boolean determining whether or not to automatically publish to the $LATEST.PUBLISHED version.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getExecutionEnvironmentMemoryGiBPerVCpu

@Stability(Stable)
@Nullable
default Number getExecutionEnvironmentMemoryGiBPerVCpu()

Specifies the execution environment memory per VCPU, in GiB.

Default: 2.0

getLatestPublishedScalingConfig

@Stability(Stable)
@Nullable
default LatestPublishedScalingConfig getLatestPublishedScalingConfig()

The scaling options that are applied to the $LATEST.PUBLISHED version.

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

getPerExecutionEnvironmentMaxConcurrency

@Stability(Stable)
@Nullable
default Number getPerExecutionEnvironmentMaxConcurrency()

Specifies the maximum number of concurrent invokes a single execution environment can handle.

Default: Maximum is set to 10

getPublishToLatestPublished

@Stability(Stable)
@Nullable
default Boolean getPublishToLatestPublished()

A boolean determining whether or not to automatically publish to the $LATEST.PUBLISHED version.

Default: - True

builder

@Stability(Stable)
static CapacityProviderFunctionOptions.Builder builder()

Returns:

a CapacityProviderFunctionOptions.Builder of CapacityProviderFunctionOptions