Package software.amazon.awscdk.services.stepfunctions

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 Type	Method	Description
S3ObjectsItemReader.Builder	bucket(IBucket bucket)	S3 Bucket containing objects to iterate over or a file with a list to iterate over.
S3ObjectsItemReader.Builder	bucketNamePath(String bucketNamePath)	S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath.
S3ObjectsItemReader	build()
static S3ObjectsItemReader.Builder	create()
S3ObjectsItemReader.Builder	maxItems(Number maxItems)	Limits the number of items passed to the Distributed Map state.
S3ObjectsItemReader.Builder	prefix(String prefix)	S3 prefix used to limit objects to iterate over.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

create

@Stability(Stable)
public static S3ObjectsItemReader.Builder create()

Returns:

a new instance of S3ObjectsItemReader.Builder.

bucket

@Stability(Stable)
public S3ObjectsItemReader.Builder bucket(IBucket 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

bucketNamePath

@Stability(Stable)
public S3ObjectsItemReader.Builder bucketNamePath(String 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:

• bucket

maxItems

@Stability(Stable)
public S3ObjectsItemReader.Builder maxItems(Number 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

@Stability(Stable)
public S3ObjectsItemReader.Builder prefix(String 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

@Stability(Stable)
public S3ObjectsItemReader build()

Specified by:

build in interface software.amazon.jsii.Builder<S3ObjectsItemReader>

Returns:

a newly built instance of S3ObjectsItemReader.