github.com/atsaki/terraform@v0.4.3-0.20150919165407-25bba5967654/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 ~> **NOTE on create\_before\_destroy and dependencies:** Resources that utilize 72 the `create_before_destroy` key can only depend on other resources that also 73 include `create_before_destroy`. Referencing a resource that does not include 74 `create_before_destroy` will result in a dependency graph cycle. 75 76 ------------- 77 78 Within a resource, you can optionally have a **connection block**. 79 Connection blocks describe to Terraform how to connect to the 80 resource for 81 [provisioning](/docs/provisioners/index.html). This block doesn't 82 need to be present if you're using only local provisioners, or 83 if you're not provisioning at all. 84 85 Resources provide some data on their own, such as an IP address, 86 but other data must be specified by the user. 87 88 The full list of settings that can be specified are listed on 89 the [provisioner connection page](/docs/provisioners/connection.html). 90 91 ------------- 92 93 Within a resource, you can specify zero or more **provisioner 94 blocks**. Provisioner blocks configure 95 [provisioners](/docs/provisioners/index.html). 96 97 Within the provisioner block is provisioner-specific configuration, 98 much like resource-specific configuration. 99 100 Provisioner blocks can also contain a connection block 101 (documented above). This connection block can be used to 102 provide more specific connection info for a specific provisioner. 103 An example use case might be to use a different user to log in 104 for a single provisioner. 105 106 <a id="using-variables-with-count"></a> 107 108 ## Using Variables With `count` 109 110 When declaring multiple instances of a resource using [`count`](#count), it is 111 common to want each instance to have a different value for a given attribute. 112 113 You can use the `${count.index}` 114 [interpolation](/docs/configuration/interpolation.html) along with a mapping [variable](/docs/configuration/variables.html) to accomplish this. 115 116 For example, here's how you could create three [AWS Instances](/docs/providers/aws/r/instance.html) each with their own static IP 117 address: 118 119 ``` 120 variable "instance_ips" { 121 default = { 122 "0" = "10.11.12.100" 123 "1" = "10.11.12.101" 124 "2" = "10.11.12.102" 125 } 126 } 127 128 resource "aws_instance" "app" { 129 count = "3" 130 private_ip = "${lookup(var.instance_ips, count.index)}" 131 # ... 132 } 133 ``` 134 135 ## Multiple Provider Instances 136 137 By default, a resource targets the provider based on its type. For example 138 an `aws_instance` resource will target the "aws" provider. As of Terraform 139 0.5.0, a resource can target any provider by name. 140 141 The primary use case for this is to target a specific configuration of 142 a provider that is configured multiple times to support multiple regions, etc. 143 144 To target another provider, set the `provider` field: 145 146 ``` 147 resource "aws_instance" "foo" { 148 provider = "aws.west" 149 150 # ... 151 } 152 ``` 153 154 The value of the field should be `TYPE` or `TYPE.ALIAS`. The `ALIAS` value 155 comes from the `alias` field value when configuring the 156 [provider](/docs/configuration/providers.html). 157 158 If no `provider` field is specified, the default (provider with no alias) 159 provider is used. 160 161 ## Syntax 162 163 The full syntax is: 164 165 ``` 166 resource TYPE NAME { 167 CONFIG ... 168 [count = COUNT] 169 [depends_on = [RESOURCE NAME, ...]] 170 [provider = PROVIDER] 171 172 [LIFECYCLE] 173 174 [CONNECTION] 175 [PROVISIONER ...] 176 } 177 ``` 178 179 where `CONFIG` is: 180 181 ``` 182 KEY = VALUE 183 184 KEY { 185 CONFIG 186 } 187 ``` 188 189 where `LIFECYCLE` is: 190 191 ``` 192 lifecycle { 193 [create_before_destroy = true|false] 194 } 195 ``` 196 197 where `CONNECTION` is: 198 199 ``` 200 connection { 201 KEY = VALUE 202 ... 203 } 204 ``` 205 206 where `PROVISIONER` is: 207 208 ``` 209 provisioner NAME { 210 CONFIG ... 211 212 [CONNECTION] 213 } 214 ```