Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support Local Step Functions Workflow Studio Integration for CDK Users #6349

Open
garysassano opened this issue Jan 13, 2025 · 0 comments
Open
Labels
feature-request New feature or enhancement. May require GitHub community feedback.

Comments

@garysassano
Copy link

Current Situation

Currently, the AWS Toolkit for VS Code provides Step Functions Workflow Studio through the App Composer integration, which generates SAM-compatible state machine definitions. While this is great for SAM users, CDK users cannot directly benefit from this visual workflow editor.

Problem

When working with Step Functions in CDK:

  1. You have to write ASL JSON definitions manually or maintain them in separate files
  2. There's no visual editor integration for CDK-based state machines
  3. The current Workflow Studio integration only works for SAM applications, generating complete SAM applications rather than just the workflow definition

Proposed Solution

Add support for CDK workflows in the VS Code Workflow Studio by:

  1. Allowing users to edit just the workflow definition part without generating a complete SAM application
  2. Providing an option to export the ASL definition in a format that can be directly used with CDK's StateMachine construct
  3. Supporting round-trip editing where CDK users can:
    • Open existing ASL definitions in Workflow Studio
    • Make visual changes
    • Save back to their CDK project

Additional Context

The community has recognized this need, leading to third-party solutions like @mbonig/state-machine. However, having this capability built into the AWS Toolkit would provide a more integrated and maintainable solution.

@garysassano garysassano added the feature-request New feature or enhancement. May require GitHub community feedback. label Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request New feature or enhancement. May require GitHub community feedback.
Projects
None yet
Development

No branches or pull requests

1 participant