Package software.amazon.awscdk.services.stepfunctions

Interface S3ObjectsItemReaderProps

All Superinterfaces:

ItemReaderProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

S3ObjectsItemReaderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:14.398Z")
@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:

 // 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;
 S3ObjectsItemReaderProps s3ObjectsItemReaderProps = S3ObjectsItemReaderProps.builder()
         .bucket(bucket)
         // the properties below are optional
         .maxItems(123)
         .prefix("prefix")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static S3ObjectsItemReaderProps.Builder	builder()
default String	getPrefix()	S3 prefix used to limit objects to iterate over.

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.ItemReaderProps

getBucket, getMaxItems

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPrefix

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

S3 prefix used to limit objects to iterate over.

Default: - No prefix

builder

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

Returns:

a S3ObjectsItemReaderProps.Builder of S3ObjectsItemReaderProps