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

Class StateMachineInput

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.codepipeline.actions.StateMachineInput

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:04.560Z")
@Stability(Stable)
public class StateMachineInput
extends software.amazon.jsii.JsiiObject

Represents the input for the StateMachine.

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/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StateMachineInput(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	StateMachineInput(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
static StateMachineInput	filePath(ArtifactPath inputFile)	When the input type is FilePath, input artifact and filepath must be specified.
Object	getInput()	When InputType is set to Literal (default), the Input field is used directly as the input for the state machine execution.
Artifact	getInputArtifact()	The optional input Artifact of the Action.
String	getInputType()	Optional StateMachine InputType InputType can be Literal or FilePath.
static StateMachineInput	literal(com.fasterxml.jackson.databind.node.ObjectNode object)	When the input type is Literal, input value is passed directly to the state machine input.

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

StateMachineInput

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

StateMachineInput

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

Method Details

filePath

@Stability(Stable)
@NotNull
public static StateMachineInput filePath(@NotNull
 ArtifactPath inputFile)

When the input type is FilePath, input artifact and filepath must be specified.

Parameters:

inputFile - This parameter is required.

literal

@Stability(Stable)
@NotNull
public static StateMachineInput literal(@NotNull
 com.fasterxml.jackson.databind.node.ObjectNode object)

When the input type is Literal, input value is passed directly to the state machine input.

Parameters:

object - This parameter is required.

getInput

@Stability(Stable)
@NotNull
public Object getInput()

When InputType is set to Literal (default), the Input field is used directly as the input for the state machine execution.

Otherwise, the state machine is invoked with an empty JSON object {}.

When InputType is set to FilePath, this field is required. An input artifact is also required when InputType is set to FilePath.

Default: - none

getInputArtifact

@Stability(Stable)
@Nullable
public Artifact getInputArtifact()

The optional input Artifact of the Action.

If InputType is set to FilePath, this artifact is required and is used to source the input for the state machine execution.

Default: - the Action will not have any inputs

See Also:

• https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-StepFunctions.html#action-reference-StepFunctions-example

getInputType

@Stability(Stable)
@Nullable
public String getInputType()

Optional StateMachine InputType InputType can be Literal or FilePath.

Default: - Literal