aws-cdk-lib.aws_stepfunctions_tasks.StepFunctionsStartExecutionJsonPathProps

StepFunctionsStartExecutionJsonPathProps Struct

Properties for StartExecution using JSONPath.

StepFunctionsStartExecutionJsonPathProps

extends

• TaskStateJsonPathBaseProps

Source

aws-stepfunctions-tasks/lib/stepfunctions/start-execution.ts

Type last changed

v2.234.0 · 8 Jan 2026

Example

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

declare const assign: any;
declare const resultSelector: any;
declare const stateMachineRef: interfaces_stepfunctions.IStateMachineRef;
declare const taskInput: stepfunctions.TaskInput;
declare const taskRole: stepfunctions.TaskRole;
declare const timeout: stepfunctions.Timeout;
const stepFunctionsStartExecutionJsonPathProps: stepfunctions_tasks.StepFunctionsStartExecutionJsonPathProps = {
  stateMachine: stateMachineRef,

  // the properties below are optional
  assign: {
    assignKey: assign,
  },
  associateWithParent: false,
  comment: 'comment',
  credentials: {
    role: taskRole,
  },
  heartbeat: cdk.Duration.minutes(30),
  heartbeatTimeout: timeout,
  input: taskInput,
  inputPath: 'inputPath',
  integrationPattern: stepfunctions.IntegrationPattern.REQUEST_RESPONSE,
  name: 'name',
  outputPath: 'outputPath',
  queryLanguage: stepfunctions.QueryLanguage.JSON_PATH,
  resultPath: 'resultPath',
  resultSelector: {
    resultSelectorKey: resultSelector,
  },
  stateName: 'stateName',
  taskTimeout: timeout,
  timeout: cdk.Duration.minutes(30),
};

Properties

assign{ [key: string]: any }assigntyping.Mapping[str, Any]assignMap<String, Object>AssignIDictionary<string, object>Assign*map[string]interface{}= 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.

associateWithParentbooleanassociate_with_parentboolassociateWithParentBooleanAssociateWithParentboolAssociateWithParent*bool= false#

Pass the execution ID from the context object to the execution input.

notes

This allows the Step Functions UI to link child executions from parent executions, making it easier to trace execution flow across state machines.

If you set this property to true, the input property must be an object (provided by sfn.TaskInput.fromObject) or omitted entirely.

commentstringcommentstrcommentStringCommentstringComment*string= No comment#

A comment describing this state.

credentialsCredentialscredentialsCredentialscredentialsCredentialsCredentialsCredentialsCredentialsCredentials= None (Task is executed using the…#

Credentials for an IAM Role that the State Machine assumes for executing the task.

This enables cross-account resource invocations.

default

Default: None (Task is executed using the State Machine's execution role)

heartbeatDurationheartbeatDurationheartbeatDurationHeartbeatDurationHeartbeatDuration= Nonedeprecated#

use `heartbeatTimeout`

heartbeatTimeoutTimeoutheartbeat_timeoutTimeoutheartbeatTimeoutTimeoutHeartbeatTimeoutTimeoutHeartbeatTimeoutTimeout= None#

Timeout for the heartbeat.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

inputTaskInputinputTaskInputinputTaskInputInputTaskInputInputTaskInput= The state input (JSON path '$')#

The JSON input for the execution, same as that of StartExecution.

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

integrationPatternIntegrationPatternintegration_patternIntegrationPatternintegrationPatternIntegrationPatternIntegrationPatternIntegrationPatternIntegrationPatternIntegrationPattern= `IntegrationPattern.REQUEST_RESP…#

AWS Step Functions integrates with services directly in the Amazon States Language.

You can control these AWS services using service integration patterns.

Depending on the AWS Service, the Service Integration Pattern availability will vary.

default

Default: IntegrationPattern.REQUEST_RESPONSE for most tasks. IntegrationPattern.RUN_JOB for the following exceptions: BatchSubmitJob, EmrAddStep, EmrCreateCluster, EmrTerminationCluster, and EmrContainersStartJobRun.

namestringnamestrnameStringNamestringName*string= None#

The name of the execution, same as that of StartExecution.

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

queryLanguageQueryLanguagequery_languageQueryLanguagequeryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguageQueryLanguage= 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.

resultPathstringresult_pathstrresultPathStringResultPathstringResultPath*string= $#

JSONPath expression to indicate where to inject the state's output.

May also be the special value JsonPath.DISCARD, which will cause the state's input to become its output.

resultSelector{ [key: string]: any }result_selectortyping.Mapping[str, Any]resultSelectorMap<String, Object>ResultSelectorIDictionary<string, object>ResultSelector*map[string]interface{}= None#

The JSON that will replace the state's raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state's raw result.

stateMachineIStateMachineRefstate_machineIStateMachineRefstateMachineIStateMachineRefStateMachineIStateMachineRefStateMachineIStateMachineRefrequired#

The Step Functions state machine to start the execution on.

stateNamestringstate_namestrstateNameStringStateNamestringStateName*string= The construct ID will be used as…#

Optional name for this state.

default

Default: The construct ID will be used as state name

taskTimeoutTimeouttask_timeoutTimeouttaskTimeoutTimeoutTaskTimeoutTimeoutTaskTimeoutTimeout= None#

Timeout for the task.

[disable-awslint:duration-prop-type] is needed because all props interface in aws-stepfunctions-tasks extend this interface

timeoutDurationtimeoutDurationtimeoutDurationTimeoutDurationTimeoutDuration= Nonedeprecated#

use `taskTimeout`