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 

import { LocalExecProvisioner } from 'cdktn'

const localExecProvisioner: LocalExecProvisioner = { ... }

​
Properties

NameTypeDescription
commandstringThis is the command to execute.
typestringNo description.
environment{[ key: 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 readonly 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.

​
typeRequired 

public readonly type: string;
  • Type: string

​
environmentOptional 

public readonly environment: {[ key: string ]: string};
  • Type: {[ key: string ]: string}
A record of key value pairs representing the environment of the executed command. It inherits the current process environment.

​
interpreterOptional 

public readonly 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.

​
whenOptional 

public readonly 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

​
workingDirOptional 

public readonly 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.