PassProps¶
-
class
aws_cdk.aws_stepfunctions.
PassProps
(*, comment=None, input_path=None, output_path=None, parameters=None, result=None, result_path=None)¶ Bases:
object
Properties for defining a Pass state.
- Parameters
comment (
Optional
[str
]) – An optional description for this state. Default: No commentinput_path (
Optional
[str
]) – 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: $output_path (
Optional
[str
]) – 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 (
Optional
[Mapping
[str
,Any
]]) – Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input. Default: No parametersresult (
Optional
[Result
]) – If given, treat as the result of this operation. Can be used to inject or replace the current execution state. Default: No injected resultresult_path (
Optional
[str
]) – 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: $
Attributes
-
comment
¶ An optional description for this state.
- Default
No comment
- Return type
Optional
[str
]
-
input_path
¶ 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
$
- Return type
Optional
[str
]
-
output_path
¶ 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
$
- Return type
Optional
[str
]
-
parameters
¶ Parameters pass a collection of key-value pairs, either static values or JSONPath expressions that select from the input.
- Default
No parameters
- See
- Return type
Optional
[Mapping
[str
,Any
]]
-
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
- Return type
Optional
[Result
]
-
result_path
¶ 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
$
- Return type
Optional
[str
]