Package software.amazon.awscdk.services.eventsv2

Interface CfnSubscriber.BatchConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSubscriber.BatchConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnSubscriber

@Stability(Stable)
public static interface CfnSubscriber.BatchConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.eventsv2.*;
 BatchConfigurationProperty batchConfigurationProperty = BatchConfigurationProperty.builder()
         .maxBatchSize(123)
         .maxBatchWindowInSeconds(123)
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-subscriber-batchconfiguration.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSubscriber.BatchConfigurationProperty.Builder	A builder for CfnSubscriber.BatchConfigurationProperty
static final class	CfnSubscriber.BatchConfigurationProperty.Jsii$Proxy	An implementation for CfnSubscriber.BatchConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnSubscriber.BatchConfigurationProperty.Builder	builder()
default Number	getMaxBatchSize()	The maximum number of events in a single batch delivered to the target.
default Number	getMaxBatchWindowInSeconds()	The maximum time in seconds to wait for a batch to fill before delivering it, 0-300.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMaxBatchSize

@Stability(Stable)
@Nullable
default Number getMaxBatchSize()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-subscriber-batchconfiguration.html#cfn-eventsv2-subscriber-batchconfiguration-maxbatchsize

getMaxBatchWindowInSeconds

@Stability(Stable)
@Nullable
default Number getMaxBatchWindowInSeconds()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-eventsv2-subscriber-batchconfiguration.html#cfn-eventsv2-subscriber-batchconfiguration-maxbatchwindowinseconds

builder

@Stability(Stable)
static CfnSubscriber.BatchConfigurationProperty.Builder builder()

Returns:

a CfnSubscriber.BatchConfigurationProperty.Builder of CfnSubscriber.BatchConfigurationProperty