Python: RemoteExecProvisioner

CDKTN Core API Reference for RemoteExecProvisioner in Python.

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 cdktn

cdktn.RemoteExecProvisioner(
  type: str,
  connection: SSHProvisionerConnection | WinrmProvisionerConnection = None,
  inline: typing.List[str] = None,
  script: str = None,
  scripts: typing.List[str] = None
)

Properties

Name	Type	Description
type	str	No description.
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.
inline	typing.List[str]	This is a list of command strings.
script	str	This is a path (relative or absolute) to a local script that will be copied to the remote resource and then executed.
scripts	typing.List[str]	This is a list of paths (relative or absolute) to local scripts that will be copied to the remote resource and then executed.

---

type^Required

type: str

• Type: str

---

connection^Optional

connection: SSHProvisionerConnection | WinrmProvisionerConnection

• Type: 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.

---

inline^Optional

inline: typing.List[str]

• Type: typing.List[str]

This is a list of command strings.

They are executed in the order they are provided. This cannot be provided with script or scripts.

---

script^Optional

script: str

• Type: str

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.

---

scripts^Optional

scripts: typing.List[str]

• Type: typing.List[str]

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.

---