Package com.hashicorp.cdktf

Interface FileProvisioner

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FileProvisioner.Jsii$Proxy

@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
           date="2024-01-15T15:38:00.988Z")
@Stability(Experimental)
public interface FileProvisioner
extends software.amazon.jsii.JsiiSerializable

(experimental) 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

invalid @link

{@link https://developer.hashicorp.com/terraform/language/resources/provisioners/file

file}

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	FileProvisioner.Builder	A builder for FileProvisioner
static final class	FileProvisioner.Jsii$Proxy	An implementation for FileProvisioner

Method Summary

Modifier and Type	Method	Description
static FileProvisioner.Builder	builder()
default Object	getConnection()	(experimental) Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect.
default String	getContent()	(experimental) The destination path to write to on the remote system.
String	getDestination()	(experimental) The source file or directory.
default String	getSource()	(experimental) The direct content to copy on the destination.
String	getType()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestination

@Stability(Experimental)
@NotNull
String getDestination()

(experimental) 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.

getType

@Stability(Experimental)
@NotNull
String getType()

getConnection

@Stability(Experimental)
@Nullable
default Object getConnection()

(experimental) Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect.

getContent

@Stability(Experimental)
@Nullable
default String getContent()

(experimental) The destination path to write to on the remote system.

See Destination Paths below for more information.

getSource

@Stability(Experimental)
@Nullable
default String getSource()

(experimental) 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.

builder

@Stability(Experimental)
static FileProvisioner.Builder builder()

Returns:

a FileProvisioner.Builder of FileProvisioner