How to use terraform import with module

Question

Terraform v0.11.11

We have a quite big AWS setup created with Terraform. Different regions are applied separately, and that is why we have most of the things in modules which are imported like this:

module "assets" {
  source       = "../modules/aws-assets"
  environment  = "${var.environment}"
  upload_users = "${var.upload_users}"
}

We have one s3 bucket created manually, and I try to import it. Terraform import command does not find the configuration file and errors.

Error: resource address "aws_s3_bucket.machine-learning" does not exist in the configuration.

Before importing this resource, please create its configuration in the root module. For example:

resource "aws_s3_bucket" "machine-learning" {
  # (resource arguments)
}

terraform apply/plan do find the configuration and wants to create it which is not what we want?

Thanks for you help!

================================

Edit:

now moved configuration to root and ended up with different error...

Answer 1

The terraform import command uses the "Resource Address" syntax, which is a way to talk about objects in a configuration from outside of that configuration. (This is as opposed to references in the main Terraform language, which are always resolved in the context of a particular module.)

To refer to a resource that is declared in a child module, you can add a module path to the beginning of the address:

terraform import module.assets.aws_s3_bucket.machine-learning BUCKET-NAME

---

If you aren't sure which address to use for a particular resource instance, you can run terraform plan to see which instance address Terraform is proposing to create, and then use that same address with terraform import instead to tell Terraform to use the existing object.

For addresses that include sequences like [0] and ["foo"] to represent one of multiple instances of a module or resource, you'll need to use escaping or quoting to make sure your shell doesn't interpret those as its own metacharacters, and instead passes them on literally to Terraform:

• On Unix-style shells, use single quotes to make the inner address be taken literally: terraform import 'aws_instance.example["foo"]'

• On Windows, from the command interpreter cmd.exe, escape any quotes with a backslash:

  terraform import "aws_instance.example[\"foo\"]"

  (PowerShell's escaping rules for external programs are very awkward and so I would not suggest using PowerShell to run a command like this.)

Answer 2

Run terraform plan first and use the names in the output.

Goal here is to import in the resources that are listed in the plan output so next time you run plan they won't be listed for add.

So aws_s3_bucket.machine-learning didn't exist in the plan output I bet. It could have been module.aws_s3_bucket.machine-learning or even module.aws_s3_bucket.machine-learning[0] depending on what your aws-assets.tf does.

Answer 3

main.tf

module "assets" {
  source       = "./modules"
}

modules/aws-assests.tf

resource "aws_s3_bucket" "machine-learning" {
  # (resource arguments)
}

To install the aws_s3_bucket module run the below command

# terraform init