Skip to content

docs(stepfunctions): clarify that timeout only applies to Chain-based definitions#37318

Open
syukawa-gh wants to merge 1 commit intoaws:mainfrom
syukawa-gh:fix/sfn-timeout-docs-clean
Open

docs(stepfunctions): clarify that timeout only applies to Chain-based definitions#37318
syukawa-gh wants to merge 1 commit intoaws:mainfrom
syukawa-gh:fix/sfn-timeout-docs-clean

Conversation

@syukawa-gh
Copy link
Copy Markdown
Contributor

The timeout property documentation now explicitly states that it only applies when the definition is provided using a Chain (via definition or definitionBody with ChainDefinitionBody). When using .asl.json or string-based definitions, the timeout must be specified within the ASL definition itself.

Closes #37150

…definitions

The timeout property documentation now explicitly states that it only
applies when the definition is provided using a Chain. When using
.asl.json or string-based definitions, the timeout must be specified
within the ASL definition itself.

Closes aws#37150
@github-actions github-actions bot added bug This issue is a bug. p2 beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK labels Mar 23, 2026
@aws-cdk-automation aws-cdk-automation requested a review from a team March 23, 2026 03:45
Copy link
Copy Markdown
Collaborator

@aws-cdk-automation aws-cdk-automation left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(This review is outdated)

@syukawa-gh
Copy link
Copy Markdown
Contributor Author

Exemption Request: This PR only clarifies JSDoc documentation for the timeout property. No runtime behavior changes, so tests and integration tests are not applicable.

@aws-cdk-automation aws-cdk-automation added the pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback. label Mar 23, 2026
@syukawa-gh syukawa-gh changed the title fix(stepfunctions): clarify that timeout only applies to Chain-based definitions docs(stepfunctions): clarify that timeout only applies to Chain-based definitions Mar 24, 2026
@aws-cdk-automation aws-cdk-automation dismissed their stale review March 24, 2026 02:13

✅ Updated pull request passes all PRLinter validations. Dismissing previous PRLinter review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

beginning-contributor [Pilot] contributed between 0-2 PRs to the CDK bug This issue is a bug. p2 pr-linter/exemption-requested The contributor has requested an exemption to the PR Linter feedback.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

cdk.aws_stepfunctions.StateMachine: timeout does not apply to .asl.json definition

3 participants