Class Pass.Builder
java.lang.Object
software.amazon.awscdk.services.stepfunctions.Pass.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<Pass>
- Enclosing class:
- Pass
@Stability(Stable)
public static final class Pass.Builder
extends Object
implements software.amazon.jsii.Builder<Pass>
A fluent builder for
Pass
.-
Method Summary
Modifier and TypeMethodDescriptionbuild()
An optional description for this state.static Pass.Builder
JSONPath expression to select part of the state to be the input to this state.outputPath
(String outputPath) JSONPath expression to select part of the state to be the output to this state.parameters
(Map<String, ? extends Object> parameters) Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.If given, treat as the result of this operation.resultPath
(String resultPath) JSONPath expression to indicate where to inject the state's output.Optional name for this state.
-
Method Details
-
create
@Stability(Stable) public static Pass.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- This parameter is required.id
- Descriptive identifier for this chainable. This parameter is required.- Returns:
- a new instance of
Pass.Builder
.
-
comment
An optional description for this state.Default: No comment
- Parameters:
comment
- An optional description for this state. This parameter is required.- Returns:
this
-
inputPath
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 {}.
Default: $
- Parameters:
inputPath
- JSONPath expression to select part of the state to be the input to this state. This parameter is required.- Returns:
this
-
outputPath
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 {}.
Default: $
- Parameters:
outputPath
- JSONPath expression to select part of the state to be the output to this state. This parameter is required.- Returns:
this
-
parameters
Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.Default: No parameters
- Parameters:
parameters
- Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input. This parameter is required.- Returns:
this
- See Also:
-
result
If given, treat as the result of this operation.Can be used to inject or replace the current execution state.
Default: No injected result
- Parameters:
result
- If given, treat as the result of this operation. This parameter is required.- Returns:
this
-
resultPath
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: $
- Parameters:
resultPath
- JSONPath expression to indicate where to inject the state's output. This parameter is required.- Returns:
this
-
stateName
Optional name for this state.Default: - The construct ID will be used as state name
- Parameters:
stateName
- Optional name for this state. This parameter is required.- Returns:
this
-
build
-