Class S3FileItemReaderProps

Base interface for Item Reader configuration properties the iterate over entries in a S3 file.

Inheritance
System.Object
S3FileItemReaderProps
Namespace: Amazon.CDK.AWS.StepFunctions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class S3FileItemReaderProps : Object, IS3FileItemReaderProps, IItemReaderProps
Syntax (vb)
Public Class S3FileItemReaderProps
    Inherits Object
    Implements IS3FileItemReaderProps, IItemReaderProps
Remarks

ExampleMetadata: infused

Examples
using Amazon.CDK.AWS.S3;


/**
 * Tree view of bucket:
 *  my-bucket
 *  |
 *  +--input.json
 *  |
 *  ...
 *
 * File content of input.json:
 *  [
 *    "item1",
 *    "item2"
 *  ]
 */
var bucket = new Bucket(this, "Bucket", new BucketProps {
    BucketName = "my-bucket"
});

var distributedMap = new DistributedMap(this, "DistributedMap", new DistributedMapProps {
    ItemReader = new S3JsonItemReader(new S3FileItemReaderProps {
        Bucket = bucket,
        Key = "input.json"
    })
});
distributedMap.ItemProcessor(new Pass(this, "Pass"));

Synopsis

Constructors

S3FileItemReaderProps()

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.
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

S3FileItemReaderProps()

public S3FileItemReaderProps()

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

System.String

Remarks

Default: - S3 bucket will be determined from

See: bucket

Key

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

public string Key { get; set; }
Property Value

System.String

MaxItems

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

public Nullable<double> MaxItems { get; set; }
Property Value

System.Nullable<System.Double>

Remarks

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

Implements