github.com/jmbataller/terraform@v0.6.8-0.20151125192640-b7a12e3a580c/website/source/docs/configuration/resources.html.md (about) 1 --- 2 layout: "docs" 3 page_title: "Configuring Resources" 4 sidebar_current: "docs-config-resources" 5 description: |- 6 The most important thing you'll configure with Terraform are resources. Resources are a component of your infrastructure. It might be some low level component such as a physical server, virtual machine, or container. Or it can be a higher level component such as an email provider, DNS record, or database provider. 7 --- 8 9 # Resource Configuration 10 11 The most important thing you'll configure with Terraform are 12 resources. Resources are a component of your infrastructure. 13 It might be some low level component such as a physical server, 14 virtual machine, or container. Or it can be a higher level 15 component such as an email provider, DNS record, or database 16 provider. 17 18 This page assumes you're familiar with the 19 [configuration syntax](/docs/configuration/syntax.html) 20 already. 21 22 ## Example 23 24 A resource configuration looks like the following: 25 26 ``` 27 resource "aws_instance" "web" { 28 ami = "ami-123456" 29 instance_type = "m1.small" 30 } 31 ``` 32 33 ## Description 34 35 The `resource` block creates a resource of the given `TYPE` (first 36 parameter) and `NAME` (second parameter). The combination of the type 37 and name must be unique. 38 39 Within the block (the `{ }`) is configuration for the resource. The 40 configuration is dependent on the type, and is documented for each 41 resource type in the 42 [providers section](/docs/providers/index.html). 43 44 There are **meta-parameters** available to all resources: 45 46 * `count` (int) - The number of identical resources to create. 47 This doesn't apply to all resources. For details on using variables in 48 conjunction with count, see [Using Variables with 49 `count`](#using-variables-with-count) below. 50 51 * `depends_on` (list of strings) - Explicit dependencies that this 52 resource has. These dependencies will be created before this 53 resource. The dependencies are in the format of `TYPE.NAME`, 54 for example `aws_instance.web`. 55 56 * `lifecycle` (configuration block) - Customizes the lifecycle 57 behavior of the resource. The specific options are documented 58 below. 59 60 The `lifecycle` block allows the following keys to be set: 61 62 * `create_before_destroy` (bool) - This flag is used to ensure 63 the replacement of a resource is created before the original 64 instance is destroyed. As an example, this can be used to 65 create an new DNS record before removing an old record. 66 67 * `prevent_destroy` (bool) - This flag provides extra protection against the 68 destruction of a given resource. When this is set to `true`, any plan 69 that includes a destroy of this resource will return an error message. 70 71 * `ignore_changes` (list of strings) - Customizes how diffs are evaluated for 72 resources, allowing individual attributes to be ignored through changes. 73 As an example, this can be used to ignore dynamic changes to the 74 resource from external resources. Other meta-parameters cannot be ignored. 75 76 ~> **NOTE on create\_before\_destroy and dependencies:** Resources that utilize 77 the `create_before_destroy` key can only depend on other resources that also 78 include `create_before_destroy`. Referencing a resource that does not include 79 `create_before_destroy` will result in a dependency graph cycle. 80 81 ~> **NOTE on ignore\_changes:** Ignored attribute names can be matched by their 82 name, not state ID. For example, if an `aws_route_table` has two routes defined 83 and the `ignore_changes` list contains "route", both routes will be ignored. 84 85 ------------- 86 87 Within a resource, you can optionally have a **connection block**. 88 Connection blocks describe to Terraform how to connect to the 89 resource for 90 [provisioning](/docs/provisioners/index.html). This block doesn't 91 need to be present if you're using only local provisioners, or 92 if you're not provisioning at all. 93 94 Resources provide some data on their own, such as an IP address, 95 but other data must be specified by the user. 96 97 The full list of settings that can be specified are listed on 98 the [provisioner connection page](/docs/provisioners/connection.html). 99 100 ------------- 101 102 Within a resource, you can specify zero or more **provisioner 103 blocks**. Provisioner blocks configure 104 [provisioners](/docs/provisioners/index.html). 105 106 Within the provisioner block is provisioner-specific configuration, 107 much like resource-specific configuration. 108 109 Provisioner blocks can also contain a connection block 110 (documented above). This connection block can be used to 111 provide more specific connection info for a specific provisioner. 112 An example use case might be to use a different user to log in 113 for a single provisioner. 114 115 <a id="using-variables-with-count"></a> 116 117 ## Using Variables With `count` 118 119 When declaring multiple instances of a resource using [`count`](#count), it is 120 common to want each instance to have a different value for a given attribute. 121 122 You can use the `${count.index}` 123 [interpolation](/docs/configuration/interpolation.html) along with a mapping [variable](/docs/configuration/variables.html) to accomplish this. 124 125 For example, here's how you could create three [AWS Instances](/docs/providers/aws/r/instance.html) each with their own static IP 126 address: 127 128 ``` 129 variable "instance_ips" { 130 default = { 131 "0" = "10.11.12.100" 132 "1" = "10.11.12.101" 133 "2" = "10.11.12.102" 134 } 135 } 136 137 resource "aws_instance" "app" { 138 count = "3" 139 private_ip = "${lookup(var.instance_ips, count.index)}" 140 # ... 141 } 142 ``` 143 144 ## Multiple Provider Instances 145 146 By default, a resource targets the provider based on its type. For example 147 an `aws_instance` resource will target the "aws" provider. As of Terraform 148 0.5.0, a resource can target any provider by name. 149 150 The primary use case for this is to target a specific configuration of 151 a provider that is configured multiple times to support multiple regions, etc. 152 153 To target another provider, set the `provider` field: 154 155 ``` 156 resource "aws_instance" "foo" { 157 provider = "aws.west" 158 159 # ... 160 } 161 ``` 162 163 The value of the field should be `TYPE` or `TYPE.ALIAS`. The `ALIAS` value 164 comes from the `alias` field value when configuring the 165 [provider](/docs/configuration/providers.html). 166 167 If no `provider` field is specified, the default (provider with no alias) 168 provider is used. 169 170 ## Syntax 171 172 The full syntax is: 173 174 ``` 175 resource TYPE NAME { 176 CONFIG ... 177 [count = COUNT] 178 [depends_on = [RESOURCE NAME, ...]] 179 [provider = PROVIDER] 180 181 [LIFECYCLE] 182 183 [CONNECTION] 184 [PROVISIONER ...] 185 } 186 ``` 187 188 where `CONFIG` is: 189 190 ``` 191 KEY = VALUE 192 193 KEY { 194 CONFIG 195 } 196 ``` 197 198 where `LIFECYCLE` is: 199 200 ``` 201 lifecycle { 202 [create_before_destroy = true|false] 203 [prevent_destroy = true|false] 204 [ignore_changes = [ATTRIBUTE NAME, ...]] 205 } 206 ``` 207 208 where `CONNECTION` is: 209 210 ``` 211 connection { 212 KEY = VALUE 213 ... 214 } 215 ``` 216 217 where `PROVISIONER` is: 218 219 ``` 220 provisioner NAME { 221 CONFIG ... 222 223 [CONNECTION] 224 } 225 ```