S3ObjectsItemReaderProps Struct
Properties for configuring an Item Reader that iterates over objects in an S3 bucket.
| Source | aws-stepfunctions/lib/states/distributed-map/item-reader.ts |
|---|---|
| Type last changed |
Example
ts
import * as s3 from 'aws-cdk-lib/aws-s3';
/**
* Tree view of bucket:
* my-bucket
* |
* +--item1
* |
* +--otherItem
* |
* +--item2
* |
* ...
*/
const bucket = new s3.Bucket(this, 'Bucket', {
bucketName: 'my-bucket',
});
const distributedMap = new sfn.DistributedMap(this, 'DistributedMap', {
itemReader: new sfn.S3ObjectsItemReader({
bucket,
prefix: 'item',
}),
});
distributedMap.itemProcessor(new sfn.Pass(this, 'Pass'));
python
import aws_cdk.aws_s3 as s3
#
# Tree view of bucket:
# my-bucket
# |
# +--item1
# |
# +--otherItem
# |
# +--item2
# |
# ...
#
bucket = s3.Bucket(self, "Bucket",
bucket_name="my-bucket"
)
distributed_map = sfn.DistributedMap(self, "DistributedMap",
item_reader=sfn.S3ObjectsItemReader(
bucket=bucket,
prefix="item"
)
)
distributed_map.item_processor(sfn.Pass(self, "Pass"))
java
import software.amazon.awscdk.services.s3.*;
/**
* Tree view of bucket:
* my-bucket
* |
* +--item1
* |
* +--otherItem
* |
* +--item2
* |
* ...
*/
Bucket bucket = Bucket.Builder.create(this, "Bucket")
.bucketName("my-bucket")
.build();
DistributedMap distributedMap = DistributedMap.Builder.create(this, "DistributedMap")
.itemReader(S3ObjectsItemReader.Builder.create()
.bucket(bucket)
.prefix("item")
.build())
.build();
distributedMap.itemProcessor(new Pass(this, "Pass"));
csharp
// Install: dotnet add package Amazon.CDK.Lib
using Amazon.CDK.AWS.S3;
/**
* Tree view of bucket:
* my-bucket
* |
* +--item1
* |
* +--otherItem
* |
* +--item2
* |
* ...
*/
var bucket = new Bucket(this, "Bucket", new BucketProps {
BucketName = "my-bucket"
});
var distributedMap = new DistributedMap(this, "DistributedMap", new DistributedMapProps {
ItemReader = new S3ObjectsItemReader(new S3ObjectsItemReaderProps {
Bucket = bucket,
Prefix = "item"
})
});
distributedMap.ItemProcessor(new Pass(this, "Pass"));
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
import s3 "github.com/aws/aws-cdk-go/awscdk"
/**
* Tree view of bucket:
* my-bucket
* |
* +--item1
* |
* +--otherItem
* |
* +--item2
* |
* ...
*/
bucket := s3.NewBucket(this, jsii.String("Bucket"), &BucketProps{
BucketName: jsii.String("my-bucket"),
})
distributedMap := sfn.NewDistributedMap(this, jsii.String("DistributedMap"), &DistributedMapProps{
ItemReader: sfn.NewS3ObjectsItemReader(&S3ObjectsItemReaderProps{
Bucket: *Bucket,
Prefix: jsii.String("item"),
}),
})
distributedMap.ItemProcessor(sfn.NewPass(this, jsii.String("Pass")))
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
prefixoptionalstringprefixoptionalstrprefixoptionalStringPrefixoptionalstringPrefixoptional*string #S3 prefix used to limit objects to iterate over.
Default: No prefix