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 Terraform module attribute

Recipe IDorg.openrewrite.terraform.ChangeModuleAttribute

Artifactorg.openrewrite.recipe:rewrite-terraform

Change the value of an attribute on a Terraform module block, for example to bump the version of every call site of a shared module. Modules are selected by their source address, since the same module is typically referenced under different local names.

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

5 parameters

2 required3 optional

Parameter	Example	Type	Required
attributeName	version	String	Required
The name of the attribute to change.
newValue	2.0.0	String	Required
The new value to set. For quoted string attributes, provide the value without quotes.
moduleNamePattern	vpc_.*	String	Optional
A regular expression matched against the module's local name (its only label). If not provided, modules with any name are considered.
oldValuePattern	1\..*	String	Optional
A regular expression to match the current attribute value. Only matching attributes will be changed. If not provided, all values will be changed. For quoted string values, match against the content without quotes.
sourcePattern	app\.terraform\.io/example/vpc/aws	String	Optional
A regular expression matched against the module's source value. Only modules with a matching source will be changed. If not provided, every module block is considered.

Examples

hcl

Parameter	Value
sourcePattern	app\.terraform\.io/example/vpc/aws
moduleNamePattern	null
attributeName	version
oldValuePattern	null
newValue	2.0.0

hcl

Before

module "network" {
  source  = "app.terraform.io/example/vpc/aws"
  version = "1.0.1"
}

After

module "network" {
  source  = "app.terraform.io/example/vpc/aws"
  version = "2.0.0"
}

Diff

@@ -3,1 +3,1 @@
module "network" {
  source  = "app.terraform.io/example/vpc/aws"
- version = "1.0.1"
+ version = "2.0.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 ChangeModuleAttribute --recipe-option "attributeName=version" --recipe-option "newValue=2.0.0"

To also set the recipe's optional settings, add them to the command. The values below are examples, not recommendations; see Options for what each one does.

With optional settings (example values)

mod run . --recipe ChangeModuleAttribute \
  --recipe-option "attributeName=version" \
  --recipe-option "newValue=2.0.0" \
  --recipe-option "sourcePattern=app\.terraform\.io/example/vpc/aws" \
  --recipe-option "moduleNamePattern=vpc_.*" \
  --recipe-option "oldValuePattern=1\..*"

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

RELEASE resolves to the newest release and LATEST to the newest build of any kind, including snapshots. Either one lets mod config recipes upgrade pull in later versions without editing this command; a pinned version stays where you put it.

RELEASE

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

LATEST

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

Pinned version

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

Data tables

Source files that had results

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Export after a run

mod study . --last-recipe-run \
  --data-table org.openrewrite.table.SourcesFileResults

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.

Export after a run

mod study . --last-recipe-run \
  --data-table org.openrewrite.table.SearchResults

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.

Export after a run

mod study . --last-recipe-run \
  --data-table org.openrewrite.table.SourcesFileErrors

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.

Export after a run

mod study . --last-recipe-run \
  --data-table org.openrewrite.table.RecipeRunStats

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.