Package software.amazon.awscdk.services.stepfunctions

Class ResultWriter

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.stepfunctions.ResultWriter
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-06T23:25:17.567Z") @Stability(Stable) public class ResultWriter extends software.amazon.jsii.JsiiObject
Configuration for writing Distributed Map state results to S3.

Example: 

 import software.amazon.awscdk.services.s3.*;
 // create a bucket
 Bucket bucket = new Bucket(this, "Bucket");
 DistributedMap distributedMap = DistributedMap.Builder.create(this, "Distributed Map State")
         .resultWriter(ResultWriter.Builder.create()
                 .bucket(bucket)
                 .prefix("my-prefix")
                 .build())
         .build();
 distributedMap.itemProcessor(new Pass(this, "Pass State"));

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    ResultWriter.Builder
    A fluent builder for ResultWriter.

    Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

    software.amazon.jsii.JsiiObject.InitializationMode

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
     
    ResultWriter(ResultWriterProps props)
     
    protected
    ResultWriter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
     
    protected
    ResultWriter(software.amazon.jsii.JsiiObjectRef objRef)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    IBucket
    getBucket()
    S3 Bucket in which to save Map Run results.
    String
    getPrefix()
    S3 prefix in which to save Map Run results.
    List<PolicyStatement>
    providePolicyStatements()
    Compile policy statements to provide relevent permissions to the state machine.
    Object
    render()
    Render ResultWriter in ASL JSON format.

    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

    • ResultWriter

      protected ResultWriter(software.amazon.jsii.JsiiObjectRef objRef)

    • ResultWriter

      protected ResultWriter(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • ResultWriter

      @Stability(Stable) public ResultWriter(@NotNull ResultWriterProps props)
      Parameters:
      props - This parameter is required.

  • Method Details

    • providePolicyStatements

      @Stability(Stable) @NotNull public List<PolicyStatement> providePolicyStatements()
      Compile policy statements to provide relevent permissions to the state machine.

    • render

      @Stability(Stable) @NotNull public Object render()
      Render ResultWriter in ASL JSON format.

    • getBucket

      @Stability(Stable) @NotNull public IBucket getBucket()
      S3 Bucket in which to save Map Run results.

    • getPrefix

      @Stability(Stable) @Nullable public String getPrefix()
      S3 prefix in which to save Map Run results.

      Default: - No prefix