com.hashicorp.cdktf

Interface RemoteExecProvisioner

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

RemoteExecProvisioner.Jsii$Proxy

@Generated(value="jsii-pacmak/1.77.0 (build 3e5fa88)",
           date="2023-04-05T14:53:11.961Z")
 @Stability(value=Experimental)
public interface RemoteExecProvisioner
extends software.amazon.jsii.JsiiSerializable

(experimental) 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 {@link https://developer.hashicorp.com/terraform/language/resources/provisioners/remote-exec remote-exec}

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static RemoteExecProvisioner.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 List<String>	getInline() (experimental) This is a list of command strings.
default String	getScript() (experimental) This is a path (relative or absolute) to a local script that will be copied to the remote resource and then executed.
default List<String>	getScripts() (experimental) This is a list of paths (relative or absolute) to local scripts that will be copied to the remote resource and then executed.
String	getType()

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getType

@Stability(value=Experimental)
 @NotNull
String getType()

getConnection

@Stability(value=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.

A connection must be provided here or in the parent resource.

getInline

@Stability(value=Experimental)
 @Nullable
default List<String> getInline()

(experimental) This is a list of command strings.

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

getScript

@Stability(value=Experimental)
 @Nullable
default String getScript()

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

getScripts

@Stability(value=Experimental)
 @Nullable
default List<String> getScripts()

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

builder

@Stability(value=Experimental)
static RemoteExecProvisioner.Builder builder()

Returns:

a RemoteExecProvisioner.Builder of RemoteExecProvisioner