com.hashicorp.cdktf

Class WinrmProvisionerConnection.Builder

java.lang.Object

com.hashicorp.cdktf.WinrmProvisionerConnection.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<WinrmProvisionerConnection>

Enclosing interface:

WinrmProvisionerConnection

@Stability(value=Experimental)
public static final class WinrmProvisionerConnection.Builder
extends Object
implements software.amazon.jsii.Builder<WinrmProvisionerConnection>

A builder for WinrmProvisionerConnection

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
WinrmProvisionerConnection	build() Builds the configured instance.
WinrmProvisionerConnection.Builder	cacert(String cacert) Sets the value of WinrmProvisionerConnection.getCacert()
WinrmProvisionerConnection.Builder	host(String host) Sets the value of WinrmProvisionerConnection.getHost()
WinrmProvisionerConnection.Builder	https(Boolean https) Sets the value of WinrmProvisionerConnection.getHttps()
WinrmProvisionerConnection.Builder	insecure(Boolean insecure) Sets the value of WinrmProvisionerConnection.getInsecure()
WinrmProvisionerConnection.Builder	password(String password) Sets the value of WinrmProvisionerConnection.getPassword()
WinrmProvisionerConnection.Builder	port(Number port) Sets the value of WinrmProvisionerConnection.getPort()
WinrmProvisionerConnection.Builder	scriptPath(String scriptPath) Sets the value of WinrmProvisionerConnection.getScriptPath()
WinrmProvisionerConnection.Builder	timeout(String timeout) Sets the value of WinrmProvisionerConnection.getTimeout()
WinrmProvisionerConnection.Builder	type(String type) Sets the value of WinrmProvisionerConnection.getType()
WinrmProvisionerConnection.Builder	useNtlm(Boolean useNtlm) Sets the value of WinrmProvisionerConnection.getUseNtlm()
WinrmProvisionerConnection.Builder	user(String user) Sets the value of WinrmProvisionerConnection.getUser()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

host

@Stability(value=Experimental)
public WinrmProvisionerConnection.Builder host(String host)

Sets the value of WinrmProvisionerConnection.getHost()

Parameters:

host - The address of the resource to connect to. This parameter is required.

Returns:

this

type

@Stability(value=Experimental)
public WinrmProvisionerConnection.Builder type(String type)

Sets the value of WinrmProvisionerConnection.getType()

Parameters:

type - The connection type. This parameter is required. 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.

Returns:

this

cacert

@Stability(value=Experimental)
public WinrmProvisionerConnection.Builder cacert(String cacert)

Sets the value of WinrmProvisionerConnection.getCacert()

Parameters:

cacert - The CA certificate to validate against.

Returns:

this

https

@Stability(value=Experimental)
public WinrmProvisionerConnection.Builder https(Boolean https)

Sets the value of WinrmProvisionerConnection.getHttps()

Parameters:

https - Set to true to connect using HTTPS instead of HTTP.

Returns:

this

insecure

@Stability(value=Experimental)
public WinrmProvisionerConnection.Builder insecure(Boolean insecure)

Sets the value of WinrmProvisionerConnection.getInsecure()

Parameters:

insecure - Set to true to skip validating the HTTPS certificate chain.

Returns:

this

password

@Stability(value=Experimental)
public WinrmProvisionerConnection.Builder password(String password)

Sets the value of WinrmProvisionerConnection.getPassword()

Parameters:

password - The password to use for the connection.

Returns:

this

port

@Stability(value=Experimental)
public WinrmProvisionerConnection.Builder port(Number port)

Sets the value of WinrmProvisionerConnection.getPort()

Parameters:

port - The port to connect to.

Returns:

this

scriptPath

@Stability(value=Experimental)
public WinrmProvisionerConnection.Builder scriptPath(String scriptPath)

Sets the value of WinrmProvisionerConnection.getScriptPath()

Parameters:

scriptPath - The path used to copy scripts meant for remote execution. Refer to {@link https://www.terraform.io/language/resources/provisioners/connection#how-provisioners-execute-remote-scripts How Provisioners Execute Remote Scripts below for more details}

Returns:

this

timeout

@Stability(value=Experimental)
public WinrmProvisionerConnection.Builder timeout(String timeout)

Sets the value of WinrmProvisionerConnection.getTimeout()

Parameters:

timeout - The timeout to wait for the connection to become available. Should be provided as a string (e.g., "30s" or "5m".)

Returns:

this

useNtlm

@Stability(value=Experimental)
public WinrmProvisionerConnection.Builder useNtlm(Boolean useNtlm)

Sets the value of WinrmProvisionerConnection.getUseNtlm()

Parameters:

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

Returns:

this

user

@Stability(value=Experimental)
public WinrmProvisionerConnection.Builder user(String user)

Sets the value of WinrmProvisionerConnection.getUser()

Parameters:

user - The user to use for the connection.

Returns:

this

build

@Stability(value=Experimental)
public WinrmProvisionerConnection build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<WinrmProvisionerConnection>

Returns:

a new instance of WinrmProvisionerConnection

Throws:

NullPointerException - if any required attribute was not provided