Class S3ObjectsItemReaderProps
Properties for configuring an Item Reader that iterates over objects in an S3 bucket.
Inheritance
System.Object
S3ObjectsItemReaderProps
Namespace: Amazon.CDK.AWS.StepFunctions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class S3ObjectsItemReaderProps : Object, IS3ObjectsItemReaderProps, IItemReaderProps
Syntax (vb)
Public Class S3ObjectsItemReaderProps
Inherits Object
Implements IS3ObjectsItemReaderProps, 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 s3ObjectsItemReaderProps = new S3ObjectsItemReaderProps {
Bucket = bucket,
// the properties below are optional
MaxItems = 123,
Prefix = "prefix"
};
Synopsis
Constructors
S3ObjectsItemReaderProps() |
Properties
Bucket | S3 Bucket containing objects to iterate over or a file with a list to iterate over. |
MaxItems | Limits the number of items passed to the Distributed Map state. |
Prefix | S3 prefix used to limit objects to iterate over. |
Constructors
S3ObjectsItemReaderProps()
public S3ObjectsItemReaderProps()
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
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
Prefix
S3 prefix used to limit objects to iterate over.
public string Prefix { get; set; }
Property Value
System.String
Remarks
Default: - No prefix