Class SingleStateOptions

Options for creating a single state.

Inheritance

object

SingleStateOptions

Implements

ISingleStateOptions

IParallelProps

IStateBaseProps

IAssignableStateOptions

IJsonPathCommonOptions

IJsonataCommonOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.StepFunctions

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class SingleStateOptions : ISingleStateOptions, IParallelProps, IStateBaseProps, IAssignableStateOptions, IJsonPathCommonOptions, IJsonataCommonOptions

Syntax (vb)

Public Class SingleStateOptions Implements ISingleStateOptions, IParallelProps, IStateBaseProps, IAssignableStateOptions, IJsonPathCommonOptions, IJsonataCommonOptions

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 arguments_;
            var assign;
            var outputs;
            var parameters;
            var resultSelector;

            var singleStateOptions = new SingleStateOptions {
                Arguments = new Dictionary<string, object> {
                    { "argumentsKey", arguments_ }
                },
                Assign = new Dictionary<string, object> {
                    { "assignKey", assign }
                },
                Comment = "comment",
                InputPath = "inputPath",
                OutputPath = "outputPath",
                Outputs = outputs,
                Parameters = new Dictionary<string, object> {
                    { "parametersKey", parameters }
                },
                PrefixStates = "prefixStates",
                QueryLanguage = QueryLanguage.JSON_PATH,
                ResultPath = "resultPath",
                ResultSelector = new Dictionary<string, object> {
                    { "resultSelectorKey", resultSelector }
                },
                StateId = "stateId",
                StateName = "stateName"
            };

Synopsis

Constructors

SingleStateOptions()

Options for creating a single state.

Properties

Arguments	Parameters pass a collection of key-value pairs, either static values or JSONata expressions that select from the input.
Assign	Workflow variables to store in this step.
Comment	A comment describing 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.
Outputs	Used to specify and transform output from the state.
Parameters	Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.
PrefixStates	String to prefix all stateIds in the state machine with.
QueryLanguage	The name of the query language used by the state.
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()

Options for creating a single state.

public SingleStateOptions()

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 arguments_;
            var assign;
            var outputs;
            var parameters;
            var resultSelector;

            var singleStateOptions = new SingleStateOptions {
                Arguments = new Dictionary<string, object> {
                    { "argumentsKey", arguments_ }
                },
                Assign = new Dictionary<string, object> {
                    { "assignKey", assign }
                },
                Comment = "comment",
                InputPath = "inputPath",
                OutputPath = "outputPath",
                Outputs = outputs,
                Parameters = new Dictionary<string, object> {
                    { "parametersKey", parameters }
                },
                PrefixStates = "prefixStates",
                QueryLanguage = QueryLanguage.JSON_PATH,
                ResultPath = "resultPath",
                ResultSelector = new Dictionary<string, object> {
                    { "resultSelectorKey", resultSelector }
                },
                StateId = "stateId",
                StateName = "stateName"
            };

Properties

Arguments

Parameters pass a collection of key-value pairs, either static values or JSONata expressions that select from the input.

public IDictionary<string, object>? Arguments { get; set; }

Property Value

IDictionary<string, object>

Remarks

Default: No arguments

See: https://docs.aws.amazon.com/step-functions/latest/dg/transforming-data.html

Assign

Workflow variables to store in this step.

public IDictionary<string, object>? Assign { get; set; }

Property Value

IDictionary<string, object>

Remarks

Using workflow variables, you can store data in a step and retrieve that data in future steps.

Default: - Not assign variables

See: https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

Comment

A comment describing this state.

public string? Comment { get; set; }

Property Value

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

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

string

Remarks

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

Default: $

Outputs

Used to specify and transform output from the state.

public object? Outputs { get; set; }

Property Value

object

Remarks

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Default: - $states.result or $states.errorOutput

See: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

Parameters

Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.

public IDictionary<string, object>? Parameters { get; set; }

Property Value

IDictionary<string, object>

Remarks

Default: No parameters

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

PrefixStates

String to prefix all stateIds in the state machine with.

public string? PrefixStates { get; set; }

Property Value

string

Remarks

Default: stateId

QueryLanguage

The name of the query language used by the state.

public QueryLanguage? QueryLanguage { get; set; }

Property Value

QueryLanguage?

Remarks

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Default: - JSONPath

ResultPath

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

public string? ResultPath { get; set; }

Property Value

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

IDictionary<string, 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

string

Remarks

Default: Construct ID of the StateMachineFragment

StateName

Optional name for this state.

public string? StateName { get; set; }

Property Value

string

Remarks

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

Implements

ISingleStateOptions

IParallelProps

IStateBaseProps

IAssignableStateOptions

IJsonPathCommonOptions

IJsonataCommonOptions