S3ObjectsItemReaderProps

class aws_cdk.aws_stepfunctions.S3ObjectsItemReaderProps(*, bucket, max_items=None, prefix=None)

Bases: ItemReaderProps

Properties for configuring an Item Reader that iterates over objects in an S3 bucket.

Parameters:

bucket (IBucket) – S3 Bucket containing objects to iterate over or a file with a list to iterate over.
max_items (Union[int, float, None]) – Limits the number of items passed to the Distributed Map state. Default: - Distributed Map state will iterate over all items provided by the ItemReader
prefix (Optional[str]) – S3 prefix used to limit objects to iterate over. Default: - No prefix

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_s3 as s3
from aws_cdk import aws_stepfunctions as stepfunctions

# bucket: s3.Bucket

s3_objects_item_reader_props = stepfunctions.S3ObjectsItemReaderProps(
    bucket=bucket,

    # the properties below are optional
    max_items=123,
    prefix="prefix"
)

Attributes

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

max_items

Limits the number of items passed to the Distributed Map state.

Default:

Distributed Map state will iterate over all items provided by the ItemReader

prefix

S3 prefix used to limit objects to iterate over.

Default:

No prefix