interface S3CsvItemReaderProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.StepFunctions.S3CsvItemReaderProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#S3CsvItemReaderProps |
Java | software.amazon.awscdk.services.stepfunctions.S3CsvItemReaderProps |
Python | aws_cdk.aws_stepfunctions.S3CsvItemReaderProps |
TypeScript (source) | aws-cdk-lib » aws_stepfunctions » S3CsvItemReaderProps |
Properties for configuring an Item Reader that iterates over items in a CSV file in S3.
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;
declare const csvHeaders: stepfunctions.CsvHeaders;
const s3CsvItemReaderProps: stepfunctions.S3CsvItemReaderProps = {
bucket: bucket,
key: 'key',
// the properties below are optional
csvHeaders: csvHeaders,
maxItems: 123,
};
Properties
Name | Type | Description |
---|---|---|
bucket | IBucket | S3 Bucket containing objects to iterate over or a file with a list to iterate over. |
key | string | Key of file stored in S3 bucket containing an array to iterate over. |
csv | Csv | CSV file header configuration. |
max | number | Limits the number of items passed to the Distributed Map state. |
bucket
Type:
IBucket
S3 Bucket containing objects to iterate over or a file with a list to iterate over.
key
Type:
string
Key of file stored in S3 bucket containing an array to iterate over.
csvHeaders?
Type:
Csv
(optional, default: CsvHeaders with CsvHeadersLocation.FIRST_ROW)
CSV file header configuration.
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.