interface TaskProps ⚠️

Language	Type name
.NET	Amazon.CDK.AWS.StepFunctions.TaskProps
Java	software.amazon.awscdk.services.stepfunctions.TaskProps
Python	aws_cdk.aws_stepfunctions.TaskProps
TypeScript (source)	@aws-cdk/aws-stepfunctions » TaskProps

⚠️ Deprecated: - replaced by service integration specific classes (i.e. LambdaInvoke, SnsPublish)

Props that are common to all tasks.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as stepfunctions from '@aws-cdk/aws-stepfunctions';
import * as cdk from '@aws-cdk/core';

declare const parameters: any;
declare const stepFunctionsTask: stepfunctions.IStepFunctionsTask;
const taskProps: stepfunctions.TaskProps = {
  task: stepFunctionsTask,

  // the properties below are optional
  comment: 'comment',
  inputPath: 'inputPath',
  outputPath: 'outputPath',
  parameters: {
    parametersKey: parameters,
  },
  resultPath: 'resultPath',
  timeout: cdk.Duration.minutes(30),
};

Properties

Name	Type	Description
task⚠️	IStepFunctionsTask	Actual task to be invoked in this workflow.
comment?⚠️	string	An optional description for 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.
parameters?⚠️	{ [string]: any }	Parameters to invoke the task with.
resultPath?⚠️	string	JSONPath expression to indicate where to inject the state's output.
timeout?⚠️	Duration	Maximum run time of this state.

---

task⚠️

⚠️ Deprecated: - replaced by service integration specific classes (i.e. LambdaInvoke, SnsPublish)

Type: IStepFunctionsTask

Actual task to be invoked in this workflow.

---

comment?⚠️

⚠️ Deprecated: - replaced by service integration specific classes (i.e. LambdaInvoke, SnsPublish)

Type: string (optional, default: No comment)

An optional description for this state.

---

inputPath?⚠️

⚠️ Deprecated: - replaced by service integration specific classes (i.e. LambdaInvoke, SnsPublish)

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?⚠️

⚠️ Deprecated: - replaced by service integration specific classes (i.e. LambdaInvoke, SnsPublish)

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

---

parameters?⚠️

⚠️ Deprecated: - replaced by service integration specific classes (i.e. LambdaInvoke, SnsPublish)

Type: { [string]: any } (optional, default: Use the parameters implied by the task property)

Parameters to invoke the task with.

It is not recommended to use this field. The object that is passed in the task property will take care of returning the right values for the Parameters field in the Step Functions definition.

The various classes that implement IStepFunctionsTask will take a properties which make sense for the task type. For example, for InvokeFunction the field that populates the parameters field will be called payload, and for the PublishToTopic the parameters field will be populated via a combination of the referenced topic, subject and message.

If passed anyway, the keys in this map will override the parameters returned by the task object.

See also: https://docs.aws.amazon.com/step-functions/latest/dg/input-output-inputpath-params.html#input-output-parameters

---

resultPath?⚠️

⚠️ Deprecated: - replaced by service integration specific classes (i.e. LambdaInvoke, SnsPublish)

Type: string (optional, default: $)

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.

---

timeout?⚠️

⚠️ Deprecated: - replaced by service integration specific classes (i.e. LambdaInvoke, SnsPublish)

Type: Duration (optional, default: 60)

Maximum run time of this state.

If the state takes longer than this amount of time to complete, a 'Timeout' error is raised.