ProvisionedPollerConfig

class aws_cdk.aws_lambda.ProvisionedPollerConfig(*, maximum_pollers=None, minimum_pollers=None, poller_group_name=None)

Bases: object

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

Parameters:

  • maximum_pollers (Union[int, float, None]) – 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

  • minimum_pollers (Union[int, float, None]) – 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

  • poller_group_name (Optional[str]) – 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.

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_lambda as lambda_

provisioned_poller_config = lambda.ProvisionedPollerConfig(
    maximum_pollers=123,
    minimum_pollers=123,
    poller_group_name="pollerGroupName"
)

Attributes

maximum_pollers

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

minimum_pollers

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

poller_group_name

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.