Package software.amazon.awscdk.services.iot.actions.alpha

Interface HttpActionBatchConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

HttpActionBatchConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-23T11:20:10.153Z")
@Stability(Experimental)
public interface HttpActionBatchConfig
extends software.amazon.jsii.JsiiSerializable

(experimental) Configuration for batching HTTP action messages.

Example:

 import software.amazon.awscdk.Size;
 TopicRule topicRule;
 topicRule.addAction(
 HttpsAction.Builder.create("https://example.com/endpoint")
         .batchConfig(HttpActionBatchConfig.builder()
                 .maxBatchOpenDuration(Duration.millis(100))
                 .maxBatchSize(5)
                 .maxBatchSizeBytes(Size.kibibytes(1))
                 .build())
         .build());
 

See Also:

• https://docs.aws.amazon.com/iot/latest/developerguide/http_batching.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static HttpActionBatchConfig.Builder	builder()
default Duration	getMaxBatchOpenDuration()	(experimental) The maximum amount of time an outgoing message waits for other messages to create the batch.
default Number	getMaxBatchSize()	(experimental) The maximum number of messages that are batched together in a single IoT rule action execution.
default Size	getMaxBatchSizeBytes()	(experimental) Maximum size of a message batch.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getMaxBatchOpenDuration

@Stability(Experimental)
@Nullable
default Duration getMaxBatchOpenDuration()

(experimental) The maximum amount of time an outgoing message waits for other messages to create the batch.

Must be between 5 ms and 200 ms.

Default: Duration.millis(20)

getMaxBatchSize

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

(experimental) The maximum number of messages that are batched together in a single IoT rule action execution.

Must be between 2 and 10.

Default: 10

getMaxBatchSizeBytes

@Stability(Experimental)
@Nullable
default Size getMaxBatchSizeBytes()

(experimental) Maximum size of a message batch.

Must be between 100 bytes and 128 KiB.

Default: Size.kibibytes(5)

builder

@Stability(Experimental)
static HttpActionBatchConfig.Builder builder()

Returns:

a HttpActionBatchConfig.Builder of HttpActionBatchConfig