Typescript: FileProvisioner

CDKTN Core API Reference for FileProvisioner in Typescript.

The file provisioner copies files or directories from the machine running Terraform to the newly created resource.

The file provisioner supports both ssh and winrm type connections.

See file

Initializer

import { FileProvisioner } from 'cdktn'

const fileProvisioner: FileProvisioner = { ... }

Properties

Name	Type	Description
destination	string	The source file or directory.
type	string	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.
content	string	The destination path to write to on the remote system.
source	string	The direct content to copy on the destination.

---

destination^Required

public readonly destination: string;

• Type: string

The source file or directory.

Specify it either relative to the current working directory or as an absolute path. This argument cannot be combined with content.

---

type^Required

public readonly type: string;

• Type: string

---

connection^Optional

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

---

content^Optional

public readonly content: string;

• Type: string

The destination path to write to on the remote system.

See Destination Paths below for more information.

---

source^Optional

public readonly source: string;

• Type: string

The direct content to copy on the destination.

If destination is a file, the content will be written on that file. In case of a directory, a file named tf-file-content is created inside that directory. We recommend using a file as the destination when using content. This argument cannot be combined with source.

---