interface S3ObjectsItemReaderProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.StepFunctions.S3ObjectsItemReaderProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#S3ObjectsItemReaderProps |
Java | software.amazon.awscdk.services.stepfunctions.S3ObjectsItemReaderProps |
Python | aws_cdk.aws_stepfunctions.S3ObjectsItemReaderProps |
TypeScript (source) | aws-cdk-lib » aws_stepfunctions » S3ObjectsItemReaderProps |
Properties for configuring an Item Reader that iterates over objects in an S3 bucket.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_s3 as s3 } from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
declare const bucket: s3.Bucket;
const s3ObjectsItemReaderProps: stepfunctions.S3ObjectsItemReaderProps = {
bucket: bucket,
// the properties below are optional
maxItems: 123,
prefix: 'prefix',
};
Properties
Name | Type | Description |
---|---|---|
bucket | IBucket | S3 Bucket containing objects to iterate over or a file with a list to iterate over. |
max | number | Limits the number of items passed to the Distributed Map state. |
prefix? | string | S3 prefix used to limit objects to iterate over. |
bucket
Type:
IBucket
S3 Bucket containing objects to iterate over or a file with a list to iterate over.
maxItems?
Type:
number
(optional, default: Distributed Map state will iterate over all items provided by the ItemReader)
Limits the number of items passed to the Distributed Map state.
prefix?
Type:
string
(optional, default: No prefix)
S3 prefix used to limit objects to iterate over.