How to update to version 3 of the Terraform AWS Provider

This guide consists of three main sections:

Version v3.0.0 of the Terraform AWS provider was released on July 30th 2020 with backwards incompatible updates. Following the provider release cycle, future releases from this point onward would only be compatible with 3.X. This means that if you wish to use any new resources or data sources that are released from this point onwards, you will need to be compatible with version 3 of the AWS provider to be able to pull those changes in.

Since this is a major version change, there are a number of backwards incompatible changes that were introduced. In order to be able to use version 3, you need to update your code to be compatible when upgrading (specifically, the resource and data source blocks that have backwards incompatible changes).

For your own code, you can follow the official guide on updating to AWS provider version 3. The rest of this guide will focus on updating references to Gruntwork modules and the Gruntwork Reference Architecture to be compatible with AWS provider version 3.

In order to take advantage of the Terraform AWS provider version 3, you need to update your references to the Gruntwork Infrastructure as Code Library to use a compatible version. We (Gruntwork) have gone through all our modules in the library to test and update the code to be compatible with AWS provider version 3. As a customer, you need to update to the proper versions of the Gruntwork library to pick up the fixes/changes that were made to be compatible. Be sure to read the release notes to know what changes need to be made to update to that version.

Refer to the "Updating" section of "How to use the Gruntwork Infrastructure as Code Library" for instructions on how to update the versions in your code.

The following table provides a summary of all the relevant Gruntwork AWS modules and the respective versions that are compatible with AWS provider version 3.

If you purchased the Gruntwork Reference Architecture, you will have a copy of the infrastructure-live and infrastructure-modules repositories that contain the infrastructure code for deploying the Reference Architecture. You will need to update the relevant code in infrastructure-modules to use a compatible version of the Gruntwork Infrastructure as Code Library, as per the compatibility table above.

To help guide you through the upgrade process, we have updated the Acme Reference Architecture examples to support AWS provider v3. You can refer to the following release notes for detailed information and code patches that you can apply to update your snapshot of the Gruntwork Reference Architecture: