Skip to content

aws-stepfunctions: comment field appears not supported #27005

@berenddeboer

Description

@berenddeboer

Describe the feature

When editing a state machine via the AWS Console, I could provide a comment for a choice rule. It suggest my state language will look like this:

    "Verification needed?": {
      "Type": "Choice",
      "Choices": [
        {
          "Variable": "$.verification_needed",
          "IsBoolean": true,
          "Next": "Set status to pending verification",
          "Comment": "yes"
        }
      ],
      "Default": "Wait for approval"
    },

This "yes" comment gets nicely displayed in the graph. However, I could not see a way to generate this comment field withi CDK. Is that correct?

Are there any plans to introduce that? Really great for more complex flows.

Unfortunately this comment is only visible in the editor, not in the "Definition" tab.

Use Case

Improve output of state machine graph.

Proposed Solution

Add a property or optional input to sfn.Condition.isBoolean().

Other Information

No response

Acknowledgements

  • I may be able to implement this feature request
  • This feature might incur a breaking change

CDK version used

2.91.0

Environment details (OS name and version, etc.)

Mac x86_64, Darwin kernel 22.6.0

Metadata

Metadata

Assignees

No one assigned

    Labels

    @aws-cdk/aws-stepfunctionsRelated to AWS StepFunctionseffort/smallSmall work item – less than a day of effortfeature-requestA feature should be added or improved.p2

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions