S3ManifestItemReader Class
Item Reader configuration for iterating over items in a S3 inventory manifest file stored in S3.
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 s3ManifestItemReader = new stepfunctions.S3ManifestItemReader({
key: 'key',
// the properties below are optional
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
s3_manifest_item_reader = stepfunctions.S3ManifestItemReader(
key="key",
# the properties below are optional
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;
S3ManifestItemReader s3ManifestItemReader = S3ManifestItemReader.Builder.create()
.key("key")
// the properties below are optional
.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 s3ManifestItemReader = new S3ManifestItemReader(new S3FileItemReaderProps {
Key = "key",
// the properties below are optional
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
s3ManifestItemReader := awscdk.Aws_stepfunctions.NewS3ManifestItemReader(&S3FileItemReaderProps{
Key: jsii.String("key"),
// the properties below are optional
Bucket: bucket,
BucketNamePath: jsii.String("bucketNamePath"),
MaxItems: jsii.Number(123),
})
Initializer
ts
new S3ManifestItemReader(props: S3FileItemReaderProps)
python
S3ManifestItemReader(props: S3FileItemReaderProps)
java
new S3ManifestItemReader(S3FileItemReaderProps props)
csharp
new S3ManifestItemReader(S3FileItemReaderProps props)
go
NewS3ManifestItemReader(Props S3FileItemReaderProps)
Properties
S3 Bucket containing a file with a list to iterate over.
bucketNamePathmay be undefinedstringbucket_name_pathmay be undefinedstrbucketNamePathmay be undefinedStringBucketNamePathmay be undefinedstringBucketNamePathmay be undefined*string#S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath.
S3 key of a file with a list to iterate over.
maxItemsmay be undefinednumbermax_itemsmay be undefinedint | floatmaxItemsmay be undefinedNumberMaxItemsmay be undefineddoubleMaxItemsmay be undefined*float64#Limits the number of items passed to the Distributed Map state.
Default: No maxItems
ARN for the `getObject` method of the S3 API This API method is used to iterate all objects in the S3 bucket/prefix.
Methods
providePolicyStatements(): PolicyStatement[]def provide_policy_statements(self, ) -> typing.List[PolicyStatement]public List<PolicyStatement> providePolicyStatements()public PolicyStatement[] ProvidePolicyStatements()func ProvidePolicyStatements() *[]PolicyStatement#Compile policy statements to provide relevent permissions to the state machine.
render(queryLanguage?: QueryLanguage): anydef render(self, query_language: typing.Optional[QueryLanguage] = None) -> Anypublic Object render(QueryLanguage queryLanguage)public object Render(QueryLanguage? queryLanguage = null)func Render(QueryLanguage QueryLanguage) interface{}#Renders the ItemReader configuration as JSON object.
returns
Returns: - JSON object
validateItemReader(): string[]def validate_item_reader(self, ) -> typing.List[str]public List<String> validateItemReader()public string[] ValidateItemReader()func ValidateItemReader() *[]*string#Validate that ItemReader contains exactly either.