Class S3CsvItemReaderProps

Properties for configuring an Item Reader that iterates over items in a CSV file in S3.

Inheritance
object
S3CsvItemReaderProps
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class S3CsvItemReaderProps : IS3CsvItemReaderProps, IS3FileItemReaderProps, IItemReaderProps
Syntax (vb)
Public Class S3CsvItemReaderProps Implements IS3CsvItemReaderProps, IS3FileItemReaderProps, IItemReaderProps
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.S3;
            using Amazon.CDK.AWS.StepFunctions;

            Bucket bucket;
            CsvHeaders csvHeaders;

            var s3CsvItemReaderProps = new S3CsvItemReaderProps {
                Key = "key",

                // the properties below are optional
                Bucket = bucket,
                BucketNamePath = "bucketNamePath",
                CsvDelimiter = CsvDelimiter.COMMA,
                CsvHeaders = csvHeaders,
                MaxItems = 123
            };

Synopsis

Constructors

S3CsvItemReaderProps()

Properties for configuring an Item Reader that iterates over items in a CSV file in S3.

Properties

Bucket

S3 Bucket containing objects to iterate over or a file with a list to iterate over.
BucketNamePath

S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath.
CsvDelimiter

Delimiter used in a CSV file.
CsvHeaders

CSV file header configuration.
Key

Key of file stored in S3 bucket containing an array to iterate over.
MaxItems

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

Constructors

S3CsvItemReaderProps()

Properties for configuring an Item Reader that iterates over items in a CSV file in S3.

public S3CsvItemReaderProps()
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.S3;
            using Amazon.CDK.AWS.StepFunctions;

            Bucket bucket;
            CsvHeaders csvHeaders;

            var s3CsvItemReaderProps = new S3CsvItemReaderProps {
                Key = "key",

                // the properties below are optional
                Bucket = bucket,
                BucketNamePath = "bucketNamePath",
                CsvDelimiter = CsvDelimiter.COMMA,
                CsvHeaders = csvHeaders,
                MaxItems = 123
            };

Properties

Bucket

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

public IBucket? Bucket { get; set; }
Property Value

IBucket

Remarks

Default: - S3 bucket will be determined from

See: bucketNamePath

BucketNamePath

S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath.

public string? BucketNamePath { get; set; }
Property Value

string

Remarks

Default: - S3 bucket will be determined from

See: bucket

CsvDelimiter

Delimiter used in a CSV file.

public CsvDelimiter? CsvDelimiter { get; set; }
Property Value

CsvDelimiter?

Remarks

Default: undefined - Default setting is COMMA.

CsvHeaders

CSV file header configuration.

public CsvHeaders? CsvHeaders { get; set; }
Property Value

CsvHeaders

Remarks

Default: - CsvHeaders with CsvHeadersLocation.FIRST_ROW

Key

Key of file stored in S3 bucket containing an array to iterate over.

public string Key { get; set; }
Property Value

string

Remarks

ExampleMetadata: fixture=_generated

MaxItems

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

public double? MaxItems { get; set; }
Property Value

double?

Remarks

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

Implements