Skip to main content

Add a nested block to a Terraform resource

org.openrewrite.terraform.AddResourceNestedBlock

Add a nested block (e.g. parameter { ... }) to a Terraform resource if no matching instance exists. When keyMatchers is provided, the recipe deduplicates by attribute keys so it works correctly with repeatable blocks like aws_db_parameter_group.parameter.

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). Useful to narrow scoping by family, engine, etc.`family=mysql.*
ListkeyMatchersOptional. A list of attr=valueRegex entries identifying an existing nested block instance (e.g. name=local_infile for aws_db_parameter_group.parameter). If a sibling block of the same type matches every key, the nested block is considered already present and not inserted. Without keyMatchers, the recipe falls back to skipping insertion when any sibling block of the same type exists (suitable for single-instance blocks like lifecycle / timeouts).name=local_infile
StringblockRaw HCL of the nested block to insert, including the block type header and any labels. The block type (and labels) used for sibling lookup are derived from this value.
parameter {
  name  = "local_infile"
  value = "0"
}
StringpositionOptional. Where to place the new block within the resource body: first or last. Defaults to last. Valid options: first, lastlast

Example​

Parameters​
ParameterValue
resourceTypeaws_db_parameter_group
resourceNamePatternnull
resourceAttrMatchers`List.of("family=mysql.*
keyMatchersList.of("name=local_infile")
blockLOCAL_INFILE_BLOCK
positionnull
Before​
resource "aws_db_parameter_group" "mysql" {
  name   = "rds-mysql-pg"
  family = "mysql8.0"
}
After​
resource "aws_db_parameter_group" "mysql" {
  name   = "rds-mysql-pg"
  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.AddResourceNestedBlockExample
displayName: Add a nested block to a Terraform resource example
recipeList:
  - org.openrewrite.terraform.AddResourceNestedBlock:
      resourceType: aws_db_parameter_group
      resourceNamePattern: rds_.*
      resourceAttrMatchers:
        - family=mysql.*|mariadb.*
      keyMatchers:
        - name=local_infile
      block: >
        parameter {
          name  = "local_infile"
          value = "0"
        }
      position: last

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

shell
mod run . --recipe AddResourceNestedBlock --recipe-option "resourceType=aws_db_parameter_group" --recipe-option "resourceNamePattern=rds_.*" --recipe-option "resourceAttrMatchers=family=mysql.*|mariadb.*" --recipe-option "keyMatchers=name=local_infile" --recipe-option "block=>
        parameter {
          name  = "local_infile"
          value = "0"
        }" --recipe-option "position=last"

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.