Interface IItemReaderProps

Base interface for Item Reader configuration properties.

Namespace: Amazon.CDK.AWS.StepFunctions

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IItemReaderProps

Syntax (vb)

Public Interface 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;

            var itemReaderProps = new ItemReaderProps {
                Bucket = bucket,
                BucketNamePath = "bucketNamePath",
                MaxItems = 123
            };

Synopsis

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.
MaxItems	Limits the number of items passed to the Distributed Map state.

Properties

Bucket

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

IBucket? Bucket { get; }

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.

string? BucketNamePath { get; }

Property Value

string

Remarks

Default: - S3 bucket will be determined from

See: bucket

MaxItems

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

double? MaxItems { get; }

Property Value

double?

Remarks

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