Package com.hashicorp.cdktf

Class SSHProvisionerConnection.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

com.hashicorp.cdktf.SSHProvisionerConnection.Jsii$Proxy

All Implemented Interfaces:

SSHProvisionerConnection, software.amazon.jsii.JsiiSerializable

Enclosing interface:

SSHProvisionerConnection

@Stability(Experimental)
@Internal
public static final class SSHProvisionerConnection.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements SSHProvisionerConnection

An implementation for SSHProvisionerConnection

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface com.hashicorp.cdktf.SSHProvisionerConnection

SSHProvisionerConnection.Builder, SSHProvisionerConnection.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(SSHProvisionerConnection.Builder builder)	Constructor that initializes the object based on literal property values passed by the SSHProvisionerConnection.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
final boolean	equals(Object o)
final String	getAgent()	(experimental) Set to false to disable using ssh-agent to authenticate.
final String	getAgentIdentity()	(experimental) The preferred identity from the ssh agent for authentication.
final String	getBastionCertificate()	(experimental) The contents of a signed CA Certificate.
final String	getBastionHost()	(experimental) Setting this enables the bastion Host connection.
final String	getBastionHostKey()	(experimental) The public key from the remote host or the signing CA, used to verify the host connection.
final String	getBastionPassword()	(experimental) The password to use for the bastion host.
final Number	getBastionPort()	(experimental) The port to use connect to the bastion host.
final String	getBastionPrivateKey()	(experimental) The contents of an SSH key file to use for the bastion host.
final String	getBastionUser()	(experimental) The user for the connection to the bastion host.
final String	getCertificate()	(experimental) The contents of a signed CA Certificate.
final String	getHost()	(experimental) The address of the resource to connect to.
final String	getHostKey()	(experimental) The public key from the remote host or the signing CA, used to verify the connection.
final String	getPassword()	(experimental) The password to use for the connection.
final Number	getPort()	(experimental) The port to connect to.
final String	getPrivateKey()	(experimental) The contents of an SSH key to use for the connection.
final String	getProxyHost()	(experimental) Setting this enables the SSH over HTTP connection.
final Number	getProxyPort()	(experimental) The port to use connect to the proxy host.
final String	getProxyScheme()	(experimental) The ssh connection also supports the following fields to facilitate connections by SSH over HTTP proxy.
final String	getProxyUserName()	(experimental) The username to use connect to the private proxy host.
final String	getProxyUserPassword()	(experimental) The password to use connect to the private proxy host.
final String	getScriptPath()	(experimental) The path used to copy scripts meant for remote execution.
final String	getTargetPlatform()	(experimental) The target platform to connect to.
final String	getTimeout()	(experimental) The timeout to wait for the connection to become available.
final String	getType()	(experimental) The connection type.
final String	getUser()	(experimental) The user to use for the connection.
final int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Details

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(SSHProvisionerConnection.Builder builder)

Constructor that initializes the object based on literal property values passed by the SSHProvisionerConnection.Builder.

Method Details

getHost

public final String getHost()

Description copied from interface: SSHProvisionerConnection

(experimental) The address of the resource to connect to.

Specified by:

getHost in interface SSHProvisionerConnection

getType

public final String getType()

Description copied from interface: SSHProvisionerConnection

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

Specified by:

getType in interface SSHProvisionerConnection

getAgent

public final String getAgent()

Description copied from interface: SSHProvisionerConnection

(experimental) Set to false to disable using ssh-agent to authenticate.

On Windows the only supported SSH authentication agent is Pageant.

Specified by:

getAgent in interface SSHProvisionerConnection

getAgentIdentity

public final String getAgentIdentity()

Description copied from interface: SSHProvisionerConnection

(experimental) The preferred identity from the ssh agent for authentication.

Specified by:

getAgentIdentity in interface SSHProvisionerConnection

getBastionCertificate

public final String getBastionCertificate()

Description copied from interface: SSHProvisionerConnection

(experimental) 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.

Specified by:

getBastionCertificate in interface SSHProvisionerConnection

getBastionHost

public final String getBastionHost()

Description copied from interface: SSHProvisionerConnection

(experimental) Setting this enables the bastion Host connection.

The provisioner will connect to bastion_host first, and then connect from there to host.

Specified by:

getBastionHost in interface SSHProvisionerConnection

getBastionHostKey

public final String getBastionHostKey()

Description copied from interface: SSHProvisionerConnection

(experimental) The public key from the remote host or the signing CA, used to verify the host connection.

Specified by:

getBastionHostKey in interface SSHProvisionerConnection

getBastionPassword

public final String getBastionPassword()

Description copied from interface: SSHProvisionerConnection

(experimental) The password to use for the bastion host.

Specified by:

getBastionPassword in interface SSHProvisionerConnection

getBastionPort

public final Number getBastionPort()

Description copied from interface: SSHProvisionerConnection

(experimental) The port to use connect to the bastion host.

Specified by:

getBastionPort in interface SSHProvisionerConnection

getBastionPrivateKey

public final String getBastionPrivateKey()

Description copied from interface: SSHProvisionerConnection

(experimental) 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.

Specified by:

getBastionPrivateKey in interface SSHProvisionerConnection

getBastionUser

public final String getBastionUser()

Description copied from interface: SSHProvisionerConnection

(experimental) The user for the connection to the bastion host.

Specified by:

getBastionUser in interface SSHProvisionerConnection

getCertificate

public final String getCertificate()

Description copied from interface: SSHProvisionerConnection

(experimental) 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.

Specified by:

getCertificate in interface SSHProvisionerConnection

getHostKey

public final String getHostKey()

Description copied from interface: SSHProvisionerConnection

(experimental) The public key from the remote host or the signing CA, used to verify the connection.

Specified by:

getHostKey in interface SSHProvisionerConnection

getPassword

public final String getPassword()

Description copied from interface: SSHProvisionerConnection

(experimental) The password to use for the connection.

Specified by:

getPassword in interface SSHProvisionerConnection

getPort

public final Number getPort()

Description copied from interface: SSHProvisionerConnection

(experimental) The port to connect to.

Default: 22

Specified by:

getPort in interface SSHProvisionerConnection

getPrivateKey

public final String getPrivateKey()

Description copied from interface: SSHProvisionerConnection

(experimental) 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.

Specified by:

getPrivateKey in interface SSHProvisionerConnection

getProxyHost

public final String getProxyHost()

Description copied from interface: SSHProvisionerConnection

(experimental) 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.

Specified by:

getProxyHost in interface SSHProvisionerConnection

getProxyPort

public final Number getProxyPort()

Description copied from interface: SSHProvisionerConnection

(experimental) The port to use connect to the proxy host.

Specified by:

getProxyPort in interface SSHProvisionerConnection

getProxyScheme

public final String getProxyScheme()

Description copied from interface: SSHProvisionerConnection

(experimental) The ssh connection also supports the following fields to facilitate connections by SSH over HTTP proxy.

Specified by:

getProxyScheme in interface SSHProvisionerConnection

getProxyUserName

public final String getProxyUserName()

Description copied from interface: SSHProvisionerConnection

(experimental) 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.

Specified by:

getProxyUserName in interface SSHProvisionerConnection

getProxyUserPassword

public final String getProxyUserPassword()

Description copied from interface: SSHProvisionerConnection

(experimental) 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.

Specified by:

getProxyUserPassword in interface SSHProvisionerConnection

getScriptPath

public final String getScriptPath()

Description copied from interface: SSHProvisionerConnection

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

Specified by:

getScriptPath in interface SSHProvisionerConnection

getTargetPlatform

public final String getTargetPlatform()

Description copied from interface: SSHProvisionerConnection

(experimental) 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"

Default: unix

Specified by:

getTargetPlatform in interface SSHProvisionerConnection

getTimeout

public final String getTimeout()

Description copied from interface: SSHProvisionerConnection

(experimental) The timeout to wait for the connection to become available.

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

Default: 5m

Specified by:

getTimeout in interface SSHProvisionerConnection

getUser

public final String getUser()

Description copied from interface: SSHProvisionerConnection

(experimental) The user to use for the connection.

Default: root

Specified by:

getUser in interface SSHProvisionerConnection

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object