> ## 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.

# Go: LocalExecProvisioner

> CDKTN Core API Reference for LocalExecProvisioner in Go.

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](https://developer.hashicorp.com/terraform/language/resources/provisioners/local-exec)

## Initializer <a name="Initializer" id="cdktn.LocalExecProvisioner.Initializer" />

```go theme={null}
import "github.com/open-constructs/cdk-terrain-go/cdktn"

&cdktn.LocalExecProvisioner {
	Command: *string,
	Type: *string,
	Environment: *map[string]*string,
	Interpreter: *[]*string,
	When: *string,
	WorkingDir: *string,
}
```

## Properties <a name="Properties" id="Properties" />

| **Name**                                                                                | **Type**                            | **Description**                                                                   |
| --------------------------------------------------------------------------------------- | ----------------------------------- | --------------------------------------------------------------------------------- |
| <code><a href="#cdktn.LocalExecProvisioner.property.command">Command</a></code>         | <code>\*string</code>               | This is the command to execute.                                                   |
| <code><a href="#cdktn.LocalExecProvisioner.property.type">Type</a></code>               | <code>\*string</code>               | *No description.*                                                                 |
| <code><a href="#cdktn.LocalExecProvisioner.property.environment">Environment</a></code> | <code>\*map\[string]\*string</code> | A record of key value pairs representing the environment of the executed command. |
| <code><a href="#cdktn.LocalExecProvisioner.property.interpreter">Interpreter</a></code> | <code>\*\[]\*string</code>          | If provided, this is a list of interpreter arguments used to execute the command. |
| <code><a href="#cdktn.LocalExecProvisioner.property.when">When</a></code>               | <code>\*string</code>               | If provided, specifies when Terraform will execute the command.                   |
| <code><a href="#cdktn.LocalExecProvisioner.property.workingDir">WorkingDir</a></code>   | <code>\*string</code>               | If provided, specifies the working directory where command will be executed.      |

***

### `Command`<sup>Required</sup> <a name="Command" id="cdktn.LocalExecProvisioner.property.command" />

```go theme={null}
Command *string
```

* *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.

***

### `Type`<sup>Required</sup> <a name="Type" id="cdktn.LocalExecProvisioner.property.type" />

```go theme={null}
Type *string
```

* *Type:* \*string

***

### `Environment`<sup>Optional</sup> <a name="Environment" id="cdktn.LocalExecProvisioner.property.environment" />

```go theme={null}
Environment *map[string]*string
```

* *Type:* \*map\[string]\*string

A record of key value pairs representing the environment of the executed command.

It inherits the current process environment.

***

### `Interpreter`<sup>Optional</sup> <a name="Interpreter" id="cdktn.LocalExecProvisioner.property.interpreter" />

```go theme={null}
Interpreter *[]*string
```

* *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.

***

### `When`<sup>Optional</sup> <a name="When" id="cdktn.LocalExecProvisioner.property.when" />

```go theme={null}
When *string
```

* *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

***

### `WorkingDir`<sup>Optional</sup> <a name="WorkingDir" id="cdktn.LocalExecProvisioner.property.workingDir" />

```go theme={null}
WorkingDir *string
```

* *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.

***