Skip to content
v2.276.0

JsonataStateOptions Struct ​

Option properties for JSONata task state.

Example ​

ts
// 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 arguments_: any;
declare const outputs: any;
const jsonataStateOptions: stepfunctions.JsonataStateOptions = {
  arguments: arguments_,
  outputs: outputs,
};
python
# 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

# arguments_: Any
# outputs: Any

jsonata_state_options = stepfunctions.JsonataStateOptions(
    arguments=arguments_,
    outputs=outputs
)
java
// 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 arguments_;
Object outputs;

JsonataStateOptions jsonataStateOptions = JsonataStateOptions.builder()
        .arguments(arguments_)
        .outputs(outputs)
        .build();
csharp
// 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 arguments_;
var outputs;

var jsonataStateOptions = new JsonataStateOptions {
    Arguments = arguments_,
    Outputs = outputs
};
go
// 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 arguments_ interface{}
var outputs interface{}

jsonataStateOptions := &JsonataStateOptions{
	Arguments: arguments_,
	Outputs: outputs,
}

Properties ​

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

Default: No arguments

outputsoptionalanyoutputsoptionalAnyoutputsoptionalObjectOutputsoptionalobjectOutputsoptionalinterface{}#
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.