software.amazon.awscdk.services.codepipeline.actions

Interface StepFunctionsInvokeActionProps

All Superinterfaces:

CommonActionProps, CommonAwsActionProps

All Known Implementing Classes:

StepFunctionsInvokeActionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-20T22:20:06.393Z")
public interface StepFunctionsInvokeActionProps
extends 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());
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static StepFunctionsInvokeActionProps.Builder	builder()
default java.lang.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.CommonAwsActionProps

getRole

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

getActionName, getRunOrder, getVariablesNamespace

Method Detail

getStateMachine

IStateMachine getStateMachine()

The state machine to invoke.

getExecutionNamePrefix

default java.lang.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

default Artifact getOutput()

The optional output Artifact of the Action.

Default: the Action will not have any outputs

getStateMachineInput

default StateMachineInput getStateMachineInput()

Represents the input to the StateMachine.

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

Default: - none

builder

static StepFunctionsInvokeActionProps.Builder builder()

Specified by:

builder in interface CommonActionProps

Specified by:

builder in interface CommonAwsActionProps

Returns:

a StepFunctionsInvokeActionProps.Builder of StepFunctionsInvokeActionProps