Class ChoiceJsonataProps

Properties for defining a Choice state that using JSONata.

Inheritance
object
ChoiceJsonataProps
Inherited Members
Namespace: Amazon.CDK.AWS.StepFunctions
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ChoiceJsonataProps : IChoiceJsonataProps, IStateBaseProps, IAssignableStateOptions, IJsonataCommonOptions
Syntax (vb)
Public Class ChoiceJsonataProps Implements IChoiceJsonataProps, IStateBaseProps, IAssignableStateOptions, 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 assign;
            var outputs;

            var choiceJsonataProps = new ChoiceJsonataProps {
                Assign = new Dictionary<string, object> {
                    { "assignKey", assign }
                },
                Comment = "comment",
                Outputs = outputs,
                QueryLanguage = QueryLanguage.JSON_PATH,
                StateName = "stateName"
            };

Synopsis

Constructors

ChoiceJsonataProps()

Properties for defining a Choice state that using JSONata.

Properties

Assign

Workflow variables to store in this step.
Comment

A comment describing this state.
Outputs

Used to specify and transform output from the state.
QueryLanguage

The name of the query language used by the state.
StateName

Optional name for this state.

Constructors

ChoiceJsonataProps()

Properties for defining a Choice state that using JSONata.

public ChoiceJsonataProps()
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 assign;
            var outputs;

            var choiceJsonataProps = new ChoiceJsonataProps {
                Assign = new Dictionary<string, object> {
                    { "assignKey", assign }
                },
                Comment = "comment",
                Outputs = outputs,
                QueryLanguage = QueryLanguage.JSON_PATH,
                StateName = "stateName"
            };

Properties

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

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

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

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