Interface StepFunctionsInvokeActionProps

All Superinterfaces:
CommonActionProps, CommonAwsActionProps, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
StepFunctionsInvokeActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:48.511Z") @Stability(Stable) public interface StepFunctionsInvokeActionProps extends software.amazon.jsii.JsiiSerializable, CommonAwsActionProps
Construction properties of the StepFunction Invoke Action.

Example:

 import software.amazon.awscdk.services.stepfunctions.*;
 Pipeline pipeline = new Pipeline(this, "MyPipeline");
 Pass startState = new Pass(this, "StartState");
 StateMachine simpleStateMachine = StateMachine.Builder.create(this, "SimpleStateMachine")
         .definition(startState)
         .build();
 StepFunctionInvokeAction stepFunctionAction = StepFunctionInvokeAction.Builder.create()
         .actionName("Invoke")
         .stateMachine(simpleStateMachine)
         .stateMachineInput(StateMachineInput.literal(Map.of("IsHelloWorldExample", true)))
         .build();
 pipeline.addStage(StageOptions.builder()
         .stageName("StepFunctions")
         .actions(List.of(stepFunctionAction))
         .build());
 
  • Method Details

    • getStateMachine

      @Stability(Stable) @NotNull IStateMachine getStateMachine()
      The state machine to invoke.
    • getExecutionNamePrefix

      @Stability(Stable) @Nullable default String getExecutionNamePrefix()
      Prefix (optional).

      By default, the action execution ID is used as the state machine execution name. If a prefix is provided, it is prepended to the action execution ID with a hyphen and together used as the state machine execution name.

      Default: - action execution ID

    • getOutput

      @Stability(Stable) @Nullable default Artifact getOutput()
      The optional output Artifact of the Action.

      Default: the Action will not have any outputs

    • getStateMachineInput

      @Stability(Stable) @Nullable default StateMachineInput getStateMachineInput()
      Represents the input to the StateMachine.

      This includes input artifact, input type and the statemachine input.

      Default: - none

    • builder

      @Stability(Stable) static StepFunctionsInvokeActionProps.Builder builder()
      Returns:
      a StepFunctionsInvokeActionProps.Builder of StepFunctionsInvokeActionProps