Package software.amazon.awscdk.services.stepfunctions

Interface ItemBatcherProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
ItemBatcherProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-06T23:25:17.556Z") @Stability(Stable) public interface ItemBatcherProps extends software.amazon.jsii.JsiiSerializable
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 software.amazon.awscdk.services.stepfunctions.*;
 Object batchInput;
 ItemBatcherProps itemBatcherProps = ItemBatcherProps.builder()
         .batchInput(batchInput)
         .maxInputBytesPerBatch(123)
         .maxInputBytesPerBatchPath("maxInputBytesPerBatchPath")
         .maxItemsPerBatch(123)
         .maxItemsPerBatchPath("maxItemsPerBatchPath")
         .build();

  • Method Details

    • getBatchInput

      @Stability(Stable) @Nullable default com.fasterxml.jackson.databind.node.ObjectNode getBatchInput()
      BatchInput.

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

      Default: - No batchInput

    • getMaxInputBytesPerBatch

      @Stability(Stable) @Nullable default Number getMaxInputBytesPerBatch()
      MaxInputBytesPerBatch.

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

      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

    • getMaxInputBytesPerBatchPath

      @Stability(Stable) @Nullable default String getMaxInputBytesPerBatchPath()
      MaxInputBytesPerBatchPath.

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

      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

    • getMaxItemsPerBatch

      @Stability(Stable) @Nullable default Number getMaxItemsPerBatch()
      MaxItemsPerBatch.

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

      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

    • getMaxItemsPerBatchPath

      @Stability(Stable) @Nullable default String getMaxItemsPerBatchPath()
      MaxItemsPerBatchPath.

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

      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

    • builder

      @Stability(Stable) static ItemBatcherProps.Builder builder()
      Returns:
      a ItemBatcherProps.Builder of ItemBatcherProps