aws-cdk-lib.aws_stepfunctions.PassProps

interface PassProps

LanguageType name
.NETAmazon.CDK.AWS.StepFunctions.PassProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsstepfunctions#PassProps
Javasoftware.amazon.awscdk.services.stepfunctions.PassProps
Pythonaws_cdk.aws_stepfunctions.PassProps
TypeScript (source)aws-cdk-lib » aws_stepfunctions » PassProps

Properties for defining a Pass state.

Example

// Makes the current JSON state { ..., "subObject": { "hello": "world" } }
const pass = new sfn.Pass(this, 'Add Hello World', {
  result: sfn.Result.fromObject({ hello: 'world' }),
  resultPath: '$.subObject',
});

// Set the next state
const nextState = new sfn.Pass(this, 'NextState');
pass.next(nextState);

Properties

NameTypeDescription
comment?stringAn optional description for this state.
inputPath?stringJSONPath expression to select part of the state to be the input to this state.
outputPath?stringJSONPath expression to select part of the state to be the output to this state.
parameters?{ [string]: any }Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.
result?ResultIf given, treat as the result of this operation.
resultPath?stringJSONPath expression to indicate where to inject the state's output.

comment?

Type: string (optional, default: No comment)

An optional description for 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 {}.


parameters?

Type: { [string]: any } (optional, default: No parameters)

Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.

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


result?

Type: Result (optional, default: No injected result)

If given, treat as the result of this operation.

Can be used to inject or replace the current execution state.


resultPath?

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.