Skip to main content

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

org.openrewrite.terraform.ChangeResourceNestedBlockAttribute

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.

Recipe source​

This recipe is only available to users of Moderne.

This recipe is available under the Moderne Proprietary License.

Options​

TypeNameDescriptionExample
StringresourceTypeA Terraform resource type, without the quotes.aws_db_parameter_group
StringresourceNamePatternOptional. A regular expression matched against the resource's local name (the second label). If omitted, all resources of resourceType are considered.rds_.*
ListresourceAttrMatchersOptional. A list of attr=valueRegex entries. The resource is considered a match only if every entry matches an attribute on the resource (AND semantics).`family=mysql.*
StringblockTypeThe type of nested block to update (e.g. parameter, tag, setting).parameter
ListkeyMatchersOptional. A list of attr=valueRegex entries identifying the specific nested block instance to update. If omitted, every block of the given blockType is updated.name=local_infile
StringattributeNameThe attribute inside the nested block whose value should change.value
StringnewValueThe new value to set. For quoted string attributes, provide the value without quotes.0

Example​

Parameters​
ParameterValue
resourceTypeaws_db_parameter_group
resourceNamePatternnull
resourceAttrMatchers`List.of("family=mysql.*
blockTypeparameter
keyMatchersList.of("name=local_infile")
attributeNamevalue
newValue0
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"
  }
}

Usage​

This recipe has required configuration parameters and can only be run by users of Moderne. To run this recipe, you will need to provide the Moderne CLI run command with the required options. Or, if you'd like to create a declarative recipe, please see the below example of a rewrite.yml file:

rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.ChangeResourceNestedBlockAttributeExample
displayName: Change a single attribute inside a Terraform resource's nested block example
recipeList:
  - org.openrewrite.terraform.ChangeResourceNestedBlockAttribute:
      resourceType: aws_db_parameter_group
      resourceNamePattern: rds_.*
      resourceAttrMatchers:
        - family=mysql.*|mariadb.*
      blockType: parameter
      keyMatchers:
        - name=local_infile
      attributeName: value
      newValue: 0

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.0

See how this recipe works across multiple open-source repositories​

Run this recipe on OSS repos at scale with the Moderne SaaS.

The community edition of the Moderne platform enables you to easily run recipes across thousands of open-source repositories.

Please contact Moderne for more information about safely running the recipes on your own codebase in a private SaaS.

Data Tables​

Source files that had results​

org.openrewrite.table.SourcesFileResults

Source files that were modified by the recipe run.

Column NameDescription
Source path before the runThe source path of the file before the run. null when a source file was created during the run.
Source path after the runA 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 changesIn 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 changesThe specific recipe that made a change.
Estimated time savingAn estimated effort that a developer to fix manually instead of using this recipe, in unit of seconds.
CycleThe recipe cycle in which the change was made.