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
import cdktn
cdktn.LocalExecProvisioner(
command: str,
type: str,
environment: typing.Mapping[str] = None,
interpreter: typing.List[str] = None,
when: str = None,
working_dir: str = None
)
Properties
| Name | Type | Description |
|---|
command | str | This is the command to execute. |
type | str | No description. |
environment | typing.Mapping[str] | A record of key value pairs representing the environment of the executed command. |
interpreter | typing.List[str] | If provided, this is a list of interpreter arguments used to execute the command. |
when | str | If provided, specifies when Terraform will execute the command. |
working_dir | str | If provided, specifies the working directory where command will be executed. |
commandRequired
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
environmentOptional
environment: typing.Mapping[str]
- Type: typing.Mapping[str]
A record of key value pairs representing the environment of the executed command.
It inherits the current process environment.
interpreterOptional
interpreter: typing.List[str]
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
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
working_dirOptional
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.