Class SingleStateOptions

Options for creating a single state.

Inheritance
System.Object
SingleStateOptions
Namespace: Amazon.CDK.AWS.StepFunctions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class SingleStateOptions : Object, ISingleStateOptions, IParallelProps
Syntax (vb)
Public Class SingleStateOptions
    Inherits Object
    Implements ISingleStateOptions, IParallelProps
Remarks

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.StepFunctions;

var resultSelector;

var singleStateOptions = new SingleStateOptions {
    Comment = "comment",
    InputPath = "inputPath",
    OutputPath = "outputPath",
    PrefixStates = "prefixStates",
    ResultPath = "resultPath",
    ResultSelector = new Dictionary<string, object> {
        { "resultSelectorKey", resultSelector }
    },
    StateId = "stateId",
    StateName = "stateName"
};

Synopsis

Constructors

SingleStateOptions()

Properties

Comment

An optional description for this state.
InputPath

JSONPath expression to select part of the state to be the input to this state.
OutputPath

JSONPath expression to select part of the state to be the output to this state.
PrefixStates

String to prefix all stateIds in the state machine with.
ResultPath

JSONPath expression to indicate where to inject the state's output.
ResultSelector

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.
StateId

ID of newly created containing state.
StateName

Optional name for this state.

Constructors

SingleStateOptions()

public SingleStateOptions()

Properties

Comment

An optional description for this state.

public string Comment { get; set; }
Property Value

System.String

Remarks

Default: No comment

InputPath

JSONPath expression to select part of the state to be the input to this state.

public string InputPath { get; set; }
Property Value

System.String

Remarks

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

Default: $

OutputPath

JSONPath expression to select part of the state to be the output to this state.

public string OutputPath { get; set; }
Property Value

System.String

Remarks

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

Default: $

PrefixStates

String to prefix all stateIds in the state machine with.

public string PrefixStates { get; set; }
Property Value

System.String

Remarks

Default: stateId

ResultPath

JSONPath expression to indicate where to inject the state's output.

public string ResultPath { get; set; }
Property Value

System.String

Remarks

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

Default: $

ResultSelector

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

public IDictionary<string, object> ResultSelector { get; set; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Remarks

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

Default: - None

See: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-resultselector

StateId

ID of newly created containing state.

public string StateId { get; set; }
Property Value

System.String

Remarks

Default: Construct ID of the StateMachineFragment

StateName

Optional name for this state.

public string StateName { get; set; }
Property Value

System.String

Remarks

Default: - The construct ID will be used as state name

Implements