Package com.hashicorp.cdktf

Interface WinrmProvisionerConnection

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
WinrmProvisionerConnection.Jsii$Proxy
@Generated(value="jsii-pacmak/1.91.0 (build 1b1f239)", date="2023-11-22T14:39:31.143Z") @Stability(Experimental) public interface WinrmProvisionerConnection extends software.amazon.jsii.JsiiSerializable
(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.

See

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

  • Method Details

    • getHost

      @Stability(Experimental) @NotNull String getHost()
      (experimental) The address of the resource to connect to.

    • getType

      @Stability(Experimental) @NotNull String getType()
      (experimental) The connection type.

      Valid values are "ssh" and "winrm". Provisioners typically assume that the remote system runs Microsoft Windows when using WinRM. Behaviors based on the SSH target_platform will force Windows-specific behavior for WinRM, unless otherwise specified.

    • getCacert

      @Stability(Experimental) @Nullable default String getCacert()
      (experimental) The CA certificate to validate against.

    • getHttps

      @Stability(Experimental) @Nullable default Boolean getHttps()
      (experimental) Set to true to connect using HTTPS instead of HTTP.

    • getInsecure

      @Stability(Experimental) @Nullable default Boolean getInsecure()
      (experimental) Set to true to skip validating the HTTPS certificate chain.

    • getPassword

      @Stability(Experimental) @Nullable default String getPassword()
      (experimental) The password to use for the connection.

    • getPort

      @Stability(Experimental) @Nullable default Number getPort()
      (experimental) The port to connect to.

      Default: 22

    • getScriptPath

      @Stability(Experimental) @Nullable default String getScriptPath()
      (experimental) The path used to copy scripts meant for remote execution.

      Refer to

      invalid @link 
      {@link https://developer.hashicorp.com/terraform/language/resources/provisioners/connection#how-provisioners-execute-remote-scripts
      How Provisioners Execute Remote Scripts below for more details}

    • getTimeout

      @Stability(Experimental) @Nullable default String getTimeout()
      (experimental) The timeout to wait for the connection to become available.

      Should be provided as a string (e.g., "30s" or "5m".)

      Default: 5m

    • getUseNtlm

      @Stability(Experimental) @Nullable default Boolean getUseNtlm()
      (experimental) Set to true to use NTLM authentication rather than default (basic authentication), removing the requirement for basic authentication to be enabled within the target guest.

      Refer to Authentication for Remote Connections in the Windows App Development documentation for more details.

    • getUser

      @Stability(Experimental) @Nullable default String getUser()
      (experimental) The user to use for the connection.

      Default: root

    • builder

      @Stability(Experimental) static WinrmProvisionerConnection.Builder builder()
      Returns:
      a WinrmProvisionerConnection.Builder of WinrmProvisionerConnection