interface HttpActionBatchConfig
| Language | Type name |
|---|---|
.NET | Amazon.CDK.AWS.IoT.Actions.Alpha.HttpActionBatchConfig |
Go | github.com/aws/aws-cdk-go/awscdkiotactionsalpha/v2#HttpActionBatchConfig |
Java | software.amazon.awscdk.services.iot.actions.alpha.HttpActionBatchConfig |
Python | aws_cdk.aws_iot_actions_alpha.HttpActionBatchConfig |
TypeScript (source) | @aws-cdk/aws-iot-actions-alpha ยป HttpActionBatchConfig |
Configuration for batching HTTP action messages.
See also: https://docs.aws.amazon.com/iot/latest/developerguide/http_batching.html
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
| Name | Type | Description |
|---|---|---|
| max | Duration | The maximum amount of time an outgoing message waits for other messages to create the batch. |
| max | number | The maximum number of messages that are batched together in a single IoT rule action execution. |
| max | Size | Maximum size of a message batch. |
maxBatchOpenDuration?
Type:
Duration
(optional, default: 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?
Type:
number
(optional, default: 10)
The maximum number of messages that are batched together in a single IoT rule action execution.
Must be between 2 and 10.
maxBatchSizeBytes?
Type:
Size
(optional, default: Size.kibibytes(5))
Maximum size of a message batch.
Must be between 100 bytes and 128 KiB.

.NET
Go
Java
Python
TypeScript (