CDKTF Local Exec Construct
A simple construct that executes a command locally. This is useful to run build steps within your CDKTF Program or to run a post action after a resource is created.
The construct uses the null provider to achieve this so it can be trusted to only run after all dependencies are met.
Usage
import { Provider, LocalExec } from "cdktf-local-exec";
// LocalExec extends from the null provider,
// so if you already have the provider initialized you can skip this step
new Provider(this, "local-exec");
const frontend = new LocalExec(this, "frontend-build", {
// Will copy this into an asset directory
cwd: "/path/to/project/frontend",
command: "npm install && npm build",
});
const pathToUpload = `${frontend.path}/dist`;
new LocalExec(this, "frontend-upload", {
cwd: pathToUpload,
command: `aws s3 cp --recursive ${pathToUpload} s3://${bucket.name}/frontend`,
});
new LocalExec(this, "backend-build", {
cwd: "/path/to/project/backend",
copyBeforeRun: false, // can not run remotely since the runner has no docker access
command: "docker build -t foo . && docker push foo",
});
Options
cwd: The working directory to run the command in. It will be copied before execution to ensure the asset can be used in a remote execution environment.command: The command to execute.copyBeforeRun: If true, the command will copy thecwddirectory into a tmp dir and run there. If false, the command will be executed in thecwddirectory.
2 maintainers
Release files for cdktf-local-exec 0.2.17
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cdktf-local-exec-0.2.17.tar.gz | 28.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cdktf_local_exec-0.2.17-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 55.9 kB
Release files / cdktf-local-exec-0.2.17.tar.gz
| Download URL | cdktf-local-exec-0.2.17.tar.gz |
|---|---|
| Size | 28.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1e9a40ba4627614d52431bfb3406eff2f87aebfa99cbf814e5cf0aa563b6af22
|
|
BLAKE2b-256 checksum How to use checksums |
c5bf2a613fdcb8f22be687d6b1a7e0afb350e4adadd7741cd0dcc3743ef43de3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.3
|
Release files / cdktf_local_exec-0.2.17-py3-none-any.whl
| Download URL | cdktf_local_exec-0.2.17-py3-none-any.whl |
|---|---|
| Size | 27.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
62fa110975587823aa1b38a052557608309a852d176c577984a2df1d9d824c09
|
|
BLAKE2b-256 checksum How to use checksums |
4f46369550f49300605455ac2059c99333dee29eaa27a95ccf32282556e6ddea
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.11.3
|
