Show / Hide Table of Contents

Class JsonataCommonOptions

Option properties for JSONata state.

Inheritance
object
JsonataCommonOptions
Implements
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 JsonataCommonOptions : IJsonataCommonOptions
Syntax (vb)
Public Class JsonataCommonOptions Implements 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 outputs;

            var jsonataCommonOptions = new JsonataCommonOptions {
                Outputs = outputs
            };

Synopsis

Constructors

JsonataCommonOptions()

Option properties for JSONata state.

Properties

Outputs

Used to specify and transform output from the state.

Constructors

JsonataCommonOptions()

Option properties for JSONata state.

public JsonataCommonOptions()
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 outputs;

            var jsonataCommonOptions = new JsonataCommonOptions {
                Outputs = outputs
            };

Properties

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

Implements

IJsonataCommonOptions
Back to top Generated by DocFX