SucceedProps

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

Bases: object

Properties for defining a Succeed 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 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: $

  • 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

succeed_props = stepfunctions.SucceedProps(
    comment="comment",
    input_path="inputPath",
    output_path="outputPath",
    state_name="stateName"
)

Attributes

comment

An optional description for 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:

$

state_name

Optional name for this state.

Default:

  • The construct ID will be used as state name