aws / aws/aws-cdk

aws-stepfunctions-tasks: support revision id in StepFunctionsStartExecution

Open
#26,532 2 comments 12 reactions 0 assignees View on GitHub
@aws-cdk/aws-stepfunctions-tasks effort/medium feature-request p2
Dominant language
TypeScript
Stars
12.9k
Forks
4.6k
Avg merge
2d 3h
Merged PRs (30d)
83

Description

### Describe the feature

Step Functions now supports Versions and Aliases.

- Learn more: https://aws.amazon.com/about-aws/whats-new/2023/06/aws-step-functions-versions-aliases/
- Developer Guide: https://docs.aws.amazon.com/step-functions/latest/dg/concepts-cd-aliasing-versioning.html
- AWS Compute Blog post: https://aws.amazon.com/blogs/compute/deploying-state-machines-incrementally-with-versions-and-aliases-in-aws-step-functions/

I would like to have the `tasks.StepFunctionsStartExecution` link to a specific state machine revision ID.

### Use Case

The use case is where there is a parent and child nested step function. If a deploy occurs that updates the nested step function, this may break long running executions of the parent. By linking the parent step function to a revision of the child step function, we can prevent many such breakages.

### Proposed Solution

Currently tasks.StepFunctionsStartExecution accepts a `StateMachine`. I would instead like to pass the `stateMachineRevisionId` which was added here: https://github.com/aws/aws-cdk/pull/26443

### Other Information

_No response_

### Acknowledgements

- [ ] I may be able to implement this feature request
- [ ] This feature might incur a breaking change

### CDK version used

Latest

### Environment details (OS name and version, etc.)

Amazon Linux 2

Contributor guide

Open the contributing guide

Research direction

Start at the tasks.StepFunctionsStartExecution entry point and review the stateMachineRevisionId addition in PR 26443. Trace how the task currently accepts a StateMachine and identify the relevant tests or fixtures nearby. Done means the task can target a specific Step Functions state machine revision without breaking its existing usage.

Written by the indexing model from the issue text.

Assessment

Tech stack
aws, typescript
Domain
cloud
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.