interface IItemReader
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.StepFunctions.IItemReader |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#IItemReader |
![]() | software.amazon.awscdk.services.stepfunctions.IItemReader |
![]() | aws_cdk.aws_stepfunctions.IItemReader |
![]() | aws-cdk-lib » aws_stepfunctions » IItemReader |
Implemented by
S3
, S3
, S3
, S3
Base interface for Item Reader configurations.
Properties
Name | Type | Description |
---|---|---|
bucket | IBucket | S3 Bucket containing objects to iterate over or a file with a list to iterate over. |
resource | string | The Amazon S3 API action that Step Functions must invoke depending on the specified dataset. |
bucket | string | S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath. |
max | number | Limits the number of items passed to the Distributed Map state. |
bucket
Type:
IBucket
S3 Bucket containing objects to iterate over or a file with a list to iterate over.
resource
Type:
string
The Amazon S3 API action that Step Functions must invoke depending on the specified dataset.
bucketNamePath?
Type:
string
(optional)
S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath.
maxItems?
Type:
number
(optional, default: Distributed Map state will iterate over all items provided by the ItemReader)
Limits the number of items passed to the Distributed Map state.
Methods
Name | Description |
---|---|
provide | Compile policy statements to provide relevent permissions to the state machine. |
render() | Render the ItemReader as JSON object. |
validate | Validate that ItemReader contains exactly either. |
providePolicyStatements()
public providePolicyStatements(): PolicyStatement[]
Returns
Compile policy statements to provide relevent permissions to the state machine.
render()
public render(): any
Returns
any
Render the ItemReader as JSON object.
validateItemReader()
public validateItemReader(): string[]
Returns
string[]
Validate that ItemReader contains exactly either.
See also: bucketNamePath