aws-cdk-lib.aws_lambda.CfnEventSourceMapping.ProvisionedPollerConfigProperty

ProvisionedPollerConfigProperty Struct

The provisioned mode configuration for the event source. Use Provisioned Mode to customize the minimum and maximum number of event pollers for your event source.

Source

Generated code

Type last changed

v2.227.0 · 21 Nov 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lambda as lambda } from 'aws-cdk-lib';
const provisionedPollerConfigProperty: lambda.CfnEventSourceMapping.ProvisionedPollerConfigProperty = {
  maximumPollers: 123,
  minimumPollers: 123,
  pollerGroupName: 'pollerGroupName',
};

Properties

maximumPollers?optionalnumbermaximum_pollers?optionalint | floatmaximumPollers?optionalNumberMaximumPollers?optionaldoubleMaximumPollers?optional*float64#

The maximum number of event pollers this event source can scale up to.

For Amazon SQS events source mappings, default is 200, and minimum value allowed is 2. For Amazon MSK and self-managed Apache Kafka event source mappings, default is 200, and minimum value allowed is 1.

minimumPollers?optionalnumberminimum_pollers?optionalint | floatminimumPollers?optionalNumberMinimumPollers?optionaldoubleMinimumPollers?optional*float64#

The minimum number of event pollers this event source can scale down to.

For Amazon SQS events source mappings, default is 2, and minimum 2 required. For Amazon MSK and self-managed Apache Kafka event source mappings, default is 1.

pollerGroupName?optionalstringpoller_group_name?optionalstrpollerGroupName?optionalStringPollerGroupName?optionalstringPollerGroupName?optional*string#

(Amazon MSK and self-managed Apache Kafka) The name of the provisioned poller group.

notes

Use this option to group multiple ESMs within the event source's VPC to share Event Poller Unit (EPU) capacity. You can use this option to optimize Provisioned mode costs for your ESMs. You can group up to 100 ESMs per poller group and aggregate maximum pollers across all ESMs in a group cannot exceed 2000.