StateProps

class aws_cdk.aws_stepfunctions.StateProps(*, comment=None, input_path=None, output_path=None, parameters=None, result_path=None, result_selector=None, state_name=None)

Bases: object

Properties shared by all states.

Parameters:

comment (Optional[str]) – A comment describing this state. Default: No comment
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: $
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_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: $
result_selector (Optional[Mapping[str, Any]]) – The JSON that will replace the state’s raw result and become the effective result before ResultPath is applied. You can use ResultSelector to create a payload with values that are static or selected from the state’s raw result. Default: - None
state_name (Optional[str]) – Optional name for this state. Default: - The construct ID will be used as state name

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_stepfunctions as stepfunctions

# parameters: Any
# result_selector: Any

state_props = stepfunctions.StateProps(
    comment="comment",
    input_path="inputPath",
    output_path="outputPath",
    parameters={
        "parameters_key": parameters
    },
    result_path="resultPath",
    result_selector={
        "result_selector_key": result_selector
    },
    state_name="stateName"
)

Attributes

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

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

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

result_selector

The JSON that will replace the state’s raw result and become the effective result before ResultPath is applied.

You can use ResultSelector to create a payload with values that are static or selected from the state’s raw result.

Default:

None

See:

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

state_name

Optional name for this state.

Default:

The construct ID will be used as state name