Package software.amazon.awscdk.services.stepfunctions

Interface S3CsvItemReaderProps

All Superinterfaces:

ItemReaderProps, software.amazon.jsii.JsiiSerializable, S3FileItemReaderProps

All Known Implementing Classes:

S3CsvItemReaderProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:47.878Z")
@Stability(Stable)
public interface S3CsvItemReaderProps
extends software.amazon.jsii.JsiiSerializable, S3FileItemReaderProps

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 software.amazon.awscdk.services.s3.*;
 import software.amazon.awscdk.services.stepfunctions.*;
 Bucket bucket;
 CsvHeaders csvHeaders;
 S3CsvItemReaderProps s3CsvItemReaderProps = S3CsvItemReaderProps.builder()
         .key("key")
         // the properties below are optional
         .bucket(bucket)
         .bucketNamePath("bucketNamePath")
         .csvDelimiter(CsvDelimiter.COMMA)
         .csvHeaders(csvHeaders)
         .maxItems(123)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	S3CsvItemReaderProps.Builder	A builder for S3CsvItemReaderProps
static final class	S3CsvItemReaderProps.Jsii$Proxy	An implementation for S3CsvItemReaderProps

Method Summary

Modifier and Type	Method	Description
static S3CsvItemReaderProps.Builder	builder()
default CsvDelimiter	getCsvDelimiter()	Delimiter used in a CSV file.
default CsvHeaders	getCsvHeaders()	CSV file header configuration.

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.ItemReaderProps

getBucket, getBucketNamePath, getMaxItems

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface software.amazon.awscdk.services.stepfunctions.S3FileItemReaderProps

getKey

Method Details

getCsvDelimiter

@Stability(Stable)
@Nullable
default CsvDelimiter getCsvDelimiter()

Delimiter used in a CSV file.

Default: undefined - Default setting is COMMA.

getCsvHeaders

@Stability(Stable)
@Nullable
default CsvHeaders getCsvHeaders()

CSV file header configuration.

Default: - CsvHeaders with CsvHeadersLocation.FIRST_ROW

builder

@Stability(Stable)
static S3CsvItemReaderProps.Builder builder()

Returns:

a S3CsvItemReaderProps.Builder of S3CsvItemReaderProps