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): logicalId is consumed prior to being overridden #20560

Merged
merged 2 commits into from
Jun 1, 2022
Merged

fix(core): logicalId is consumed prior to being overridden #20560

merged 2 commits into from
Jun 1, 2022

Conversation

corymhall
Copy link
Contributor

@corymhall corymhall commented May 31, 2022

When using Stack.exportValue to manually create a CloudFormation
export, the logicalId of the referenced resource is used to generate the
logicalId of the CfnExport. Because exportValue creates a
CfnExport and returns an importValue it needs to resolve the
logicalId at call time. If the user later overrides the logicalId of the
referenced resource, that override is reflected in the export/import
that was created earlier.

There doesn't seem to be a way to solve this without incurring a
breaking change so this PR attempts to smooth a rough edge by "locking"
the logicalId when exportValue is called. If the user attempts to
override the id after that point, an error message will be thrown

closes #14335


All Submissions:

Adding new Unconventional Dependencies:

  • This PR adds new unconventional dependencies following the process described here

New Features

  • Have you added the new feature to an integration test?
    • Did you use yarn integ to deploy the infrastructure and generate the snapshot (i.e. yarn integ without --dry-run)?

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

When using `Stack.exportValue` to manually create a CloudFormation
export, the logicalId of the referenced resource is used to generate the
logicalId of the `CfnExport`. Because `exportValue` creates a
`CfnExport` _and_ returns an `importValue` it needs to _resolve_ the
logicalId at call time. If the user later overrides the logicalId of the
referenced resource, that override is reflected in the export/import
that was created earlier.

There doesn't seem to be a way to solve this without incurring a
breaking change so this PR attempts to smooth a rough edge by "locking"
the `logicalId` when `exportValue` is called. If the user attempts to
override the id _after_ that point, an error message will be thrown

closes #14335
@corymhall corymhall requested a review from rix0rrr May 31, 2022 19:30
@gitpod-io
Copy link

gitpod-io bot commented May 31, 2022

@github-actions github-actions bot added bug This issue is a bug. effort/medium Medium work item – several days of effort p1 labels May 31, 2022
@aws-cdk-automation aws-cdk-automation requested a review from a team May 31, 2022 19:30
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label May 31, 2022
@mergify
Copy link
Contributor

mergify bot commented Jun 1, 2022

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildProject89A8053A-LhjRyN9kxr8o
  • Commit ID: 553ba66
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

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

@mergify mergify bot merged commit e44c2c4 into aws:master Jun 1, 2022
@mergify
Copy link
Contributor

mergify bot commented Jun 1, 2022

Thank you for contributing! Your pull request will be updated from master and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue is a bug. contribution/core This is a PR that came from AWS. effort/medium Medium work item – several days of effort p1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

(core): exportValue doesn't respect overridelogicalId
3 participants