Package com.hashicorp.cdktf

Interface RemoteExecProvisioner

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
RemoteExecProvisioner.Jsii$Proxy
@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)", date="2024-02-12T11:51:18.816Z") @Stability(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

invalid @link 
{@link https://developer.hashicorp.com/terraform/language/resources/provisioners/remote-exec
remote-exec}

  • Nested Class Summary

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

  • Method Summary

    Modifier and Type
    Method
    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 Details

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

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

    • getInline

      @Stability(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(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(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(Experimental) static RemoteExecProvisioner.Builder builder()
      Returns:
      a RemoteExecProvisioner.Builder of RemoteExecProvisioner