Package software.amazon.awscdk.services.codepipeline.actions

Class StepFunctionInvokeAction.Builder

java.lang.Object
software.amazon.awscdk.services.codepipeline.actions.StepFunctionInvokeAction.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<StepFunctionInvokeAction>
Enclosing class:
StepFunctionInvokeAction
@Stability(Stable) public static final class StepFunctionInvokeAction.Builder extends Object implements software.amazon.jsii.Builder<StepFunctionInvokeAction>
A fluent builder for StepFunctionInvokeAction.

  • Method Details

    • create

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

    • actionName

      @Stability(Stable) public StepFunctionInvokeAction.Builder actionName(String actionName)
      The physical, human-readable name of the Action.

      Note that Action names must be unique within a single Stage.

      Parameters:
      actionName - The physical, human-readable name of the Action. This parameter is required.
      Returns:
      this

    • runOrder

      @Stability(Stable) public StepFunctionInvokeAction.Builder runOrder(Number runOrder)
      The runOrder property for this Action.

      RunOrder determines the relative order in which multiple Actions in the same Stage execute.

      Default: 1

      Parameters:
      runOrder - The runOrder property for this Action. This parameter is required.
      Returns:
      this
      See Also:

    • variablesNamespace

      @Stability(Stable) public StepFunctionInvokeAction.Builder variablesNamespace(String variablesNamespace)
      The name of the namespace to use for variables emitted by this action.

      Default: - a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set

      Parameters:
      variablesNamespace - The name of the namespace to use for variables emitted by this action. This parameter is required.
      Returns:
      this

    • role

      @Stability(Stable) public StepFunctionInvokeAction.Builder role(IRole role)
      The Role in which context's this Action will be executing in.

      The Pipeline's Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your IAction.bind method in the ActionBindOptions.role property.

      Default: a new Role will be generated

      Parameters:
      role - The Role in which context's this Action will be executing in. This parameter is required.
      Returns:
      this

    • stateMachine

      @Stability(Stable) public StepFunctionInvokeAction.Builder stateMachine(IStateMachine stateMachine)
      The state machine to invoke.

      Parameters:
      stateMachine - The state machine to invoke. This parameter is required.
      Returns:
      this

    • executionNamePrefix

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

      Parameters:
      executionNamePrefix - Prefix (optional). This parameter is required.
      Returns:
      this

    • output

      @Stability(Stable) public StepFunctionInvokeAction.Builder output(Artifact output)
      The optional output Artifact of the Action.

      Default: the Action will not have any outputs

      Parameters:
      output - The optional output Artifact of the Action. This parameter is required.
      Returns:
      this

    • stateMachineInput

      @Stability(Stable) public StepFunctionInvokeAction.Builder stateMachineInput(StateMachineInput stateMachineInput)
      Represents the input to the StateMachine.

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

      Default: - none

      Parameters:
      stateMachineInput - Represents the input to the StateMachine. This parameter is required.
      Returns:
      this

    • build

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