github.com/minamijoyo/terraform@v0.7.8-0.20161029001309-18b3736ba44b/website/source/docs/provisioners/local-exec.html.markdown (about)

     1  ---
     2  layout: "docs"
     3  page_title: "Provisioner: local-exec"
     4  sidebar_current: "docs-provisioners-local"
     5  description: |-
     6    The `local-exec` provisioner invokes a local executable after a resource is created. This invokes a process on the machine running Terraform, not on the resource. See the `remote-exec` provisioner to run commands on the resource.
     7  ---
     8  
     9  # local-exec Provisioner
    10  
    11  The `local-exec` provisioner invokes a local executable after a resource
    12  is created. This invokes a process on the machine running Terraform, not on
    13  the resource. See the `remote-exec` [provisioner](/docs/provisioners/remote-exec.html)
    14  to run commands on the resource.
    15  
    16  Note that even though the resource will be fully created when the provisioner is run,
    17  there is no guarantee that it will be in an operable state - for example system services
    18  such as `sshd` may not be started yet on compute resources.
    19  
    20  ## Example usage
    21  
    22  ```
    23  # Join the newly created machine to our Consul cluster
    24  resource "aws_instance" "web" {
    25      ...
    26      provisioner "local-exec" {
    27          command = "echo ${aws_instance.web.private_ip} >> private_ips.txt"
    28      }
    29  }
    30  ```
    31  
    32  ## Argument Reference
    33  
    34  The following arguments are supported:
    35  
    36  * `command` - (Required) This is the command to execute. It can be provided
    37    as a relative path to the current working directory or as an absolute path.
    38    It is evaluated in a shell, and can use environment variables or Terraform
    39    variables.
    40