Interface S3ObjectsItemReaderProps
- All Superinterfaces:
ItemReaderProps
,software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
S3ObjectsItemReaderProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-12-06T14:43:27.755Z")
@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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forS3ObjectsItemReaderProps
static final class
An implementation forS3ObjectsItemReaderProps
-
Method Summary
Methods inherited from interface software.amazon.awscdk.services.stepfunctions.ItemReaderProps
getBucket, getBucketNamePath, getMaxItems
Methods 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.Builder
ofS3ObjectsItemReaderProps
-