ItemReaderProps Struct
Base interface for Item Reader configuration properties.
| Source | aws-stepfunctions/lib/states/distributed-map/item-reader.ts |
|---|---|
| Type last changed |
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_s3 as s3 } from 'aws-cdk-lib';
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';
declare const bucket: s3.Bucket;
const itemReaderProps: stepfunctions.ItemReaderProps = {
bucket: bucket,
bucketNamePath: 'bucketNamePath',
maxItems: 123,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_s3 as s3
from aws_cdk import aws_stepfunctions as stepfunctions
# bucket: s3.Bucket
item_reader_props = stepfunctions.ItemReaderProps(
bucket=bucket,
bucket_name_path="bucketNamePath",
max_items=123
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.s3.*;
import software.amazon.awscdk.services.stepfunctions.*;
Bucket bucket;
ItemReaderProps itemReaderProps = ItemReaderProps.builder()
.bucket(bucket)
.bucketNamePath("bucketNamePath")
.maxItems(123)
.build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var bucket Bucket
itemReaderProps := &ItemReaderProps{
Bucket: bucket,
BucketNamePath: jsii.String("bucketNamePath"),
MaxItems: jsii.Number(123),
}
Properties
bucketoptionalIBucketbucketoptionalIBucketbucketoptionalIBucketBucketoptionalIBucketBucketoptionalIBucket #S3 Bucket containing objects to iterate over or a file with a list to iterate over.
Default: S3 bucket will be determined from
bucketNamePathoptionalstringbucket_name_pathoptionalstrbucketNamePathoptionalStringBucketNamePathoptionalstringBucketNamePathoptional*string #S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath.
Default: S3 bucket will be determined from
maxItemsoptionalnumbermax_itemsoptionalint | floatmaxItemsoptionalNumberMaxItemsoptionaldoubleMaxItemsoptional*float64 #Limits the number of items passed to the Distributed Map state.
Default: Distributed Map state will iterate over all items provided by the ItemReader