Package com.hashicorp.cdktf

Class SSHProvisionerConnection.Builder

java.lang.Object

com.hashicorp.cdktf.SSHProvisionerConnection.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SSHProvisionerConnection>

Enclosing interface:

SSHProvisionerConnection

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

A builder for SSHProvisionerConnection

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SSHProvisionerConnection.Builder	agent(String agent)	Sets the value of SSHProvisionerConnection.getAgent()
SSHProvisionerConnection.Builder	agentIdentity(String agentIdentity)	Sets the value of SSHProvisionerConnection.getAgentIdentity()
SSHProvisionerConnection.Builder	bastionCertificate(String bastionCertificate)	Sets the value of SSHProvisionerConnection.getBastionCertificate()
SSHProvisionerConnection.Builder	bastionHost(String bastionHost)	Sets the value of SSHProvisionerConnection.getBastionHost()
SSHProvisionerConnection.Builder	bastionHostKey(String bastionHostKey)	Sets the value of SSHProvisionerConnection.getBastionHostKey()
SSHProvisionerConnection.Builder	bastionPassword(String bastionPassword)	Sets the value of SSHProvisionerConnection.getBastionPassword()
SSHProvisionerConnection.Builder	bastionPort(Number bastionPort)	Sets the value of SSHProvisionerConnection.getBastionPort()
SSHProvisionerConnection.Builder	bastionPrivateKey(String bastionPrivateKey)	Sets the value of SSHProvisionerConnection.getBastionPrivateKey()
SSHProvisionerConnection.Builder	bastionUser(String bastionUser)	Sets the value of SSHProvisionerConnection.getBastionUser()
SSHProvisionerConnection	build()	Builds the configured instance.
SSHProvisionerConnection.Builder	certificate(String certificate)	Sets the value of SSHProvisionerConnection.getCertificate()
SSHProvisionerConnection.Builder	host(String host)	Sets the value of SSHProvisionerConnection.getHost()
SSHProvisionerConnection.Builder	hostKey(String hostKey)	Sets the value of SSHProvisionerConnection.getHostKey()
SSHProvisionerConnection.Builder	password(String password)	Sets the value of SSHProvisionerConnection.getPassword()
SSHProvisionerConnection.Builder	port(Number port)	Sets the value of SSHProvisionerConnection.getPort()
SSHProvisionerConnection.Builder	privateKey(String privateKey)	Sets the value of SSHProvisionerConnection.getPrivateKey()
SSHProvisionerConnection.Builder	proxyHost(String proxyHost)	Sets the value of SSHProvisionerConnection.getProxyHost()
SSHProvisionerConnection.Builder	proxyPort(Number proxyPort)	Sets the value of SSHProvisionerConnection.getProxyPort()
SSHProvisionerConnection.Builder	proxyScheme(String proxyScheme)	Sets the value of SSHProvisionerConnection.getProxyScheme()
SSHProvisionerConnection.Builder	proxyUserName(String proxyUserName)	Sets the value of SSHProvisionerConnection.getProxyUserName()
SSHProvisionerConnection.Builder	proxyUserPassword(String proxyUserPassword)	Sets the value of SSHProvisionerConnection.getProxyUserPassword()
SSHProvisionerConnection.Builder	scriptPath(String scriptPath)	Sets the value of SSHProvisionerConnection.getScriptPath()
SSHProvisionerConnection.Builder	targetPlatform(String targetPlatform)	Sets the value of SSHProvisionerConnection.getTargetPlatform()
SSHProvisionerConnection.Builder	timeout(String timeout)	Sets the value of SSHProvisionerConnection.getTimeout()
SSHProvisionerConnection.Builder	type(String type)	Sets the value of SSHProvisionerConnection.getType()
SSHProvisionerConnection.Builder	user(String user)	Sets the value of SSHProvisionerConnection.getUser()

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

host

@Stability(Experimental)
public SSHProvisionerConnection.Builder host(String host)

Sets the value of SSHProvisionerConnection.getHost()

Parameters:

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

Returns:

this

type

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

Sets the value of SSHProvisionerConnection.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

agent

@Stability(Experimental)
public SSHProvisionerConnection.Builder agent(String agent)

Sets the value of SSHProvisionerConnection.getAgent()

Parameters:

agent - Set to false to disable using ssh-agent to authenticate. On Windows the only supported SSH authentication agent is Pageant.

Returns:

this

agentIdentity

@Stability(Experimental)
public SSHProvisionerConnection.Builder agentIdentity(String agentIdentity)

Sets the value of SSHProvisionerConnection.getAgentIdentity()

Parameters:

agentIdentity - The preferred identity from the ssh agent for authentication.

Returns:

this

bastionCertificate

@Stability(Experimental)
public SSHProvisionerConnection.Builder bastionCertificate(String bastionCertificate)

Sets the value of SSHProvisionerConnection.getBastionCertificate()

Parameters:

bastionCertificate - The contents of a signed CA Certificate. The certificate argument must be used in conjunction with a bastion_private_key. These can be loaded from a file on disk using the the file function.

Returns:

this

bastionHost

@Stability(Experimental)
public SSHProvisionerConnection.Builder bastionHost(String bastionHost)

Sets the value of SSHProvisionerConnection.getBastionHost()

Parameters:

bastionHost - Setting this enables the bastion Host connection. The provisioner will connect to bastion_host first, and then connect from there to host.

Returns:

this

bastionHostKey

@Stability(Experimental)
public SSHProvisionerConnection.Builder bastionHostKey(String bastionHostKey)

Sets the value of SSHProvisionerConnection.getBastionHostKey()

Parameters:

bastionHostKey - The public key from the remote host or the signing CA, used to verify the host connection.

Returns:

this

bastionPassword

@Stability(Experimental)
public SSHProvisionerConnection.Builder bastionPassword(String bastionPassword)

Sets the value of SSHProvisionerConnection.getBastionPassword()

Parameters:

bastionPassword - The password to use for the bastion host.

Returns:

this

bastionPort

@Stability(Experimental)
public SSHProvisionerConnection.Builder bastionPort(Number bastionPort)

Sets the value of SSHProvisionerConnection.getBastionPort()

Parameters:

bastionPort - The port to use connect to the bastion host.

Returns:

this

bastionPrivateKey

@Stability(Experimental)
public SSHProvisionerConnection.Builder bastionPrivateKey(String bastionPrivateKey)

Sets the value of SSHProvisionerConnection.getBastionPrivateKey()

Parameters:

bastionPrivateKey - The contents of an SSH key file to use for the bastion host. These can be loaded from a file on disk using the file function.

Returns:

this

bastionUser

@Stability(Experimental)
public SSHProvisionerConnection.Builder bastionUser(String bastionUser)

Sets the value of SSHProvisionerConnection.getBastionUser()

Parameters:

bastionUser - The user for the connection to the bastion host.

Returns:

this

certificate

@Stability(Experimental)
public SSHProvisionerConnection.Builder certificate(String certificate)

Sets the value of SSHProvisionerConnection.getCertificate()

Parameters:

certificate - The contents of a signed CA Certificate. The certificate argument must be used in conjunction with a private_key. These can be loaded from a file on disk using the the file function.

Returns:

this

hostKey

@Stability(Experimental)
public SSHProvisionerConnection.Builder hostKey(String hostKey)

Sets the value of SSHProvisionerConnection.getHostKey()

Parameters:

hostKey - The public key from the remote host or the signing CA, used to verify the connection.

Returns:

this

password

@Stability(Experimental)
public SSHProvisionerConnection.Builder password(String password)

Sets the value of SSHProvisionerConnection.getPassword()

Parameters:

password - The password to use for the connection.

Returns:

this

port

@Stability(Experimental)
public SSHProvisionerConnection.Builder port(Number port)

Sets the value of SSHProvisionerConnection.getPort()

Parameters:

port - The port to connect to.

Returns:

this

privateKey

@Stability(Experimental)
public SSHProvisionerConnection.Builder privateKey(String privateKey)

Sets the value of SSHProvisionerConnection.getPrivateKey()

Parameters:

privateKey - The contents of an SSH key to use for the connection. These can be loaded from a file on disk using the file function. This takes preference over password if provided.

Returns:

this

proxyHost

@Stability(Experimental)
public SSHProvisionerConnection.Builder proxyHost(String proxyHost)

Sets the value of SSHProvisionerConnection.getProxyHost()

Parameters:

proxyHost - Setting this enables the SSH over HTTP connection. This host will be connected to first, and then the host or bastion_host connection will be made from there.

Returns:

this

proxyPort

@Stability(Experimental)
public SSHProvisionerConnection.Builder proxyPort(Number proxyPort)

Sets the value of SSHProvisionerConnection.getProxyPort()

Parameters:

proxyPort - The port to use connect to the proxy host.

Returns:

this

proxyScheme

@Stability(Experimental)
public SSHProvisionerConnection.Builder proxyScheme(String proxyScheme)

Sets the value of SSHProvisionerConnection.getProxyScheme()

Parameters:

proxyScheme - The ssh connection also supports the following fields to facilitate connections by SSH over HTTP proxy.

Returns:

this

proxyUserName

@Stability(Experimental)
public SSHProvisionerConnection.Builder proxyUserName(String proxyUserName)

Sets the value of SSHProvisionerConnection.getProxyUserName()

Parameters:

proxyUserName - The username to use connect to the private proxy host. This argument should be specified only if authentication is required for the HTTP Proxy server.

Returns:

this

proxyUserPassword

@Stability(Experimental)
public SSHProvisionerConnection.Builder proxyUserPassword(String proxyUserPassword)

Sets the value of SSHProvisionerConnection.getProxyUserPassword()

Parameters:

proxyUserPassword - The password to use connect to the private proxy host. This argument should be specified only if authentication is required for the HTTP Proxy server.

Returns:

this

scriptPath

@Stability(Experimental)
public SSHProvisionerConnection.Builder scriptPath(String scriptPath)

Sets the value of SSHProvisionerConnection.getScriptPath()

Parameters:

scriptPath - 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}

Returns:

this

targetPlatform

@Stability(Experimental)
public SSHProvisionerConnection.Builder targetPlatform(String targetPlatform)

Sets the value of SSHProvisionerConnection.getTargetPlatform()

Parameters:

targetPlatform - The target platform to connect to. Valid values are "windows" and "unix". If the platform is set to windows, the default script_path is c:\windows\temp\terraform_%RAND%.cmd, assuming the SSH default shell is cmd.exe. If the SSH default shell is PowerShell, set script_path to "c:/windows/temp/terraform_%RAND%.ps1"

Returns:

this

timeout

@Stability(Experimental)
public SSHProvisionerConnection.Builder timeout(String timeout)

Sets the value of SSHProvisionerConnection.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

user

@Stability(Experimental)
public SSHProvisionerConnection.Builder user(String user)

Sets the value of SSHProvisionerConnection.getUser()

Parameters:

user - The user to use for the connection.

Returns:

this

build

@Stability(Experimental)
public SSHProvisionerConnection build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SSHProvisionerConnection

Throws:

NullPointerException - if any required attribute was not provided