Terraform resource block reference 🔥

Table of Contents

The resource block defines a piece of infrastructure and specifies the settings for Terraform to create it with.

The arguments that an individual resource supports are determined by the provider. Refer to the provider documentation for more information about specific resource configuration.

More info: https://developer.hashicorp.com/terraform/language/block/resource

Configuration model #

The resource block supports the following arguments:

resource "<TYPE>" "<LABEL>" block
- PROVIDER ARGUMENTS block | refer to your provider documentation
- count number | mutually exclusive with for_each
- depends_on list of references
- for_each map or set of strings | mutually exclusive with count
- provider reference
- lifecycle block
  - action_trigger block
    - events list | required to invoke an action
    - condition expression
    - actions list | required to invoke an action
  - create_before_destroy boolean
  - prevent_destroy boolean
  - ignore_changes list of attributes
  - replace_triggered_by list of references
  - precondition block
    - condition string
    - error_message string
  - postcondition block
    - condition string
    - error_message string
- connection block
  - type string
  - user string
  - password string
  - host string
  - port string
  - timeout string
  - script_path string
  - private_key string
  - certificate string
  - agent string
  - agent_identity string
  - host_key string
  - target_platform string
  - script_path string
  - https string
  - insecure string
  - use_ntlm string
  - cacert string
  - bastion_host string
  - bastion_host_key string
  - bastion_port string
  - bastion_user string
  - bastion_password string
  - bastion_private_key string
  - bastion_certificate string
  - proxy_scheme string
  - proxy_port string
  - proxy_user_name string
  - proxy_user_password string
- provisioner "<TYPE>" block
  - source string
  - destination string
  - content string
  - command string
  - working_dir string
  - interpreter string
  - environment string
  - when keyword
  - quiet boolean
  - inline list of strings
  - script string
  - scripts string
  - on_failure keyword
  - connection block

Complete configuration #

The following resource block defines all of the supported built-in arguments you can set on a resource:

resource "<TYPE>" "<LABEL>" {
  <PROVIDER_ARGUMENTS>
  count = <NUMBER>      # `for_each` and `count` are mutually exclusive
  depends_on = [ <RESOURCE.ADDRESS.EXPRESSION> ]
  for_each = {          # `for_each` and `count` are mutually exclusive
    <KEY> = <VALUE>
  }
  for_each = [       # `for_each` accepts a map or a set of strings
    "<VALUE>",
    "<VALUE>"
  ]
  provider = <REFERENCE.TO.ALIAS>
  lifecycle {
    action_trigger {
      events = [        # specify one or more lifecycle events as a list 
        before_create, 
        after_create,
        before_update,
        after_update
      ]
      condition = <EXPRESSSION>
      actions = [ action.<TYPE>.<LABEL> ]
    }
    create_before_destroy = <true || false>
    prevent_destroy = <true || false>
    ignore_changes = [ <ATTRIBUTE> ]
    replace_triggered_by = [ <RESOURCE.ADDRESS.EXPRESSION> ]
    precondition {
      condition = <EXPRESSION>
      error_message = "<STRING>"
    }
    postcondition {
      condition = <EXPRESSION>
      error_message = "<STRING>"
    }
  }
  connection {
    type = <"ssh" or "winrm">
    host = <EXPRESSION>
    <DEFAULT_CONNECTION_SETTINGS>
  }
  provisioner "<TYPE>" {
    source = "<PATH>"
    destination = "<PATH>"
    content = "<CONTENT TO COPY TO `destination`>"
    command = <COMMAND>
    working_dir = "<PATH TO DIR WHERE TERRAFORM EXECUTES `command`>"
    interpreter = [
      "<PATH TO INTERPRETER EXECUTABLE>",
      "<COMMAND> <ARGUMENTS>"
    ]
    environment {
      "<KEY>" = "<VALUE>"
    }
    when = <TERRAFORM COMMAND>
    quiet = <true || false>
    inline = [ "<COMMAND>" ]
    script = "<PATH>"
    scripts = [
      "<PATH>"
    ]
    on_failure = <continue || fail>
    connection {
      type = <"ssh" or "winrm">
      host = <EXPRESSION>
      <SPECIFIC_CONNECTION_SETTINGS>
    }
  }
}

» Sources « #

https://developer.hashicorp.com/terraform/language/block/resource