github.com/nbering/terraform@v0.8.5-0.20170113232247-453f670684b5/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  ## Provider Configuration
    58  
    59  Terraform will attempt to load configuration files that configure the
    60  provider being used for import. If no configuration files are present or
    61  no configuration for that specific provider is present, Terraform will
    62  prompt you for access credentials. You may also specify environmental variables
    63  to configure the provider.
    64  
    65  The only limitation Terraform has when reading the configuration files
    66  is that the import provider configurations must not depend on non-variable
    67  inputs. For example, a provider configuration cannot depend on a data
    68  source.
    69  
    70  As a working example, if you're importing AWS resources and you have a
    71  configuration file with the contents below, then Terraform will configure
    72  the AWS provider with this file.
    73  
    74  ```
    75  variable "access_key" {}
    76  variable "secret_key" {}
    77  
    78  provider "aws" {
    79    access_key = "${var.access_key}"
    80    secret_key = "${var.secret_key}"
    81  }
    82  ```
    83  
    84  You can force Terraform to explicitly not load your configuration by
    85  specifying `-config=""` (empty string). This is useful in situations where
    86  you want to manually configure the provider because your configuration
    87  may not be valid.
    88  
    89  ## Example: AWS Instance
    90  
    91  This example will import an AWS instance:
    92  
    93  ```
    94  $ terraform import aws_instance.foo i-abcd1234
    95  ```
    96  
    97  ## Example: Import to Module
    98  
    99  The example below will import an AWS instance into a module:
   100  
   101  ```
   102  $ terraform import module.foo.aws_instance.bar i-abcd1234
   103  ```