Skip to content
v2.278.0

WaitJsonPathProps Struct ​

Properties for defining a Wait state that using JSONPath.

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 assign: any;
declare const waitTime: stepfunctions.WaitTime;
const waitJsonPathProps: stepfunctions.WaitJsonPathProps = {
  time: waitTime,

  // the properties below are optional
  assign: {
    assignKey: assign,
  },
  comment: 'comment',
  inputPath: 'inputPath',
  outputPath: 'outputPath',
  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

# assign: Any
# wait_time: stepfunctions.WaitTime

wait_json_path_props = stepfunctions.WaitJsonPathProps(
    time=wait_time,

    # the properties below are optional
    assign={
        "assign_key": assign
    },
    comment="comment",
    input_path="inputPath",
    output_path="outputPath",
    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 assign;
WaitTime waitTime;

WaitJsonPathProps waitJsonPathProps = WaitJsonPathProps.builder()
        .time(waitTime)

        // the properties below are optional
        .assign(Map.of(
                "assignKey", assign))
        .comment("comment")
        .inputPath("inputPath")
        .outputPath("outputPath")
        .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 assign;
WaitTime waitTime;

var waitJsonPathProps = new WaitJsonPathProps {
    Time = waitTime,

    // the properties below are optional
    Assign = new Dictionary<string, object> {
        { "assignKey", assign }
    },
    Comment = "comment",
    InputPath = "inputPath",
    OutputPath = "outputPath",
    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 assign interface{}
var waitTime WaitTime

waitJsonPathProps := &WaitJsonPathProps{
	Time: waitTime,

	// the properties below are optional
	Assign: map[string]interface{}{
		"assignKey": assign,
	},
	Comment: jsii.String("comment"),
	InputPath: jsii.String("inputPath"),
	OutputPath: jsii.String("outputPath"),
	QueryLanguage: awscdk.Aws_stepfunctions.QueryLanguage_JSON_PATH,
	StateName: jsii.String("stateName"),
}

Properties ​

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

inputPathoptionalstringinput_pathoptionalstrinputPathoptionalStringInputPathoptionalstringInputPathoptional*string = $ #
JSONPath expression to select part of the state to be the input to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective input to be the empty object {}.

outputPathoptionalstringoutput_pathoptionalstroutputPathoptionalStringOutputPathoptionalstringOutputPathoptional*string = $ #
JSONPath expression to select part of the state to be the output to this state.

May also be the special value JsonPath.DISCARD, which will cause the effective output to be the empty object {}.

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

timeWaitTimetimeWaitTimetimeWaitTimeTimeWaitTimeTimeWaitTime required #
Wait duration.