Class S3JsonItemReader.Builder

java.lang.Object
software.amazon.awscdk.services.stepfunctions.S3JsonItemReader.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<S3JsonItemReader>
Enclosing class:
S3JsonItemReader

@Stability(Stable) public static final class S3JsonItemReader.Builder extends Object implements software.amazon.jsii.Builder<S3JsonItemReader>
A fluent builder for S3JsonItemReader.
  • Method Details

    • create

      @Stability(Stable) public static S3JsonItemReader.Builder create()
      Returns:
      a new instance of S3JsonItemReader.Builder.
    • bucket

      @Stability(Stable) public S3JsonItemReader.Builder bucket(IBucket bucket)
      S3 Bucket containing objects to iterate over or a file with a list to iterate over.

      Default: - S3 bucket will be determined from

      Parameters:
      bucket - S3 Bucket containing objects to iterate over or a file with a list to iterate over. This parameter is required.
      Returns:
      this
      See Also:
    • bucketNamePath

      @Stability(Stable) public S3JsonItemReader.Builder bucketNamePath(String bucketNamePath)
      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

      Parameters:
      bucketNamePath - S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath. This parameter is required.
      Returns:
      this
      See Also:
    • maxItems

      @Stability(Stable) public S3JsonItemReader.Builder maxItems(Number maxItems)
      Limits the number of items passed to the Distributed Map state.

      Default: - Distributed Map state will iterate over all items provided by the ItemReader

      Parameters:
      maxItems - Limits the number of items passed to the Distributed Map state. This parameter is required.
      Returns:
      this
    • key

      @Stability(Stable) public S3JsonItemReader.Builder key(String key)
      Key of file stored in S3 bucket containing an array to iterate over.

      Parameters:
      key - Key of file stored in S3 bucket containing an array to iterate over. This parameter is required.
      Returns:
      this
    • build

      @Stability(Stable) public S3JsonItemReader build()
      Specified by:
      build in interface software.amazon.jsii.Builder<S3JsonItemReader>
      Returns:
      a newly built instance of S3JsonItemReader.