interface BatchConfigurationProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.EventsV2.CfnSubscriber.BatchConfigurationProperty |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awseventsv2#CfnSubscriber_BatchConfigurationProperty |
 Java | software.amazon.awscdk.services.eventsv2.CfnSubscriber.BatchConfigurationProperty |
 Python | aws_cdk.aws_eventsv2.CfnSubscriber.BatchConfigurationProperty |
 TypeScript | aws-cdk-lib » aws_eventsv2 » CfnSubscriber » BatchConfigurationProperty |
Configuration for batching events into a single delivery.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_eventsv2 as eventsv2 } from 'aws-cdk-lib';
const batchConfigurationProperty: eventsv2.CfnSubscriber.BatchConfigurationProperty = {
maxBatchSize: 123,
maxBatchWindowInSeconds: 123,
};
Properties
| Name | Type | Description |
|---|---|---|
| max | number | The maximum number of events in a single batch delivered to the target. |
| max | number | The maximum time in seconds to wait for a batch to fill before delivering it, 0-300. |
maxBatchSize?
Type:
number
(optional)
The maximum number of events in a single batch delivered to the target.
The maximum depends on the target: 500 for Kinesis Data Streams and Amazon Data Firehose, 100 for Lambda, Step Functions, and AWS::EventsV2::EventBus targets, 10 for Amazon SQS, Amazon SNS, and AWS::Events::EventBus targets, and 1 for API Gateway, API destinations, and universal service integration targets. The service rejects a value above the target's maximum. Fewer events may be delivered when the batch window elapses. When omitted, the default is 10 for Lambda and Step Functions targets and the target's maximum for other targets. The resolved value applied by the service is returned on read.
maxBatchWindowInSeconds?
Type:
number
(optional)
The maximum time in seconds to wait for a batch to fill before delivering it, 0-300.
The default is 0 (no wait). The resolved value applied by the service is returned on read.