Links

Add Terraform configuration

org.openrewrite.terraform.AddConfiguration
If the configuration has a different value, leave it alone. If it is missing, add it.

Source

  • groupId: org.openrewrite.recipe
  • artifactId: rewrite-terraform
  • version: 2.0.4

Options

Type
Name
Description
String
resourceName
A Terraform resource name, without the quotes.
String
content
Terraform to insert if an attribute with the same name or block with the same 'type' is not found.

Usage

This recipe has required configuration parameters. Recipes with required configuration parameters cannot be activated directly. To activate this recipe you must create a new recipe which fills in the required parameters. In your rewrite.yml create a new recipe with a unique name. For example: com.yourorg.AddConfigurationExample. Here's how you can define and customize such a recipe within your rewrite.yml:
rewrite.yml
---
type: specs.openrewrite.org/v1beta/recipe
name: com.yourorg.AddConfigurationExample
displayName: Add Terraform configuration example
recipeList:
- org.openrewrite.terraform.AddConfiguration:
resourceName: aws_ebs_volume
content: encrypted = true
Now that com.yourorg.AddConfigurationExample has been defined activate it and take a dependency on org.openrewrite.recipe:rewrite-terraform:2.0.4 in your build file:
Gradle
Maven
  1. 1.
    Add the following to your build.gradle file:
build.gradle
plugins {
id("org.openrewrite.rewrite") version("6.3.11")
}
rewrite {
activeRecipe("com.yourorg.AddConfigurationExample")
}
repositories {
mavenCentral()
}
dependencies {
rewrite("org.openrewrite.recipe:rewrite-terraform:2.0.4")
}
  1. 2.
    Run gradle rewriteRun to run the recipe.
  1. 1.
    Add the following to your pom.xml file:
pom.xml
<project>
<build>
<plugins>
<plugin>
<groupId>org.openrewrite.maven</groupId>
<artifactId>rewrite-maven-plugin</artifactId>
<version>5.5.2</version>
<configuration>
<activeRecipes>
<recipe>com.yourorg.AddConfigurationExample</recipe>
</activeRecipes>
</configuration>
<dependencies>
<dependency>
<groupId>org.openrewrite.recipe</groupId>
<artifactId>rewrite-terraform</artifactId>
<version>2.0.4</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</project>
  1. 2.
    Run mvn rewrite:run to run the recipe.

Contributors

See how this recipe works across multiple open-source repositories

Moderne Link Image
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.