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

Interface StepFunctionsInvokeActionProps

All Superinterfaces:

CommonActionProps, CommonAwsActionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

StepFunctionsInvokeActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-10-31T19:12:55.168Z")
@Stability(Stable)
public interface StepFunctionsInvokeActionProps
extends software.amazon.jsii.JsiiSerializable, CommonAwsActionProps

Construction properties of the StepFunctionsInvokeAction 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());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	StepFunctionsInvokeActionProps.Builder	A builder for StepFunctionsInvokeActionProps
static final class	StepFunctionsInvokeActionProps.Jsii$Proxy	An implementation for StepFunctionsInvokeActionProps

Method Summary

Modifier and Type	Method	Description
static StepFunctionsInvokeActionProps.Builder	builder()
default String	getExecutionNamePrefix()	Prefix (optional).
default Artifact	getOutput()	The optional output Artifact of the Action.
IStateMachine	getStateMachine()	The state machine to invoke.
default StateMachineInput	getStateMachineInput()	Represents the input to the StateMachine.

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonActionProps

getActionName, getRunOrder, getVariablesNamespace

Methods inherited from interface software.amazon.awscdk.services.codepipeline.CommonAwsActionProps

getRole

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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