Skip to main content

Documentation Index

Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

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 local-exec

​
Initializer 

using Io.Cdktn;

new LocalExecProvisioner {
    string Command,
    string Type,
    System.Collections.Generic.IDictionary<string, string> Environment = null,
    string[] Interpreter = null,
    string When = null,
    string WorkingDir = null
};

​
Properties

NameTypeDescription
CommandstringThis is the command to execute.
TypestringNo description.
EnvironmentSystem.Collections.Generic.IDictionary< string, string >A record of key value pairs representing the environment of the executed command.
Interpreterstring[]If provided, this is a list of interpreter arguments used to execute the command.
WhenstringIf provided, specifies when Terraform will execute the command.
WorkingDirstringIf provided, specifies the working directory where command will be executed.

​
CommandRequired 

public string Command { get; set; }
  • Type: string
This is the command to execute. It can be provided as a relative path to the current working directory or as an absolute path. It is evaluated in a shell, and can use environment variables or Terraform variables.

​
TypeRequired 

public string Type { get; set; }
  • Type: string

​
EnvironmentOptional 

public System.Collections.Generic.IDictionary<string, string> Environment { get; set; }
  • Type: System.Collections.Generic.IDictionary< string, string >
A record of key value pairs representing the environment of the executed command. It inherits the current process environment.

​
InterpreterOptional 

public string[] Interpreter { get; set; }
  • Type: string[]
If provided, this is a list of interpreter arguments used to execute the command. The first argument is the interpreter itself. It can be provided as a relative path to the current working directory or as an absolute path The remaining arguments are appended prior to the command. This allows building command lines of the form “/bin/bash”, “-c”, “echo foo”. If interpreter is unspecified, sensible defaults will be chosen based on the system OS.

​
WhenOptional 

public string When { get; set; }
  • Type: string
If provided, specifies when Terraform will execute the command. For example, when = destroy specifies that the provisioner will run when the associated resource is destroyed

​
WorkingDirOptional 

public string WorkingDir { get; set; }
  • Type: string
If provided, specifies the working directory where command will be executed. It can be provided as a relative path to the current working directory or as an absolute path. The directory must exist.