SingleStateOptions

class aws_cdk.aws_stepfunctions.SingleStateOptions(*, comment=None, input_path=None, output_path=None, result_path=None, prefix_states=None, state_id=None)

Bases: aws_cdk.aws_stepfunctions.ParallelProps

__init__(*, comment=None, input_path=None, output_path=None, result_path=None, prefix_states=None, state_id=None)

Options for creating a single 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: $

  • result_path (Optional[str]) – JSONPath expression to indicate where to inject the state’s output. May also be the special value DISCARD, which will cause the state’s input to become its output. Default: $

  • prefix_states (Optional[str]) – String to prefix all stateIds in the state machine with. Default: stateId

  • state_id (Optional[str]) – ID of newly created containing state. Default: Construct ID of the StateMachineFragment

stability :stability: experimental

Attributes

comment

An optional description for this state.

default :default: No comment

stability :stability: experimental

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

stability :stability: experimental

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

stability :stability: experimental

Return type

Optional[str]

prefix_states

String to prefix all stateIds in the state machine with.

default :default: stateId

stability :stability: experimental

Return type

Optional[str]

result_path

JSONPath expression to indicate where to inject the state’s output.

May also be the special value DISCARD, which will cause the state’s input to become its output.

default :default: $

stability :stability: experimental

Return type

Optional[str]

state_id

ID of newly created containing state.

default :default: Construct ID of the StateMachineFragment

stability :stability: experimental

Return type

Optional[str]