View a markdown version of this page

AWS::EventsV2::Subscriber BatchConfiguration - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::EventsV2::Subscriber BatchConfiguration

Configuration for batching events into a single delivery.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "MaxBatchSize" : Integer,
  "MaxBatchWindowInSeconds" : Integer
}

YAML

  MaxBatchSize: Integer
  MaxBatchWindowInSeconds: Integer

Properties

MaxBatchSize

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.

Required: No

Type: Integer

Minimum: 1

Maximum: 500

Update requires: No interruption

MaxBatchWindowInSeconds

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.

Required: No

Type: Integer

Minimum: 0

Maximum: 300

Update requires: No interruption