← All recipes
Moderne licensed

Change Terraform resource attribute

Recipe IDorg.openrewrite.terraform.ChangeResourceAttributeArtifactorg.openrewrite.recipe:rewrite-terraform

Change the value of a Terraform resource attribute if it matches a given pattern.

Single recipeProprietary

Add to your build

Get a download tokenThis recipe is Moderne licensed, so the token must belong to a Moderne customer. It replaces YOUR_DOWNLOAD_TOKEN below.

~/.gradle/gradle.properties

codeGenomeUsername=you@example.com
codeGenomeToken=YOUR_DOWNLOAD_TOKEN

build.gradle.kts

plugins {
    id("org.openrewrite.rewrite") version("latest.release")
}

rewrite {
    activeRecipe("org.openrewrite.terraform.ChangeResourceAttribute")
}

repositories {
    mavenCentral()
    maven {
        url = uri("https://artifacts.codegenomeproject.org/maven")
        credentials {
            username = providers.gradleProperty("codeGenomeUsername").get()
            password = providers.gradleProperty("codeGenomeToken").get()
        }
    }
}

dependencies {
    rewrite("org.openrewrite.recipe:rewrite-terraform:3.15.0")
}

Then run

./gradlew rewriteRun

This recipe has required options, which a build sets in a rewrite.yml recipe that you activate instead.

Usage

You’ll need the Moderne CLI configured before running the command below.

mod run . --recipe org.openrewrite.terraform.ChangeResourceAttribute --recipe-option "resourceName=aws_db_instance" --recipe-option "attributeName=engine_version" --recipe-option "newValue=8.0"

If the recipe isn’t available locally, install it with:

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

Options

NameTypeDescription
resourceNamerequiredStringA Terraform resource type, without the quotes.
e.g. aws_db_instance
attributeNamerequiredStringThe name of the attribute to change.
e.g. engine_version
oldValuePatternStringA 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.
e.g. 5\.7.*
newValuerequiredStringThe new value to set. For quoted string attributes, provide the value without quotes.
e.g. 8.0

Data tables

Structured output this recipe can produce.

  • Source files that had resultsSource files that were modified by the recipe run.org.openrewrite.table.SourcesFileResults
  • Source files that had search resultsSearch results that were found during the recipe run.org.openrewrite.table.SearchResults
  • Source files that errored on a recipeThe details of all errors produced by a recipe run.org.openrewrite.table.SourcesFileErrors
  • Recipe performanceStatistics used in analyzing the performance of recipes.org.openrewrite.table.RecipeRunStats