Moderne licensed

Change Terraform required provider attribute

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

Change the value of an attribute on an entry of a terraform { required_providers { ... } } block, for example to bump a provider version constraint or to point a source at a different registry. Since Terraform 0.13 this is where provider versions are declared, so use this recipe rather than ChangeProviderConfigurationAttribute to manage provider versions.

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.ChangeRequiredProviderAttribute")
}

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.16.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.ChangeRequiredProviderAttribute --recipe-option "attributeName=version" --recipe-option "newValue=~> 5.0"

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

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

Options

Name	Type	Description
`sourcePattern`	`String`	A regular expression matched against the required provider's `source` value. Only providers with a matching source will be changed. If not provided, every entry of `required_providers` is considered. e.g. `hashicorp/aws`
`providerNamePattern`	`String`	A regular expression matched against the local name the provider is configured under, which is the key of the `required_providers` entry. If not provided, providers with any name are considered. e.g. `aws`
`attributeName`required	`String`	The name of the attribute to change, typically `version` or `source`. e.g. `version`
`oldValuePattern`	`String`	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. e.g. `~> 4\..*`
`newValue`required	`String`	The new value to set. For quoted string attributes, provide the value without quotes. e.g. `~> 5.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