ISSHProvisionerConnection.Jsii$Default (com.hashicorp:cdktf 0.13.0-pre.7 API)

All Superinterfaces:

ISSHProvisionerConnection, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

ISSHProvisionerConnection.Jsii$Proxy

Enclosing interface:

ISSHProvisionerConnection
```
@Internal
public static interface ISSHProvisionerConnection.Jsii$Default
extends ISSHProvisionerConnection
```
Internal default implementation for ISSHProvisionerConnection.

Nested Class Summary
- Nested classes/interfaces inherited from interface com.hashicorp.cdktf.ISSHProvisionerConnection
  ISSHProvisionerConnection.Jsii$Default, ISSHProvisionerConnection.Jsii$Proxy

Method Summary

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Method Detail
  - getHost
```
@Stability(value=Experimental)
 @NotNull
default String getHost()
```
    (experimental) The address of the resource to connect to.
    
    Specified by:
    
    getHost in interface ISSHProvisionerConnection
  - getType
```
@Stability(value=Experimental)
 @NotNull
default String getType()
```
    (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 ISSHProvisionerConnection
  - getAgent
```
@Stability(value=Experimental)
 @Nullable
default String getAgent()
```
    (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 ISSHProvisionerConnection
  - getAgentIdentity
```
@Stability(value=Experimental)
 @Nullable
default String getAgentIdentity()
```
    (experimental) The preferred identity from the ssh agent for authentication.
    
    Specified by:
    
    getAgentIdentity in interface ISSHProvisionerConnection
  - getBastionCertificate
```
@Stability(value=Experimental)
 @Nullable
default String getBastionCertificate()
```
    (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 ISSHProvisionerConnection
  - getBastionHost
```
@Stability(value=Experimental)
 @Nullable
default String getBastionHost()
```
    (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 ISSHProvisionerConnection
  - getBastionHostKey
```
@Stability(value=Experimental)
 @Nullable
default String getBastionHostKey()
```
    (experimental) The public key from the remote host or the signing CA, used to verify the host connection.
    
    Specified by:
    
    getBastionHostKey in interface ISSHProvisionerConnection
  - getBastionPassword
```
@Stability(value=Experimental)
 @Nullable
default String getBastionPassword()
```
    (experimental) The password to use for the bastion host.
    
    Specified by:
    
    getBastionPassword in interface ISSHProvisionerConnection
  - getBastionPort
```
@Stability(value=Experimental)
 @Nullable
default Number getBastionPort()
```
    (experimental) The port to use connect to the bastion host.
    
    Specified by:
    
    getBastionPort in interface ISSHProvisionerConnection
  - getBastionPrivateKey
```
@Stability(value=Experimental)
 @Nullable
default String getBastionPrivateKey()
```
    (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 ISSHProvisionerConnection
  - getBastionUser
```
@Stability(value=Experimental)
 @Nullable
default String getBastionUser()
```
    (experimental) The user for the connection to the bastion host.
    
    Specified by:
    
    getBastionUser in interface ISSHProvisionerConnection
  - getCertificate
```
@Stability(value=Experimental)
 @Nullable
default String getCertificate()
```
    (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 ISSHProvisionerConnection
  - getHostKey
```
@Stability(value=Experimental)
 @Nullable
default String getHostKey()
```
    (experimental) The public key from the remote host or the signing CA, used to verify the connection.
    
    Specified by:
    
    getHostKey in interface ISSHProvisionerConnection
  - getPassword
```
@Stability(value=Experimental)
 @Nullable
default String getPassword()
```
    (experimental) The password to use for the connection.
    
    Specified by:
    
    getPassword in interface ISSHProvisionerConnection
  - getPort
```
@Stability(value=Experimental)
 @Nullable
default Number getPort()
```
    (experimental) The port to connect to.
    Default: 22
    
    Specified by:
    
    getPort in interface ISSHProvisionerConnection
  - getPrivateKey
```
@Stability(value=Experimental)
 @Nullable
default String getPrivateKey()
```
    (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 ISSHProvisionerConnection
  - getProxyHost
```
@Stability(value=Experimental)
 @Nullable
default String getProxyHost()
```
    (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 ISSHProvisionerConnection
  - getProxyPort
```
@Stability(value=Experimental)
 @Nullable
default Number getProxyPort()
```
    (experimental) The port to use connect to the proxy host.
    
    Specified by:
    
    getProxyPort in interface ISSHProvisionerConnection
  - getProxyScheme
```
@Stability(value=Experimental)
 @Nullable
default String getProxyScheme()
```
    (experimental) The ssh connection also supports the following fields to facilitate connections by SSH over HTTP proxy.
    
    Specified by:
    
    getProxyScheme in interface ISSHProvisionerConnection
  - getProxyUserName
```
@Stability(value=Experimental)
 @Nullable
default String getProxyUserName()
```
    (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 ISSHProvisionerConnection
  - getProxyUserPassword
```
@Stability(value=Experimental)
 @Nullable
default String getProxyUserPassword()
```
    (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 ISSHProvisionerConnection
  - getScriptPath
```
@Stability(value=Experimental)
 @Nullable
default String getScriptPath()
```
    (experimental) 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}
    
    Specified by:
    
    getScriptPath in interface ISSHProvisionerConnection
  - getTargetPlatform
```
@Stability(value=Experimental)
 @Nullable
default String getTargetPlatform()
```
    (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 ISSHProvisionerConnection
  - getTimeout
```
@Stability(value=Experimental)
 @Nullable
default String getTimeout()
```
    (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 ISSHProvisionerConnection
  - getUser
```
@Stability(value=Experimental)
 @Nullable
default String getUser()
```
    (experimental) The user to use for the connection.
    Default: root
    
    Specified by:
    
    getUser in interface ISSHProvisionerConnection

Interface ISSHProvisionerConnection.Jsii$Default

Nested Class Summary

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

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Detail

getHost

getType

getAgent

getAgentIdentity

getBastionCertificate

getBastionHost

getBastionHostKey

getBastionPassword

getBastionPort

getBastionPrivateKey

getBastionUser

getCertificate

getHostKey

getPassword

getPort

getPrivateKey

getProxyHost

getProxyPort

getProxyScheme

getProxyUserName

getProxyUserPassword

getScriptPath

getTargetPlatform

getTimeout

getUser