Interface S3ObjectsItemReaderProps
- All Superinterfaces:
ItemReaderProps,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
S3ObjectsItemReaderProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
date="2025-11-17T14:41:01.517Z")
@Stability(Stable)
public interface S3ObjectsItemReaderProps
extends software.amazon.jsii.JsiiSerializable, ItemReaderProps
Properties for configuring an Item Reader that iterates over objects in an S3 bucket.
Example:
import software.amazon.awscdk.services.s3.*;
/**
* Tree view of bucket:
* my-bucket
* |
* +--item1
* |
* +--otherItem
* |
* +--item2
* |
* ...
*/
Bucket bucket = Bucket.Builder.create(this, "Bucket")
.bucketName("my-bucket")
.build();
DistributedMap distributedMap = DistributedMap.Builder.create(this, "DistributedMap")
.itemReader(S3ObjectsItemReader.Builder.create()
.bucket(bucket)
.prefix("item")
.build())
.build();
distributedMap.itemProcessor(new Pass(this, "Pass"));
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forS3ObjectsItemReaderPropsstatic final classAn implementation forS3ObjectsItemReaderProps -
Method Summary
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.ItemReaderProps
getBucket, getBucketNamePath, getMaxItemsMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getPrefix
S3 prefix used to limit objects to iterate over.Default: - No prefix
-
builder
- Returns:
- a
S3ObjectsItemReaderProps.BuilderofS3ObjectsItemReaderProps
-