Package software.amazon.awscdk.services.stepfunctions

Interface ItemReaderProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

S3CsvItemReaderProps, S3FileItemReaderProps, S3ObjectsItemReaderProps

All Known Implementing Classes:

ItemReaderProps.Jsii$Proxy, S3CsvItemReaderProps.Jsii$Proxy, S3FileItemReaderProps.Jsii$Proxy, S3ObjectsItemReaderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-29T11:15:49.415Z")
@Stability(Stable)
public interface ItemReaderProps
extends software.amazon.jsii.JsiiSerializable

Base interface for Item Reader 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.s3.*;
 import software.amazon.awscdk.services.stepfunctions.*;
 Bucket bucket;
 ItemReaderProps itemReaderProps = ItemReaderProps.builder()
         .bucket(bucket)
         .bucketNamePath("bucketNamePath")
         .maxItems(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	ItemReaderProps.Builder	A builder for ItemReaderProps
static final class	ItemReaderProps.Jsii$Proxy	An implementation for ItemReaderProps

Method Summary

Modifier and Type	Method	Description
static ItemReaderProps.Builder	builder()
default IBucket	getBucket()	S3 Bucket containing objects to iterate over or a file with a list to iterate over.
default String	getBucketNamePath()	S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath.
default Number	getMaxItems()	Limits the number of items passed to the Distributed Map state.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

@Stability(Stable)
@Nullable
default IBucket getBucket()

S3 Bucket containing objects to iterate over or a file with a list to iterate over.

Default: - S3 bucket will be determined from

See Also:

• bucketNamePath

getBucketNamePath

@Stability(Stable)
@Nullable
default String getBucketNamePath()

S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath.

Default: - S3 bucket will be determined from

See Also:

• bucket

getMaxItems

@Stability(Stable)
@Nullable
default Number getMaxItems()

Limits the number of items passed to the Distributed Map state.

Default: - Distributed Map state will iterate over all items provided by the ItemReader

builder

@Stability(Stable)
static ItemReaderProps.Builder builder()

Returns:

a ItemReaderProps.Builder of ItemReaderProps