Skip to content

ProvisionedPollerConfig

Source code in docs_src/capo_lambda/types/provisioned_poller_config.py
class ProvisionedPollerConfig(TypedDict, closed=True):
    minimum_pollers: NotRequired[
        "capo_lambda.types.minimum_number_of_pollers.MinimumNumberOfPollers"
    ]
    """<p>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.</p>"""
    maximum_pollers: NotRequired[
        "capo_lambda.types.maximum_number_of_pollers.MaximumNumberOfPollers"
    ]
    """<p>The maximum number of event pollers this event source can scale up to. For Amazon SQS event source mappings, the accepted range is between 2 and 10,000, with a default of 200. For Amazon MSK and self-managed Apache Kafka event source mappings, the accepted range is between 1 and 2,000, with a default of 200.</p>"""
    poller_group_name: NotRequired[
        "capo_lambda.types.provisioned_poller_group_name.ProvisionedPollerGroupName"
    ]
    """<p>(Amazon MSK and self-managed Apache Kafka) The name of the provisioned poller group. 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.</p>"""

maximum_pollers instance-attribute

maximum_pollers: NotRequired[MaximumNumberOfPollers]

The maximum number of event pollers this event source can scale up to. For Amazon SQS event source mappings, the accepted range is between 2 and 10,000, with a default of 200. For Amazon MSK and self-managed Apache Kafka event source mappings, the accepted range is between 1 and 2,000, with a default of 200.

minimum_pollers instance-attribute

minimum_pollers: NotRequired[MinimumNumberOfPollers]

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.

poller_group_name instance-attribute

poller_group_name: NotRequired[ProvisionedPollerGroupName]

(Amazon MSK and self-managed Apache Kafka) The name of the provisioned poller group. 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.