Class S3ObjectsItemReader.Builder
java.lang.Object
software.amazon.awscdk.services.stepfunctions.S3ObjectsItemReader.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<S3ObjectsItemReader>
- Enclosing class:
S3ObjectsItemReader
@Stability(Stable)
public static final class S3ObjectsItemReader.Builder
extends Object
implements software.amazon.jsii.Builder<S3ObjectsItemReader>
A fluent builder for
S3ObjectsItemReader
.-
Method Summary
Modifier and TypeMethodDescriptionS3 Bucket containing objects to iterate over or a file with a list to iterate over.bucketNamePath
(String bucketNamePath) S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath.build()
static S3ObjectsItemReader.Builder
create()
Limits the number of items passed to the Distributed Map state.S3 prefix used to limit objects to iterate over.
-
Method Details
-
create
- Returns:
- a new instance of
S3ObjectsItemReader.Builder
.
-
bucket
S3 Bucket containing objects to iterate over or a file with a list to iterate over.Default: - S3 bucket will be determined from
- Parameters:
bucket
- S3 Bucket containing objects to iterate over or a file with a list to iterate over. This parameter is required.- Returns:
this
- See Also:
-
bucketNamePath
S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath.Default: - S3 bucket will be determined from
- Parameters:
bucketNamePath
- S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath. This parameter is required.- Returns:
this
- See Also:
-
maxItems
Limits the number of items passed to the Distributed Map state.Default: - Distributed Map state will iterate over all items provided by the ItemReader
- Parameters:
maxItems
- Limits the number of items passed to the Distributed Map state. This parameter is required.- Returns:
this
-
prefix
S3 prefix used to limit objects to iterate over.Default: - No prefix
- Parameters:
prefix
- S3 prefix used to limit objects to iterate over. This parameter is required.- Returns:
this
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<S3ObjectsItemReader>
- Returns:
- a newly built instance of
S3ObjectsItemReader
.
-