github.com/vtorhonen/terraform@v0.9.0-beta2.0.20170307220345-5d894e4ffda7/website/source/docs/commands/import.html.md (about)

     1  ---
     2  layout: "docs"
     3  page_title: "Command: import"
     4  sidebar_current: "docs-commands-import"
     5  description: |-
     6    The `terraform import` command is used to import existing resources into Terraform.
     7  ---
     8  
     9  # Command: import
    10  
    11  The `terraform import` command is used to
    12  [import existing resources](/docs/import/index.html)
    13  into Terraform.
    14  
    15  ## Usage
    16  
    17  Usage: `terraform import [options] ADDRESS ID`
    18  
    19  Import will find the existing resource from ID and import it into your Terraform
    20  state at the given ADDRESS.
    21  
    22  ADDRESS must be a valid [resource address](/docs/internals/resource-addressing.html).
    23  Because any resource address is valid, the import command can import resources
    24  into modules as well directly into the root of your state.
    25  
    26  ID is dependent on the resource type being imported. For example, for AWS
    27  instances it is the instance ID (`i-abcd1234`) but for AWS Route53 zones
    28  it is the zone ID (`Z12ABC4UGMOZ2N`). Please reference the provider documentation for details
    29  on the ID format. If you're unsure, feel free to just try an ID. If the ID
    30  is invalid, you'll just receive an error message.
    31  
    32  The command-line flags are all optional. The list of available flags are:
    33  
    34  * `-backup=path` - Path to backup the existing state file. Defaults to
    35    the `-state-out` path with the ".backup" extension. Set to "-" to disable
    36    backups.
    37  
    38  * `-config=path` - Path to directory of Terraform configuration files that
    39    configure the provider for import. This defaults to your working directory.
    40    If this directory contains no Terraform configuration files, the provider
    41    must be configured via manual input or environmental variables.
    42  
    43  * `-input=true` - Whether to ask for input for provider configuration.
    44  
    45  * `-state=path` - The path to read and save state files (unless state-out is
    46    specified). Ignored when [remote state](/docs/state/remote/index.html) is used.
    47  
    48  * `-state-out=path` - Path to write the final state file. By default, this is
    49    the state path. Ignored when [remote state](/docs/state/remote/index.html) is
    50    used.
    51  
    52  * `-provider=provider` - Specified provider to use for import. This is used for
    53    specifying provider aliases, such as "aws.eu". This defaults to the normal
    54    provider based on the prefix of the resource being imported. You usually
    55    don't need to specify this.
    56  
    57  * `-var 'foo=bar'` - Set a variable in the Terraform configuration. This flag
    58    can be set multiple times. Variable values are interpreted as
    59    [HCL](/docs/configuration/syntax.html#HCL), so list and map values can be
    60    specified via this flag. This is only useful with the `-config` flag.
    61  
    62  * `-var-file=foo` - Set variables in the Terraform configuration from
    63     a [variable file](/docs/configuration/variables.html#variable-files). If
    64    "terraform.tfvars" is present, it will be automatically loaded first. Any
    65    files specified by `-var-file` override any values in a "terraform.tfvars".
    66    This flag can be used multiple times. This is only useful with the `-config`
    67    flag.
    68  
    69  ## Provider Configuration
    70  
    71  Terraform will attempt to load configuration files that configure the
    72  provider being used for import. If no configuration files are present or
    73  no configuration for that specific provider is present, Terraform will
    74  prompt you for access credentials. You may also specify environmental variables
    75  to configure the provider.
    76  
    77  The only limitation Terraform has when reading the configuration files
    78  is that the import provider configurations must not depend on non-variable
    79  inputs. For example, a provider configuration cannot depend on a data
    80  source.
    81  
    82  As a working example, if you're importing AWS resources and you have a
    83  configuration file with the contents below, then Terraform will configure
    84  the AWS provider with this file.
    85  
    86  ```
    87  variable "access_key" {}
    88  variable "secret_key" {}
    89  
    90  provider "aws" {
    91    access_key = "${var.access_key}"
    92    secret_key = "${var.secret_key}"
    93  }
    94  ```
    95  
    96  You can force Terraform to explicitly not load your configuration by
    97  specifying `-config=""` (empty string). This is useful in situations where
    98  you want to manually configure the provider because your configuration
    99  may not be valid.
   100  
   101  ## Example: AWS Instance
   102  
   103  This example will import an AWS instance:
   104  
   105  ```
   106  $ terraform import aws_instance.foo i-abcd1234
   107  ```
   108  
   109  ## Example: Import to Module
   110  
   111  The example below will import an AWS instance into a module:
   112  
   113  ```
   114  $ terraform import module.foo.aws_instance.bar i-abcd1234
   115  ```