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

fix(core): stack tags should not allow tokens #30022

Closed
wants to merge 1 commit into from

Conversation

comcalvi
Copy link
Contributor

Issue # (if applicable)

Closes #29424.

Reason for this change

Stack tags get applied to every resource they contain. Tokens must be resolved by CloudFormation itself and the CDK CLI has to apply stack tags to the stack before the deployment starts. This results in the string representation of the token (eg Token[AWS.AccountId.6]) making its way into the stack tags. CFN applies these tags automatically to every resource, but this string value contains characters that many resource handlers do not allow in tags. This causes a deployment error.

Description of changes

Move this error to synthesis time by checking for tokens before adding the tags.

Description of how you validated changes

Unit tests.

Checklist


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license

@github-actions github-actions bot added bug This issue is a bug. effort/small Small work item – less than a day of effort p1 labels Apr 30, 2024
@aws-cdk-automation aws-cdk-automation requested a review from a team April 30, 2024 22:46
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Apr 30, 2024
Copy link
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.

The pull request linter has failed. See the aws-cdk-automation comment below for failure reasons. If you believe this pull request should receive an exemption, please comment and provide a justification.

A comment requesting an exemption should contain the text Exemption Request. Additionally, if clarification is needed add Clarification Request to a comment.

@comcalvi comcalvi added the pr-linter/exempt-integ-test The PR linter will not require integ test changes label Apr 30, 2024
@aws-cdk-automation aws-cdk-automation dismissed their stale review April 30, 2024 22:53

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

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: e15f461
  • Result: FAILED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@comcalvi comcalvi marked this pull request as draft May 2, 2024 19:00
@comcalvi
Copy link
Contributor Author

comcalvi commented Aug 8, 2024

Closing this because it is possible to add a Stack tag containing a Token that gets resolved to the right value for all the resources in the stack, and this change would break that. One user has reported that adding an unresolved token to a Stack tag successfully tagged the resources with the resolved value, so throwing an error will break them.

We've also seen that this can cause deployment errors, but there's no way to reliably distinguish between which cases a stack tag will cause an error and which ones it won't cause an error; it's resource-dependent, and we shouldn't own logic that says "if IAM gets this stack tag, fail early, because IAM doesn't like unresolved tokens". This logic won't scale to all of AWS and the payoff for this minimal; the error is being thrown either way.

@comcalvi comcalvi closed this Aug 8, 2024
Copy link

github-actions bot commented Aug 8, 2024

Comments on closed issues and PRs are hard for our team to see.
If you need help, please open a new issue that references this one.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 8, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
bug This issue is a bug. contribution/core This is a PR that came from AWS. effort/small Small work item – less than a day of effort p1 pr-linter/exempt-integ-test The PR linter will not require integ test changes
Projects
None yet
2 participants