PassProps

class aws_cdk.aws_stepfunctions.PassProps(*, comment=None, query_language=None, state_name=None, assign=None, input_path=None, output_path=None, outputs=None, parameters=None, result=None, result_path=None)

Bases: StateBaseProps, AssignableStateOptions, JsonPathCommonOptions, JsonataCommonOptions

Properties for defining a Pass state.

Parameters:

comment (Optional[str]) – A comment describing this state. Default: No comment
query_language (Optional[QueryLanguage]) – The name of the query language used by the state. If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field. Default: - JSONPath
state_name (Optional[str]) – Optional name for this state. Default: - The construct ID will be used as state name
assign (Optional[Mapping[str, Any]]) – Workflow variables to store in this step. Using workflow variables, you can store data in a step and retrieve that data in future steps. Default: - Not assign variables
input_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: $
outputs (Any) – Used to specify and transform output from the state. When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly. Default: - $states.result or $states.errorOutput
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 parameters
result (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 result
result_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: $

ExampleMetadata:

infused

Example:

# JSONata Pattern
sfn.Pass.jsonata(self, "JSONata Pattern",
    outputs={"foo": "bar"}
)

# JSONPath Pattern
sfn.Pass.json_path(self, "JSONPath Pattern",
    # The outputs does not exist in the props type
    # outputs: { foo: 'bar' },
    output_path="$.status"
)

# Constructor (Legacy) Pattern
sfn.Pass(self, "Constructor Pattern",
    query_language=sfn.QueryLanguage.JSONATA,  # or JSON_PATH
    # Both outputs and outputPath exist as prop types.
    outputs={"foo": "bar"},  # For JSONata
    # or
    output_path="$.status"
)

Attributes

assign

Workflow variables to store in this step.

Using workflow variables, you can store data in a step and retrieve that data in future steps.

Default:

Not assign variables

See:

https://docs.aws.amazon.com/step-functions/latest/dg/workflow-variables.html

comment

A comment describing this state.

Default:: No comment

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:: $

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:: $

outputs

Used to specify and transform output from the state.

When specified, the value overrides the state output default. The output field accepts any JSON value (object, array, string, number, boolean, null). Any string value, including those inside objects or arrays, will be evaluated as JSONata if surrounded by {% %} characters. Output also accepts a JSONata expression directly.

Default:

$states.result or $states.errorOutput

See:

https://docs.aws.amazon.com/step-functions/latest/dg/concepts-input-output-filtering.html

parameters

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

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

query_language

The name of the query language used by the state.

If the state does not contain a queryLanguage field, then it will use the query language specified in the top-level queryLanguage field.

Default:

JSONPath

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

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:: $

state_name

Optional name for this state.

Default:

The construct ID will be used as state name