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 io.cdktn.cdktn.LocalExecProvisioner;

LocalExecProvisioner.builder()
    .command(java.lang.String)
    .type(java.lang.String)
//  .environment(java.util.Map<java.lang.String, java.lang.String>)
//  .interpreter(java.util.List<java.lang.String>)
//  .when(java.lang.String)
//  .workingDir(java.lang.String)
    .build();

​
Properties

NameTypeDescription
commandjava.lang.StringThis is the command to execute.
typejava.lang.StringNo description.
environmentjava.util.Map< java.lang.String, java.lang.String >A record of key value pairs representing the environment of the executed command.
interpreterjava.util.List< java.lang.String >If provided, this is a list of interpreter arguments used to execute the command.
whenjava.lang.StringIf provided, specifies when Terraform will execute the command.
workingDirjava.lang.StringIf provided, specifies the working directory where command will be executed.

​
commandRequired 

public java.lang.String getCommand();
  • Type: java.lang.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 java.lang.String getType();
  • Type: java.lang.String

​
environmentOptional 

public java.util.Map<java.lang.String, java.lang.String> getEnvironment();
  • Type: java.util.Map< java.lang.String, java.lang.String >
A record of key value pairs representing the environment of the executed command. It inherits the current process environment.

​
interpreterOptional 

public java.util.List<java.lang.String> getInterpreter();
  • Type: java.util.List< java.lang.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 java.lang.String getWhen();
  • Type: java.lang.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 java.lang.String getWorkingDir();
  • Type: java.lang.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.