Java: WinrmProvisionerConnection

CDKTN Core API Reference for WinrmProvisionerConnection in Java.

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 connection

Initializer

import io.cdktn.cdktn.WinrmProvisionerConnection;

WinrmProvisionerConnection.builder()
    .host(java.lang.String)
    .type(java.lang.String)
//  .cacert(java.lang.String)
//  .https(java.lang.Boolean)
//  .insecure(java.lang.Boolean)
//  .password(java.lang.String)
//  .port(java.lang.Number)
//  .scriptPath(java.lang.String)
//  .timeout(java.lang.String)
//  .useNtlm(java.lang.Boolean)
//  .user(java.lang.String)
    .build();

Properties

Name	Type	Description
host	java.lang.String	The address of the resource to connect to.
type	java.lang.String	The connection type.
cacert	java.lang.String	The CA certificate to validate against.
https	java.lang.Boolean	Set to true to connect using HTTPS instead of HTTP.
insecure	java.lang.Boolean	Set to true to skip validating the HTTPS certificate chain.
password	java.lang.String	The password to use for the connection.
port	java.lang.Number	The port to connect to.
scriptPath	java.lang.String	The path used to copy scripts meant for remote execution.
timeout	java.lang.String	The timeout to wait for the connection to become available.
useNtlm	java.lang.Boolean	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.
user	java.lang.String	The user to use for the connection.

---

host^Required

public java.lang.String getHost();

• Type: java.lang.String

The address of the resource to connect to.

---

type^Required

public java.lang.String getType();

• Type: java.lang.String

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.

---

cacert^Optional

public java.lang.String getCacert();

• Type: java.lang.String

The CA certificate to validate against.

---

https^Optional

public java.lang.Boolean getHttps();

• Type: java.lang.Boolean

Set to true to connect using HTTPS instead of HTTP.

---

insecure^Optional

public java.lang.Boolean getInsecure();

• Type: java.lang.Boolean

Set to true to skip validating the HTTPS certificate chain.

---

password^Optional

public java.lang.String getPassword();

• Type: java.lang.String

The password to use for the connection.

---

port^Optional

public java.lang.Number getPort();

• Type: java.lang.Number
• Default: 22

The port to connect to.

---

scriptPath^Optional

public java.lang.String getScriptPath();

• Type: java.lang.String

The path used to copy scripts meant for remote execution.

Refer to How Provisioners Execute Remote Scripts below for more details

---

timeout^Optional

public java.lang.String getTimeout();

• Type: java.lang.String
• Default: 5m

The timeout to wait for the connection to become available.

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

---

useNtlm^Optional

public java.lang.Boolean getUseNtlm();

• Type: java.lang.Boolean

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.

---

user^Optional

public java.lang.String getUser();

• Type: java.lang.String
• Default: root

The user to use for the connection.

---