Class S3ManifestItemReader
java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.stepfunctions.S3ManifestItemReader
- All Implemented Interfaces:
IItemReader
,software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
date="2024-10-25T14:21:24.338Z")
@Stability(Stable)
public class S3ManifestItemReader
extends software.amazon.jsii.JsiiObject
implements IItemReader
Item Reader configuration for iterating over items in a S3 inventory manifest file stored in S3.
Example:
// 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();
-
Nested Class Summary
Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IItemReader
IItemReader.Jsii$Default, IItemReader.Jsii$Proxy
-
Constructor Summary
ModifierConstructorDescriptionprotected
S3ManifestItemReader
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
S3ManifestItemReader
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionS3 Bucket containing a file with a list to iterate over.S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath.protected String
getKey()
S3 key of a file with a list to iterate over.Limits the number of items passed to the Distributed Map state.ARN for thegetObject
method of the S3 API This API method is used to iterate all objects in the S3 bucket/prefix.Compile policy statements to provide relevent permissions to the state machine.render()
Renders the ItemReader configuration as JSON object.Validate that ItemReader contains exactly either.Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Constructor Details
-
S3ManifestItemReader
protected S3ManifestItemReader(software.amazon.jsii.JsiiObjectRef objRef) -
S3ManifestItemReader
protected S3ManifestItemReader(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
S3ManifestItemReader
- Parameters:
props
- This parameter is required.
-
-
Method Details
-
providePolicyStatements
Compile policy statements to provide relevent permissions to the state machine.- Specified by:
providePolicyStatements
in interfaceIItemReader
-
render
Renders the ItemReader configuration as JSON object.- Specified by:
render
in interfaceIItemReader
- Returns:
- JSON object
-
validateItemReader
Validate that ItemReader contains exactly either.- Specified by:
validateItemReader
in interfaceIItemReader
- See Also:
-
getBucket
S3 Bucket containing a file with a list to iterate over.- Specified by:
getBucket
in interfaceIItemReader
-
getInputType
-
getKey
S3 key of a file with a list to iterate over. -
getResource
ARN for thegetObject
method of the S3 API This API method is used to iterate all objects in the S3 bucket/prefix.- Specified by:
getResource
in interfaceIItemReader
-
getBucketNamePath
S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath.- Specified by:
getBucketNamePath
in interfaceIItemReader
-
getMaxItems
Limits the number of items passed to the Distributed Map state.Default: - No maxItems
- Specified by:
getMaxItems
in interfaceIItemReader
-