Package software.amazon.awscdk.services.lambda

Interface ProvisionedPollerConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ProvisionedPollerConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.129.0 (build eaca441)",
           date="2026-05-13T16:55:12.141Z")
@Stability(Stable)
public interface ProvisionedPollerConfig
extends software.amazon.jsii.JsiiSerializable

(Amazon MSK and self-managed Apache Kafka only) The provisioned mode configuration for the event source.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lambda.*;
 ProvisionedPollerConfig provisionedPollerConfig = ProvisionedPollerConfig.builder()
         .maximumPollers(123)
         .minimumPollers(123)
         .pollerGroupName("pollerGroupName")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static ProvisionedPollerConfig.Builder	builder()
default Number	getMaximumPollers()	The maximum number of pollers that can be provisioned.
default Number	getMinimumPollers()	The minimum number of pollers that should be provisioned.
default String	getPollerGroupName()	An optional identifier that groups multiple ESMs to share EPU capacity and reduce costs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMaximumPollers

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

The maximum number of pollers that can be provisioned.

Valid Range:

• For Amazon SQS: Minimum value of 2. Maximum value of 2000. Default: 200.
• For Amazon MSK, self-managed Apache Kafka, and Amazon MQ: Minimum value of 1. Maximum value of 2000. Default: 200.

Default: 200

getMinimumPollers

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

The minimum number of pollers that should be provisioned.

Valid Range:

• For Amazon SQS: Minimum value of 2. Maximum value of 200. Default: 2.
• For Amazon MSK, self-managed Apache Kafka, and Amazon MQ: Minimum value of 1. Maximum value of 200. Default: 1.

Default: - 2 for SQS, 1 for MSK/Kafka/MQ

getPollerGroupName

@Stability(Stable)
@Nullable
default String getPollerGroupName()

An optional identifier that groups multiple ESMs to share EPU capacity and reduce costs.

ESMs with the same PollerGroupName share compute resources.

Default: - not set, dedicated compute resource per event source.

builder

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

Returns:

a ProvisionedPollerConfig.Builder of ProvisionedPollerConfig