Skip to content
v2.274.0

ItemBatcherProps Struct ​

Interface for ItemBatcher configuration properties.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';

declare const batchInput: any;
const itemBatcherProps: stepfunctions.ItemBatcherProps = {
  batchInput: batchInput,
  maxInputBytesPerBatch: 123,
  maxInputBytesPerBatchPath: 'maxInputBytesPerBatchPath',
  maxItemsPerBatch: 123,
  maxItemsPerBatchPath: 'maxItemsPerBatchPath',
};

Properties ​

batchInputoptionaljsonbatch_inputoptionalAnybatchInputoptionalObjectBatchInputoptionalobjectBatchInputoptionalinterface{}#
BatchInput.

Default: No batchInput

Fixed JSON input to include in each batch passed to each child workflow execution

maxInputBytesPerBatchoptionalnumbermax_input_bytes_per_batchoptionalint | floatmaxInputBytesPerBatchoptionalNumberMaxInputBytesPerBatchoptionaldoubleMaxInputBytesPerBatchoptional*float64#
MaxInputBytesPerBatch.

Default: uses value of maxInputBytesPerBatchPath as the max size per batch, no limits on the batch size under the 256KB limit if that property was also not provided

Specifies the maximum number of bytes that each child workflow execution processes, as static number

maxInputBytesPerBatchPathoptionalstringmax_input_bytes_per_batch_pathoptionalstrmaxInputBytesPerBatchPathoptionalStringMaxInputBytesPerBatchPathoptionalstringMaxInputBytesPerBatchPathoptional*string#
MaxInputBytesPerBatchPath.

Default: uses value of maxInputBytesPerBatch as the max size per batch, no limits on the batch size under the 256KB limit if that property was also not provided

Specifies the maximum number of bytes that each child workflow execution processes, as JsonPath

maxItemsPerBatchoptionalnumbermax_items_per_batchoptionalint | floatmaxItemsPerBatchoptionalNumberMaxItemsPerBatchoptionaldoubleMaxItemsPerBatchoptional*float64#
MaxItemsPerBatch.

Default: uses value of maxItemsPerBatchPath as the max items per batch, no limits on the number of items in a batch under the 256KB limit if that property was also not provided

Specifies the maximum number of items that each child workflow execution processes, as static number

maxItemsPerBatchPathoptionalstringmax_items_per_batch_pathoptionalstrmaxItemsPerBatchPathoptionalStringMaxItemsPerBatchPathoptionalstringMaxItemsPerBatchPathoptional*string#
MaxItemsPerBatchPath.

Default: uses value of maxItemsPerBatch as the max items per batch, no limits on the number of items in a batch under the 256KB limit if that property was also not provided

Specifies the maximum number of items that each child workflow execution processes, as JsonPath