JsonataStateProps Struct
Properties shared by all states that use JSONata.
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 assign: any;
declare const outputs: any;
const jsonataStateProps: stepfunctions.JsonataStateProps = {
arguments: arguments_,
assign: {
assignKey: assign,
},
comment: 'comment',
outputs: outputs,
queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
stateName: 'stateName',
};
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
# assign: Any
# outputs: Any
jsonata_state_props = stepfunctions.JsonataStateProps(
arguments=arguments_,
assign={
"assign_key": assign
},
comment="comment",
outputs=outputs,
query_language=stepfunctions.QueryLanguage.JSON_PATH,
state_name="stateName"
)
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 assign;
Object outputs;
JsonataStateProps jsonataStateProps = JsonataStateProps.builder()
.arguments(arguments_)
.assign(Map.of(
"assignKey", assign))
.comment("comment")
.outputs(outputs)
.queryLanguage(QueryLanguage.JSON_PATH)
.stateName("stateName")
.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 assign;
var outputs;
var jsonataStateProps = new JsonataStateProps {
Arguments = arguments_,
Assign = new Dictionary<string, object> {
{ "assignKey", assign }
},
Comment = "comment",
Outputs = outputs,
QueryLanguage = QueryLanguage.JSON_PATH,
StateName = "stateName"
};
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 assign interface{}
var outputs interface{}
jsonataStateProps := &JsonataStateProps{
Arguments: arguments_,
Assign: map[string]interface{}{
"assignKey": assign,
},
Comment: jsii.String("comment"),
Outputs: outputs,
QueryLanguage: awscdk.Aws_stepfunctions.QueryLanguage_JSON_PATH,
StateName: jsii.String("stateName"),
}
Properties
argumentsoptionalanyargumentsoptionalAnyargumentsoptionalObjectArgumentsoptionalobjectArgumentsoptionalinterface{}#Parameters pass a collection of key-value pairs, either static values or JSONata expressions that select from the input.
Default: No arguments
assignoptional{ [key: string]: any }assignoptionaltyping.Mapping[str, Any]assignoptionalMap<String, Object>AssignoptionalIDictionary<string, object>Assignoptional*map[string]interface{}#Workflow variables to store in this step.
Default: Not assign variables
Using workflow variables, you can store data in a step and retrieve that data in future steps.
commentoptionalstringcommentoptionalstrcommentoptionalStringCommentoptionalstringCommentoptional*string#A comment describing this state.
Default: No comment
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.
queryLanguageoptionalQueryLanguagequery_languageoptionalQueryLanguagequeryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguageQueryLanguageoptionalQueryLanguage= JSONPath#The name of the query language used by the state.
If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.
stateNameoptionalstringstate_nameoptionalstrstateNameoptionalStringStateNameoptionalstringStateNameoptional*string#Optional name for this state.
Default: The construct ID will be used as state name