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

(stepfunctions): invalid parameter value in CfnStateMachineAlias example #26601

Closed
lpizzinidev opened this issue Aug 2, 2023 · 2 comments
Closed
Labels
@aws-cdk/aws-stepfunctions Related to AWS StepFunctions documentation This is a problem with documentation.

Comments

@lpizzinidev
Copy link
Contributor

Describe the issue

The CfnStateMachineAlias documentation example contains an invalid routingConfiguration.weight value of 123.
The weight attributes specified in routingConfiguration should add up to 100.

Also, it is not specified in the docs, but maybe also deploymentPreference.percentage should be <= 100?

Screenshot 2023-08-02 at 08 57 48

Links

@lpizzinidev lpizzinidev added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Aug 2, 2023
@github-actions github-actions bot added the @aws-cdk/aws-stepfunctions Related to AWS StepFunctions label Aug 2, 2023
@lpizzinidev lpizzinidev changed the title (stepfunctions): misleading example for CfnStateMachineAlias construct (stepfunctions): invalid parameter value in CfnStateMachineAlias example Aug 2, 2023
@peterwoodworth
Copy link
Contributor

Given the docs note above the snippet, I think this is fine.

The values are placeholders you should change

We cannot possibly know the restrictions of every single property of every single CloudFormation resource. We just know the properties and types CloudFormation expects. This will have to stay, even if it would be nice if we could make the values more realistic

@peterwoodworth peterwoodworth removed the needs-triage This issue or PR still needs to be triaged. label Aug 3, 2023
@github-actions
Copy link

github-actions bot commented Aug 3, 2023

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
@aws-cdk/aws-stepfunctions Related to AWS StepFunctions documentation This is a problem with documentation.
Projects
None yet
Development

No branches or pull requests

2 participants