aws-cdk-lib.aws_stepfunctions.JsonataCommonOptions

JsonataCommonOptions Struct

Option properties for JSONata state.

Source

aws-stepfunctions/lib/states/state.ts

Type last changed

v2.178.0 · 6 Feb 2025

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_stepfunctions as stepfunctions } from 'aws-cdk-lib';

declare const outputs: any;
const jsonataCommonOptions: stepfunctions.JsonataCommonOptions = {
  outputs: outputs,
};

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_stepfunctions as stepfunctions

# outputs: Any

jsonata_common_options = stepfunctions.JsonataCommonOptions(
    outputs=outputs
)

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.stepfunctions.*;

Object outputs;

JsonataCommonOptions jsonataCommonOptions = JsonataCommonOptions.builder()
        .outputs(outputs)
        .build();

// Install: dotnet add package Amazon.CDK.Lib
// 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
};

// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

var outputs interface{}

jsonataCommonOptions := &JsonataCommonOptions{
	Outputs: outputs,
}

Properties

outputs?optionalanyoutputs?optionalAnyoutputs?optionalObjectOutputs?optionalobjectOutputs?optionalinterface{}#

Used to specify and transform output from the state.

Default: $states.result or $states.errorOutput

notes

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.