Package software.amazon.awscdk.services.stepfunctions

Interface IItemReader

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

IItemReader.Jsii$Default

All Known Implementing Classes:

IItemReader.Jsii$Proxy, S3CsvItemReader, S3JsonItemReader, S3ManifestItemReader, S3ObjectsItemReader

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-06T14:43:27.723Z")
@Stability(Stable)
public interface IItemReader
extends software.amazon.jsii.JsiiSerializable

Base interface for Item Reader configurations.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IItemReader.Jsii$Default	Internal default implementation for IItemReader.
static final class	IItemReader.Jsii$Proxy	A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method	Description
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.
String	getResource()	The Amazon S3 API action that Step Functions must invoke depending on the specified dataset.
List<PolicyStatement>	providePolicyStatements()	Compile policy statements to provide relevent permissions to the state machine.
Object	render()	Render the ItemReader as JSON object.
List<String>	validateItemReader()	Validate that ItemReader contains exactly either.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

@Stability(Stable)
@NotNull
IBucket getBucket()

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

getResource

@Stability(Stable)
@NotNull
String getResource()

The Amazon S3 API action that Step Functions must invoke depending on the specified dataset.

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.

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

providePolicyStatements

@Stability(Stable)
@NotNull
List<PolicyStatement> providePolicyStatements()

Compile policy statements to provide relevent permissions to the state machine.

render

@Stability(Stable)
@NotNull
Object render()

Render the ItemReader as JSON object.

validateItemReader

@Stability(Stable)
@NotNull
List<String> validateItemReader()

Validate that ItemReader contains exactly either.

See Also:

• bucketNamePath