interface WaitJsonPathProps

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.WaitJsonPathProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#WaitJsonPathProps
Java	software.amazon.awscdk.services.stepfunctions.WaitJsonPathProps
Python	aws_cdk.aws_stepfunctions.WaitJsonPathProps
TypeScript (source)	aws-cdk-lib » aws_stepfunctions » WaitJsonPathProps

Properties for defining a Wait state that using JSONPath.

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 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',
};

Properties

Name	Type	Description
time	WaitTime	Wait duration.
assign?	{ [string]: any }	Workflow variables to store in this step.
comment?	string	A comment describing this state.
inputPath?	string	JSONPath expression to select part of the state to be the input to this state.
outputPath?	string	JSONPath expression to select part of the state to be the output to this state.
queryLanguage?	QueryLanguage	The name of the query language used by the state.
stateName?	string	Optional name for this state.

---

time

Type: WaitTime

Wait duration.

---

assign?

Type: { [string]: any } (optional, default: Not assign variables)

Workflow variables to store in this step.

Using workflow variables, you can store data in a step and retrieve that data in future steps.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

---

comment?

Type: string (optional, default: No comment)

A comment describing this state.

---

inputPath?

Type: string (optional, default: $)

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

---

outputPath?

Type: string (optional, default: $)

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

---

queryLanguage?

Type: QueryLanguage (optional, default: 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.

---

stateName?

Type: string (optional, default: The construct ID will be used as state name)

Optional name for this state.