feat(core): lazy mappings will only synthesize if keys are unresolved#15617
Merged
mergify[bot] merged 11 commits intomasterfrom Jul 22, 2021
Merged
feat(core): lazy mappings will only synthesize if keys are unresolved#15617mergify[bot] merged 11 commits intomasterfrom
mergify[bot] merged 11 commits intomasterfrom
Conversation
This feature adds new static methods to the CfnMapping construct that
allow the creation of "lazy" mappings. A lazy mapping will only create
a Mappings section in the synthesized CFN template if some "find"
operation on the mapping was not able to return a value since one or
more of the lookup keys were unresolved.
Usage:
```ts
// Register the mapping as a lazy mapping.
CfnMapping.registerLazyMap('UNIQUEMAPPINGID', {
TopLevelKey: {
SecondLevelKey: 'value',
},
});
// Later, find a value from the mapping. Since the keys are both
// resolved, this returns a resolved value and does not create a
// CfnMapping.
CfnMapping.findInLazyMap(scope, 'UNIQUEMAPPINGID', 'TopLevelKey', 'SecondLevelKey');
// > 'value'
// If we try to find a value from the mapping using unresolved keys, a
// CfnMapping is created and a Fn::FindInMap is returned.
CfnMapping.findInLazyMap(scope, 'UNIQUEMAPPINGID', 'TopLevelKey', Aws.REGION);
// > { Fn::FindInMap: [ 'UNIQUEMAPPINGID', 'TopLevelKey', { Ref: 'AWS::Region' } ] }
```
|
|
eladb
suggested changes
Jul 18, 2021
Contributor
eladb
left a comment
There was a problem hiding this comment.
Would it make sense to make this the default behavior of a normal map? (with an option to disable). What's the use of a map that is unused?
Contributor
Author
In my mind, most of the users who use |
otaviomacedo
approved these changes
Jul 19, 2021
eladb
approved these changes
Jul 22, 2021
|
|
||
| private informLazyUse() { | ||
| if (!this.lazyInformed) { | ||
| Annotations.of(this).addInfo('Consider making this CfnMapping a lazy mapping by providing `lazy: true`: either no findInMap was called or every findInMap could be immediately resolved without using Fn::FindInMap'); |
Contributor
There was a problem hiding this comment.
Suggested change
| Annotations.of(this).addInfo('Consider making this CfnMapping a lazy mapping by providing `lazy: true`: either no findInMap was called or every findInMap could be immediately resolved without using Fn::FindInMap'); | |
| Annotations.of(this).addWarning('Consider making this CfnMapping a lazy mapping by providing `lazy: true`: either no findInMap was called or every findInMap could be immediately resolved without using Fn::FindInMap'); |
Contributor
Author
There was a problem hiding this comment.
warning feels a bit intense here since they're not necessarily doing anything wrong and I don't think strict synthesis should fail in this case
Collaborator
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
Contributor
|
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). |
TikiTDO
pushed a commit
to TikiTDO/aws-cdk
that referenced
this pull request
Aug 3, 2021
…aws#15617) This feature adds new static methods to the CfnMapping construct that allow the creation of "lazy" mappings. A lazy mapping will only create a Mappings section in the synthesized CFN template if some "find" operation on the mapping was not able to return a value since one or more of the lookup keys were unresolved. Usage: ```ts // Register the mapping as a lazy mapping. CfnMapping.registerLazyMap('UNIQUEMAPPINGID', { TopLevelKey: { SecondLevelKey: 'value', }, }); // Later, find a value from the mapping. Since the keys are both // resolved, this returns a resolved value and does not create a // CfnMapping. CfnMapping.findInLazyMap(scope, 'UNIQUEMAPPINGID', 'TopLevelKey', 'SecondLevelKey'); // > 'value' // If we try to find a value from the mapping using unresolved keys, a // CfnMapping is created and a Fn::FindInMap is returned. CfnMapping.findInLazyMap(scope, 'UNIQUEMAPPINGID', 'TopLevelKey', Aws.REGION); // > { Fn::FindInMap: [ 'UNIQUEMAPPINGID', 'TopLevelKey', { Ref: 'AWS::Region' } ] } ``` ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
hollanddd
pushed a commit
to hollanddd/aws-cdk
that referenced
this pull request
Aug 26, 2021
…aws#15617) This feature adds new static methods to the CfnMapping construct that allow the creation of "lazy" mappings. A lazy mapping will only create a Mappings section in the synthesized CFN template if some "find" operation on the mapping was not able to return a value since one or more of the lookup keys were unresolved. Usage: ```ts // Register the mapping as a lazy mapping. CfnMapping.registerLazyMap('UNIQUEMAPPINGID', { TopLevelKey: { SecondLevelKey: 'value', }, }); // Later, find a value from the mapping. Since the keys are both // resolved, this returns a resolved value and does not create a // CfnMapping. CfnMapping.findInLazyMap(scope, 'UNIQUEMAPPINGID', 'TopLevelKey', 'SecondLevelKey'); // > 'value' // If we try to find a value from the mapping using unresolved keys, a // CfnMapping is created and a Fn::FindInMap is returned. CfnMapping.findInLazyMap(scope, 'UNIQUEMAPPINGID', 'TopLevelKey', Aws.REGION); // > { Fn::FindInMap: [ 'UNIQUEMAPPINGID', 'TopLevelKey', { Ref: 'AWS::Region' } ] } ``` ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This feature adds new static methods to the CfnMapping construct that
allow the creation of "lazy" mappings. A lazy mapping will only create
a Mappings section in the synthesized CFN template if some "find"
operation on the mapping was not able to return a value since one or
more of the lookup keys were unresolved.
Usage:
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license