Interface S3FileItemReaderProps
- All Superinterfaces:
ItemReaderProps,software.amazon.jsii.JsiiSerializable
- All Known Subinterfaces:
S3CsvItemReaderProps
- All Known Implementing Classes:
S3CsvItemReaderProps.Jsii$Proxy,S3FileItemReaderProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
date="2025-10-24T13:34:47.878Z")
@Stability(Stable)
public interface S3FileItemReaderProps
extends software.amazon.jsii.JsiiSerializable, ItemReaderProps
Base interface for Item Reader configuration properties the iterate over entries in a S3 file.
Example:
import software.amazon.awscdk.services.s3.*;
/**
* Tree view of bucket:
* my-bucket
* |
* +--input.json
* |
* ...
*
* File content of input.json:
* [
* "item1",
* "item2"
* ]
*/
Bucket bucket = Bucket.Builder.create(this, "Bucket")
.bucketName("my-bucket")
.build();
DistributedMap distributedMap = DistributedMap.Builder.create(this, "DistributedMap")
.itemReader(S3JsonItemReader.Builder.create()
.bucket(bucket)
.key("input.json")
.build())
.build();
distributedMap.itemProcessor(new Pass(this, "Pass"));
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classA builder forS3FileItemReaderPropsstatic final classAn implementation forS3FileItemReaderProps -
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
-
getKey
Key of file stored in S3 bucket containing an array to iterate over. -
builder
- Returns:
- a
S3FileItemReaderProps.BuilderofS3FileItemReaderProps
-