ChoiceProps

class aws_cdk.aws_stepfunctions.ChoiceProps(*, comment=None, input_path=None, output_path=None)

Bases: object

Properties for defining a Choice state.

Parameters
  • comment (Optional[str]) – An optional description for 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 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 DISCARD, which will cause the effective output to be the empty object {}. Default: $

Example:

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

choice_props = stepfunctions.ChoiceProps(
    comment="comment",
    input_path="inputPath",
    output_path="outputPath"
)

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 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 DISCARD, which will cause the effective output to be the empty object {}.

Default

$

Return type

Optional[str]