feat(lib): add the remove
function to TerraformResource
#3849
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.
Adds support within the
TerraformResource
for the removed blockRelated issue
Fixes #3638
Description
Key Changes
_removed
private field onTerraformResource
to track removed state.toTerraform
,toHclTerraform
, andtoMetadata
to support the removed block when applicable.remove(...)
method to define removed resources, including optional lifecycle and provisioner support.RemovedBlockLocalExecProvisioner
interface, as JSII does not support theOmit
type againstLocalExecProvisioner
, to make the API clearer and reduce developer confusion.remove()
in combination withimportFrom
or anymoveXX()
methods, since these operations are mutually exclusive in Terraform’s configuration model.remove
functionality (1.7) and the
provisionerblock (
1.9`)renderRemoved
Rationale
_removed
field aligns with the patterns used for import and move, making the codebase more consistent and easier to reason about.removed
blocks improves the developer experience by avoiding misuse of thewhen
property and surfacing clearer validation (as opposed to a value check and throw).toTerraform()
would silently ignore conflicting operations.Checklist