feat(kms): allow fromLookup method to return dummy key if target key was not found

[go-to-k]

Issue # (if applicable)

Closes #31574.

Reason for this change

The fromLookup method causes an error if the target key was not found. However it would be also good not to cause an error in that case.

Description of changes

Added returnDummyKeyOnMissing in KeyLookupOptions. If the property is set to true, the context method will not cause an error and will return a dummy key if the key was not found.

Originally, I thought to make the method to return undefined in that case, but the return type of method is IKey. If we change the type to IKey | undefined, it should be a breaking change.

  public static fromLookup(scope: Construct, id: string, options: KeyLookupOptions): IKey {

So I decided to return a dummy key with a dummy key id '1234abcd-12ab-34cd-56ef-1234567890ab'. The dummy key id had been defined originally (see: https://github.com/aws/aws-cdk/blob/v2.161.0/packages/aws-cdk-lib/aws-kms/lib/key.ts#L686).

The property returnDummyKeyOnMissing will be passed to ignoreErrorOnMissingContext added in the PR. If the ignoreErrorOnMissingContext is true and the key doesn't exist, an error will be suppressed in the ContextProvider.

Additional information

see: #31574 (comment)

Description of how you validated changes

Both of unit and integ tests

Checklist

• My code adheres to the CONTRIBUTING GUIDE and DESIGN GUIDELINES

---

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

[aws-cdk-automation]

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.

[aws-cdk-automation]

AWS CodeBuild CI Report

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

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

[go-to-k]

Exemption Request: The code changes in Context Providers only affect the KMS context (lookup) method, they could be covered by unit tests for context-providers and integ tests for KMS module.

[aws-cdk-automation]

The pull request linter fails with the following errors:

❌ CLI code has changed. A maintainer must run the code through the testing pipeline (git fetch origin pull/31676/head && git push -f origin FETCH_HEAD:test-main-pipeline), then add the 'pr-linter/cli-integ-tested' label when the pipeline succeeds.

PRs must pass status checks before we can provide a meaningful review.

If you would like to request an exemption from the status checks or clarification on feedback, please leave a comment on this PR containing Exemption Request and/or Clarification Request.

✅ A exemption request has been requested. Please wait for a maintainer's review.