Moderne OnlyThis recipe is proprietary to Moderne and runs on the Moderne platform or CLI — it isn’t part of the open-source catalog. Available with a Moderne subscription.Contact Sales

Change a single attribute inside a Terraform resource's nested block

Recipe IDorg.openrewrite.terraform.ChangeResourceNestedBlockAttribute

Artifactorg.openrewrite.recipe:rewrite-terraform

Change the value of an attribute inside a specific instance of a nested block on a Terraform resource (e.g. set value = "0" on the parameter { name = "local_infile" } block of an aws_db_parameter_group). Use keyMatchers to identify a single instance among repeatable blocks.

Single recipeOpenRewriteModerne Proprietary License

Try in PlatformTry this recipe in the Moderne platform. Not a user yet? You’ll get a no-setup demo environment, with nothing to install or configure.

Options

7 parameters

4 required3 optional

Parameter	Example	Type	Required
attributeName	value	String	Required
The attribute inside the nested block whose value should change.
blockType	parameter	String	Required
The type of nested block to update (e.g. parameter, tag, setting).
newValue	0	String	Required
The new value to set. For quoted string attributes, provide the value without quotes.
resourceType	aws_db_parameter_group	String	Required
A Terraform resource type, without the quotes.
keyMatchers	name=local_infile	List	Optional
A list of attr=valueRegex entries identifying the specific nested block instance to update. If omitted, every block of the given blockType is updated.
resourceAttrMatchers	family=mysql.*|mariadb.*	List	Optional
A list of attr=valueRegex entries. The resource is considered a match only if every entry matches an attribute on the resource (AND semantics).
resourceNamePattern	rds_.*	String	Optional
A regular expression matched against the resource's local name (the second label). If omitted, all resources of resourceType are considered.

Examples

hcl

Parameter	Value
resourceType	aws_db_parameter_group
resourceNamePattern	null
resourceAttrMatchers	List.of("family=mysql.*|mariadb.*")
blockType	parameter
keyMatchers	List.of("name=local_infile")
attributeName	value
newValue	0

hcl

Before

resource "aws_db_parameter_group" "mysql" {
  family = "mysql8.0"
  parameter {
    apply_method = "immediate"
    name         = "local_infile"
    value        = "1"
  }
}

After

resource "aws_db_parameter_group" "mysql" {
  family = "mysql8.0"
  parameter {
    apply_method = "immediate"
    name         = "local_infile"
    value        = "0"
  }
}

Diff

@@ -6,1 +6,1 @@
    apply_method = "immediate"
    name         = "local_infile"
-   value        = "1"
+   value        = "0"
  }

Usage

Run this recipe

You will need to have configured the Moderne CLI on your machine before you can run the following command.

shell

mod run . --recipe ChangeResourceNestedBlockAttribute --recipe-option "resourceType=aws_db_parameter_group" --recipe-option "resourceNamePattern=rds_.*" --recipe-option "resourceAttrMatchers=family=mysql.*|mariadb.*" --recipe-option "blockType=parameter" --recipe-option "keyMatchers=name=local_infile" --recipe-option "attributeName=value" --recipe-option "newValue=0"

If the recipe is not available locally, then you can install it using:

mod config recipes jar install org.openrewrite.recipe:rewrite-terraform:3.14.4

Data tables

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column	Description
Source path before the run	The source path of the file before the run. null when a source file was created during the run.
Source path after the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Parent of the recipe that made changes	In a hierarchical recipe, the parent of the recipe that made a change. Empty if this is the root of a hierarchy or if the recipe is not hierarchical at all.
Recipe that made changes	The specific recipe that made a change.
Estimated time saving	An estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
Cycle	The recipe cycle in which the change was made.

Source files that had search results

org.openrewrite.table.SearchResults

Search results that were found during the recipe run.

Column	Description
Source path of search result before the run	The source path of the file with the search result markers present.
Source path of search result after run the run	A recipe may modify the source path. This is the path after the run. null when a source file was deleted during the run.
Result	The trimmed printed tree of the LST element that the marker is attached to.
Description	The content of the description of the marker.
Recipe that added the search marker	The specific recipe that added the Search marker.

Source files that errored on a recipe

org.openrewrite.table.SourcesFileErrors

The details of all errors produced by a recipe run.

Column	Description
Source path	The file that failed to parse.
Recipe that made changes	The specific recipe that made a change.
Stack trace	The stack trace of the failure.

Recipe performance

org.openrewrite.table.RecipeRunStats

Statistics used in analyzing the performance of recipes.

Column	Description
The recipe	The recipe whose stats are being measured both individually and cumulatively.
Source file count	The number of source files the recipe ran over.
Source file changed count	The number of source files which were changed in the recipe run. Includes files created, deleted, and edited.
Cumulative scanning time (ns)	The total time spent across the scanning phase of this recipe.
Max scanning time (ns)	The max time scanning any one source file.
Cumulative edit time (ns)	The total time spent across the editing phase of this recipe.
Max edit time (ns)	The max time editing any one source file.