Class StateMachineInput

Represents the input for the StateMachine.

Inheritance

System.Object

StateMachineInput

Namespace: Amazon.CDK.AWS.CodePipeline.Actions

Assembly: Amazon.CDK.AWS.CodePipeline.Actions.dll

Syntax (csharp)

public class StateMachineInput : DeputyBase

Syntax (vb)

Public Class StateMachineInput
    Inherits DeputyBase

Remarks

ExampleMetadata: infused

Examples

using Amazon.CDK.AWS.StepFunctions;

var pipeline = new Pipeline(this, "MyPipeline");
var startState = new Pass(this, "StartState");
var simpleStateMachine = new StateMachine(this, "SimpleStateMachine", new StateMachineProps {
    Definition = startState
});
var stepFunctionAction = new StepFunctionInvokeAction(new StepFunctionsInvokeActionProps {
    ActionName = "Invoke",
    StateMachine = simpleStateMachine,
    StateMachineInput = StateMachineInput.Literal(new Dictionary<string, boolean> { { "IsHelloWorldExample", true } })
});
pipeline.AddStage(new StageOptions {
    StageName = "StepFunctions",
    Actions = new [] { stepFunctionAction }
});

Synopsis

Constructors

StateMachineInput(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
StateMachineInput(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

Properties

Input	When InputType is set to Literal (default), the Input field is used directly as the input for the state machine execution.
InputArtifact	The optional input Artifact of the Action.
InputType	Optional StateMachine InputType InputType can be Literal or FilePath.

Methods

FilePath(ArtifactPath_)	When the input type is FilePath, input artifact and filepath must be specified.
Literal(JObject)	When the input type is Literal, input value is passed directly to the state machine input.

Constructors

StateMachineInput(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected StateMachineInput(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue

The Javascript-owned object reference

StateMachineInput(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected StateMachineInput(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps

The deputy props

Properties

Input

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

public virtual object Input { get; }

Property Value

System.Object

Remarks

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

InputArtifact

The optional input Artifact of the Action.

public virtual Artifact_ InputArtifact { get; }

Property Value

Artifact_

Remarks

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: https://docs.aws.amazon.com/codepipeline/latest/userguide/action-reference-StepFunctions.html#action-reference-StepFunctions-example

InputType

Optional StateMachine InputType InputType can be Literal or FilePath.

public virtual string InputType { get; }

Property Value

System.String

Remarks

Default: - Literal

Methods

FilePath(ArtifactPath_)

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

public static StateMachineInput FilePath(ArtifactPath_ inputFile)

Parameters

inputFile ArtifactPath_

Returns

StateMachineInput

Literal(JObject)

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

public static StateMachineInput Literal(JObject object)

Parameters

object Newtonsoft.Json.Linq.JObject

Returns

StateMachineInput