Package software.amazon.awscdk.services.stepfunctions

Interface IItemReader.Jsii$Default

All Superinterfaces:
IItemReader, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IItemReader.Jsii$Proxy
Enclosing interface:
IItemReader
@Internal public static interface IItemReader.Jsii$Default extends IItemReader
Internal default implementation for IItemReader.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface software.amazon.awscdk.services.stepfunctions.IItemReader

    IItemReader.Jsii$Default, IItemReader.Jsii$Proxy

  • Method Summary

    Modifier and Type
    Method
    Description
    default IBucket
    getBucket()
    S3 Bucket containing objects to iterate over or a file with a list to iterate over.
    default String
    getBucketNamePath()
    S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath.
    default Number
    getMaxItems()
    Limits the number of items passed to the Distributed Map state.
    default String
    getResource()
    The Amazon S3 API action that Step Functions must invoke depending on the specified dataset.
    default List<PolicyStatement>
    providePolicyStatements()
    Compile policy statements to provide relevent permissions to the state machine.
    default Object
    render(QueryLanguage queryLanguage)
    Render the ItemReader as JSON object.
    default List<String>
    validateItemReader()
    Validate that ItemReader contains exactly either.

    Methods inherited from interface software.amazon.awscdk.services.stepfunctions.IItemReader

    render

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getBucket

      @Stability(Stable) @NotNull default IBucket getBucket()
      S3 Bucket containing objects to iterate over or a file with a list to iterate over.
      Specified by:
      getBucket in interface IItemReader

    • getResource

      @Stability(Stable) @NotNull default String getResource()
      The Amazon S3 API action that Step Functions must invoke depending on the specified dataset.
      Specified by:
      getResource in interface IItemReader

    • getBucketNamePath

      @Stability(Stable) @Nullable default String getBucketNamePath()
      S3 bucket name containing objects to iterate over or a file with a list to iterate over, as JsonPath.
      Specified by:
      getBucketNamePath in interface IItemReader

    • getMaxItems

      @Stability(Stable) @Nullable default Number getMaxItems()
      Limits the number of items passed to the Distributed Map state.

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

      Specified by:
      getMaxItems in interface IItemReader

    • providePolicyStatements

      @Stability(Stable) @NotNull default List<PolicyStatement> providePolicyStatements()
      Compile policy statements to provide relevent permissions to the state machine.
      Specified by:
      providePolicyStatements in interface IItemReader

    • render

      @Stability(Stable) @NotNull default Object render(@Nullable QueryLanguage queryLanguage)
      Render the ItemReader as JSON object.

      Specified by:
      render in interface IItemReader
      Parameters:
      queryLanguage -

    • validateItemReader

      @Stability(Stable) @NotNull default List<String> validateItemReader()
      Validate that ItemReader contains exactly either.

      Specified by:
      validateItemReader in interface IItemReader
      See Also: