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 remote-exec provisioner invokes a script on a remote resource after it is created. This can be used to run a configuration management tool, bootstrap into a cluster, etc The remote-exec provisioner requires a connection and supports both ssh and winrm. See remote-exec

​
Initializer 

import { RemoteExecProvisioner } from 'cdktn'

const remoteExecProvisioner: RemoteExecProvisioner = { ... }

​
Properties

NameTypeDescription
typestringNo description.
connectionSSHProvisionerConnection | WinrmProvisionerConnectionMost provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect.
inlinestring[]This is a list of command strings.
scriptstringThis is a path (relative or absolute) to a local script that will be copied to the remote resource and then executed.
scriptsstring[]This is a list of paths (relative or absolute) to local scripts that will be copied to the remote resource and then executed.

​
typeRequired 

public readonly type: string;
  • Type: string

​
connectionOptional 

public readonly connection: SSHProvisionerConnection | WinrmProvisionerConnection;
Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect. A connection must be provided here or in the parent resource.

​
inlineOptional 

public readonly inline: string[];
  • Type: string[]
This is a list of command strings. They are executed in the order they are provided. This cannot be provided with script or scripts.

​
scriptOptional 

public readonly script: string;
  • Type: string
This is a path (relative or absolute) to a local script that will be copied to the remote resource and then executed. This cannot be provided with inline or scripts.

​
scriptsOptional 

public readonly scripts: string[];
  • Type: string[]
This is a list of paths (relative or absolute) to local scripts that will be copied to the remote resource and then executed. They are executed in the order they are provided. This cannot be provided with inline or script.