S3CsvItemReader
- class aws_cdk.aws_stepfunctions.S3CsvItemReader(*, csv_headers=None, key, bucket, max_items=None)
Bases:
object
Item Reader configuration for iterating over items in a CSV file stored in S3.
- ExampleMetadata:
fixture=_generated
Example:
# 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 # csv_headers: stepfunctions.CsvHeaders s3_csv_item_reader = stepfunctions.S3CsvItemReader( bucket=bucket, key="key", # the properties below are optional csv_headers=csv_headers, max_items=123 )
- Parameters:
csv_headers (
Optional
[CsvHeaders
]) – CSV file header configuration. Default: - CsvHeaders with CsvHeadersLocation.FIRST_ROWkey (
str
) – Key of file stored in S3 bucket containing an array to iterate over.bucket (
IBucket
) – S3 Bucket containing objects to iterate over or a file with a list to iterate over.max_items (
Union
[int
,float
,None
]) – Limits the number of items passed to the Distributed Map state. Default: - Distributed Map state will iterate over all items provided by the ItemReader
Methods
- provide_policy_statements()
Compile policy statements to provide relevent permissions to the state machine.
- Return type:
List
[PolicyStatement
]
- render()
Renders the ItemReader configuration as JSON object.
- Return type:
Any
Attributes
- bucket
S3 Bucket containing a file with a list to iterate over.
- csv_headers
CSV headers configuration.
- key
S3 key of a file with a list to iterate over.
- max_items
Limits the number of items passed to the Distributed Map state.
- Default:
No maxItems
- resource
ARN for the
getObject
method of the S3 API This API method is used to iterate all objects in the S3 bucket/prefix.