chore: add example of looking up availability zones #248
Conversation
This file contains 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
|
This change is part of the following stack: Change managed by git-spice. |
corymhall
force-pushed
the
corymhall/stack-provider
branch
from
145ba8e
to
4d93a76
Compare
flostadler
reviewed
Nov 25, 2024
| // Here I have specified that I want 3 availability zones. This uses Intrinsics, which | ||
| // behind the scenes are backed by Pulumi functions (e.g. aws_native.getAzs()). | ||
| // This allows us to get around the limitation of not being able to use Output values here. | ||
| get availabilityZones(): string[] { |
There was a problem hiding this comment.
I feel like we could achieve CDKs behavior by building a small resource that takes an input property, but then just returns the value from state indefinitely (unless recreated).
Overkill for now, but maybe something for the future if we see this being annoying for users.
corymhall
force-pushed
the
corymhall/stack-provider
branch
from
da1e74e
to
efd3750
Compare
corymhall
force-pushed
the
corymhall/azs-example
branch
2 times, most recently
from
5230b0d
to
6c3c7b8
Compare
If you provide an explicit environment to the stack (there are a lot of reasons to do this) then you have to enable lookups in order for the stack to lookup the availability zones. It would be nice if you could just use Pulumi functions to lookup the AZs and provide that, but the values have to be strings (can't be promises/outputs). An easy workaround for this is to use the `getAzs` intrinsic to defer the lookup and allow the intrinsic to be converted to a Pulumi function. I am adding an example of how to do this. The reason we don't want to do this by default is that the number of availability zones is not something that should every change without the user knowing about it. CDK handles that by having the lookup store the value in the `cdk.context.json` file so the lookup is never re-run.
corymhall
force-pushed
the
corymhall/azs-example
branch
from
6c3c7b8
to
a08fb92
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
If you provide an explicit environment to the stack (there are a lot of
reasons to do this) then you have to enable lookups in order for the
stack to lookup the availability zones.
It would be nice if you could just use Pulumi functions to lookup the
AZs and provide that, but the values have to be strings (can't be
promises/outputs). An easy workaround for this is to use the
getAzsintrinsic to defer the lookup and allow the intrinsic to be converted to
a Pulumi function.
I am adding an example of how to do this. The reason we don't want to do
this by default is that the number of availability zones is not
something that should every change without the user knowing about it.
CDK handles that by having the lookup store the value in the
cdk.context.jsonfile so the lookup is never re-run.