# S3ObjectsItemReaderProps

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

Extends: S3ObjectsItemReaderProps
Extends: ItemReaderProps
Used as props by: S3ObjectsItemReader

- Source: [`aws-stepfunctions/lib/states/distributed-map/item-reader.ts`](https://github.com/aws/aws-cdk/blob/v2.275.0/packages/aws-cdk-lib/aws-stepfunctions/lib/states/distributed-map/item-reader.ts#L79)
- Type last changed: v2.127.0 · 10 Feb 2024

## Example

```ts
import * as s3 from 'aws-cdk-lib/aws-s3';

/**
 * Tree view of bucket:
 *  my-bucket
 *  |
 *  +--item1
 *  |
 *  +--otherItem
 *  |
 *  +--item2
 *  |
 *  ...
 */
const bucket = new s3.Bucket(this, 'Bucket', {
  bucketName: 'my-bucket',
});

const distributedMap = new sfn.DistributedMap(this, 'DistributedMap', {
  itemReader: new sfn.S3ObjectsItemReader({
    bucket,
    prefix: 'item',
  }),
});
distributedMap.itemProcessor(new sfn.Pass(this, 'Pass'));
```

## Properties

- `bucket`: [IBucket](/cdk/api/v2/docs/aws-cdk-lib.aws_s3.IBucket.html) — S3 Bucket containing objects to iterate over or a file with a list to iterate over.

  **Default:** S3 bucket will be determined from

- `bucketNamePath`: string — 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

- `maxItems`: number — 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`: string — S3 prefix used to limit objects to iterate over.

  **Default:** No prefix