Package com.hashicorp.cdktf

Class RemoteExecProvisioner.Builder

java.lang.Object

com.hashicorp.cdktf.RemoteExecProvisioner.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<RemoteExecProvisioner>

Enclosing interface:

RemoteExecProvisioner

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

A builder for RemoteExecProvisioner

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
RemoteExecProvisioner	build()	Builds the configured instance.
RemoteExecProvisioner.Builder	connection(SSHProvisionerConnection connection)	Sets the value of RemoteExecProvisioner.getConnection()
RemoteExecProvisioner.Builder	connection(WinrmProvisionerConnection connection)	Sets the value of RemoteExecProvisioner.getConnection()
RemoteExecProvisioner.Builder	inline(List<String> inline)	Sets the value of RemoteExecProvisioner.getInline()
RemoteExecProvisioner.Builder	script(String script)	Sets the value of RemoteExecProvisioner.getScript()
RemoteExecProvisioner.Builder	scripts(List<String> scripts)	Sets the value of RemoteExecProvisioner.getScripts()
RemoteExecProvisioner.Builder	type(String type)	Sets the value of RemoteExecProvisioner.getType()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

type

@Stability(Experimental)
public RemoteExecProvisioner.Builder type(String type)

Sets the value of RemoteExecProvisioner.getType()

Parameters:

type - the value to be set. This parameter is required.

Returns:

this

connection

@Stability(Experimental)
public RemoteExecProvisioner.Builder connection(SSHProvisionerConnection connection)

Sets the value of RemoteExecProvisioner.getConnection()

Parameters:

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

Returns:

this

connection

@Stability(Experimental)
public RemoteExecProvisioner.Builder connection(WinrmProvisionerConnection connection)

Sets the value of RemoteExecProvisioner.getConnection()

Parameters:

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

Returns:

this

inline

@Stability(Experimental)
public RemoteExecProvisioner.Builder inline(List<String> inline)

Sets the value of RemoteExecProvisioner.getInline()

Parameters:

inline - This is a list of command strings. They are executed in the order they are provided. This cannot be provided with script or scripts.

Returns:

this

script

@Stability(Experimental)
public RemoteExecProvisioner.Builder script(String script)

Sets the value of RemoteExecProvisioner.getScript()

Parameters:

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

Returns:

this

scripts

@Stability(Experimental)
public RemoteExecProvisioner.Builder scripts(List<String> scripts)

Sets the value of RemoteExecProvisioner.getScripts()

Parameters:

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

Returns:

this

build

@Stability(Experimental)
public RemoteExecProvisioner build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of RemoteExecProvisioner

Throws:

NullPointerException - if any required attribute was not provided