@aws-cdk/aws-iot-actions-alpha.HttpActionBatchConfig

Experimental

@aws-cdk/aws-iot-actions-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

HttpActionBatchConfig Struct

Configuration for batching HTTP action messages.

Stability

Experimental

Source

lib/https-action.ts

Example

import { Size } from 'aws-cdk-lib';

declare const topicRule: iot.TopicRule;

topicRule.addAction(
  new actions.HttpsAction('https://example.com/endpoint', {
    batchConfig: {
      maxBatchOpenDuration: Duration.millis(100),
      maxBatchSize: 5,
      maxBatchSizeBytes: Size.kibibytes(1),
    },
  }),
);

Properties

maxBatchOpenDuration?optionalDurationmax_batch_open_duration?optionalDurationmaxBatchOpenDuration?optionalDurationMaxBatchOpenDuration?optionalDurationMaxBatchOpenDuration?optionalDuration= Duration.millis(20)#

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

Must be between 5 ms and 200 ms.

maxBatchSize?optionalnumbermax_batch_size?optionalint | floatmaxBatchSize?optionalNumberMaxBatchSize?optionaldoubleMaxBatchSize?optional*float64= 10#

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

Must be between 2 and 10.

maxBatchSizeBytes?optionalSizemax_batch_size_bytes?optionalSizemaxBatchSizeBytes?optionalSizeMaxBatchSizeBytes?optionalSizeMaxBatchSizeBytes?optionalSize= Size.kibibytes(5)#

Maximum size of a message batch.

Must be between 100 bytes and 128 KiB.