interface ItemBatcherProps

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.ItemBatcherProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#ItemBatcherProps
Java	software.amazon.awscdk.services.stepfunctions.ItemBatcherProps
Python	aws_cdk.aws_stepfunctions.ItemBatcherProps
TypeScript (source)	aws-cdk-lib » aws_stepfunctions » ItemBatcherProps

Interface for ItemBatcher configuration properties.

Example

// 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

Name	Type	Description
batchInput?	json	BatchInput.
maxInputBytesPerBatch?	number	MaxInputBytesPerBatch.
maxInputBytesPerBatchPath?	string	MaxInputBytesPerBatchPath.
maxItemsPerBatch?	number	MaxItemsPerBatch.
maxItemsPerBatchPath?	string	MaxItemsPerBatchPath.

---

batchInput?

Type: json (optional, default: No batchInput)

BatchInput.

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

---

maxInputBytesPerBatch?

Type: number (optional, 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)

MaxInputBytesPerBatch.

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

---

maxInputBytesPerBatchPath?

Type: string (optional, 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)

MaxInputBytesPerBatchPath.

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

---

maxItemsPerBatch?

Type: number (optional, 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)

MaxItemsPerBatch.

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

---

maxItemsPerBatchPath?

Type: string (optional, 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)

MaxItemsPerBatchPath.

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