Class S3CsvItemReader
Item Reader configuration for iterating over items in a CSV file stored in S3.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.StepFunctions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class S3CsvItemReader : DeputyBase, IItemReaderSyntax (vb)
Public Class S3CsvItemReader
Inherits DeputyBase
Implements IItemReaderRemarks
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 s3CsvItemReader = new S3CsvItemReader(new S3CsvItemReaderProps {
Key = "key",
// the properties below are optional
Bucket = bucket,
BucketNamePath = "bucketNamePath",
CsvHeaders = csvHeaders,
MaxItems = 123
});Synopsis
Constructors
| S3CsvItemReader(IS3CsvItemReaderProps) | |
| S3CsvItemReader(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
| S3CsvItemReader(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
| Bucket | S3 Bucket containing 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. |
| CsvHeaders | CSV headers configuration. |
| InputType | |
| Key | S3 key of a file with a list to iterate over. |
| MaxItems | Limits the number of items passed to the Distributed Map state. |
| Resource | ARN for the |
Methods
| ProvidePolicyStatements() | Compile policy statements to provide relevent permissions to the state machine. |
| Render() | Renders the ItemReader configuration as JSON object. |
| ValidateItemReader() | Validate that ItemReader contains exactly either. |
Constructors
S3CsvItemReader(IS3CsvItemReaderProps)
S3CsvItemReader(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected S3CsvItemReader(ByRefValue reference)Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
S3CsvItemReader(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected S3CsvItemReader(DeputyBase.DeputyProps props)Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
Bucket
S3 Bucket containing a file with a list to iterate over.
public virtual IBucket Bucket { get; }Property Value
BucketNamePath
S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath.
public virtual string BucketNamePath { get; }Property Value
System.String
CsvHeaders
InputType
protected virtual string InputType { get; }Property Value
System.String
Key
S3 key of a file with a list to iterate over.
public virtual string Key { get; }Property Value
System.String
MaxItems
Limits the number of items passed to the Distributed Map state.
public virtual Nullable<double> MaxItems { get; }Property Value
System.Nullable<System.Double>
Remarks
Default: - No maxItems
Resource
ARN for the getObject method of the S3 API This API method is used to iterate all objects in the S3 bucket/prefix.
public virtual string Resource { get; }Property Value
System.String
Methods
ProvidePolicyStatements()
Compile policy statements to provide relevent permissions to the state machine.
public virtual PolicyStatement[] ProvidePolicyStatements()Returns
Render()
Renders the ItemReader configuration as JSON object.
public virtual object Render()Returns
System.Object
ValidateItemReader()
Validate that ItemReader contains exactly either.
public virtual string[] ValidateItemReader()Returns
System.String[]
Remarks
See: bucketNamePath