Add recommendation for scalar output to v3 migration guide #1448
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
flostadler
added
the
needs-release/major
Does the PR have any schema changes?Looking good! No breaking changes found. |
t0yv0
reviewed
Oct 17, 2024
docs/eks-v3-migration.md
Outdated
| All properties of components in the Node.js SDK are now wrapped in `Output`. This aligns it with other language SDKs but introduces some breaking changes for optional resource properties. | ||
| Accessing those optional resource outputs now requires using `apply`. | ||
|
|
||
| To work around this we've exposed the most commonly used resource properties at the top level of the components. This change allows for easier access without requiring to use `apply`. |
t0yv0
reviewed
Oct 17, 2024
docs/eks-v3-migration.md
Outdated
| @@ -167,6 +202,11 @@ The `NodeGroup` and `NodeGroupV2` components now accept inputs for the following | |||
|
|
|||
| If you are using Go you will need to adjust your program to handle those types being inputs. | |||
|
|
|||
| #### Security group and ingress rule inputs | |||
| We've updated the `NodeGroup` and `NodeGroupV2` components to allow passing in `nodeSecurityGroup` and `clusterIngressRule` by their IDs. You can now use `nodeSecurityGroupId` and `clusterIngressRuleId` as input properties. | |||
t0yv0
reviewed
Oct 17, 2024
docs/eks-v3-migration.md
Outdated
| All properties of components in the Node.js SDK are now wrapped in `Output`. This aligns it with other language SDKs but introduces some breaking changes for optional resource properties. | ||
| Accessing those optional resource outputs now requires using `apply`. | ||
|
|
||
| To work around this we've exposed the most commonly used resource properties at the top level of the components. This change allows for easier access without requiring to use `apply`. |
There was a problem hiding this comment.
There's great information in this paragraph but it is a little verbose, try to do a pass and remove words that can be removed, otherwise it is reasonable.
Perhaps instead of "To work around this", "We added convenient access properties for frequently used outputs:".
t0yv0
approved these changes
Oct 17, 2024
flostadler
added a commit
that referenced
this pull request
Oct 17, 2024
flostadler
added a commit
that referenced
this pull request
Oct 17, 2024
flostadler
added a commit
that referenced
this pull request
Oct 17, 2024
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.
#1445 and #1446 introduced new scalar properties as a workaround to the breaking Node.js SDK changes.
This documents those in the migration guide.