Interface PassProps
- All Superinterfaces:
AssignableStateOptions,software.amazon.jsii.JsiiSerializable,JsonataCommonOptions,JsonPathCommonOptions,StateBaseProps
- All Known Implementing Classes:
PassProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
date="2025-10-24T13:34:47.872Z")
@Stability(Stable)
public interface PassProps
extends software.amazon.jsii.JsiiSerializable, StateBaseProps, AssignableStateOptions, JsonPathCommonOptions, JsonataCommonOptions
Properties for defining a Pass state.
Example:
// JSONata Pattern
Pass.jsonata(this, "JSONata Pattern", PassJsonataProps.builder()
.outputs(Map.of("foo", "bar"))
.build());
// JSONPath Pattern
Pass.jsonPath(this, "JSONPath Pattern", PassJsonPathProps.builder()
// The outputs does not exist in the props type
// outputs: { foo: 'bar' },
.outputPath("$.status")
.build());
// Constructor (Legacy) Pattern
// Constructor (Legacy) Pattern
Pass.Builder.create(this, "Constructor Pattern")
.queryLanguage(QueryLanguage.JSONATA) // or JSON_PATH
// Both outputs and outputPath exist as prop types.
.outputs(Map.of("foo", "bar")) // For JSONata
// or
.outputPath("$.status")
.build();
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic PassProps.Builderbuilder()Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.default ResultIf given, treat as the result of this operation.default StringJSONPath expression to indicate where to inject the state's output.Methods inherited from interface software.amazon.awscdk.services.stepfunctions.AssignableStateOptions
getAssignMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJsonMethods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonataCommonOptions
getOutputsMethods inherited from interface software.amazon.awscdk.services.stepfunctions.JsonPathCommonOptions
getInputPath, getOutputPathMethods inherited from interface software.amazon.awscdk.services.stepfunctions.StateBaseProps
getComment, getQueryLanguage, getStateName
-
Method Details
-
getParameters
Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.Default: No parameters
- See Also:
-
getResult
If given, treat as the result of this operation.Can be used to inject or replace the current execution state.
Default: No injected result
-
getResultPath
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.
Default: $
-
builder
- Returns:
- a
PassProps.BuilderofPassProps
-