Java: SSHProvisionerConnection

Most provisioners require access to the remote resource via SSH or WinRM and expect a nested connection block with details about how to connect. Refer to connection

Initializer

import io.cdktn.cdktn.SSHProvisionerConnection;

SSHProvisionerConnection.builder()
    .host(java.lang.String)
    .type(java.lang.String)
//  .agent(java.lang.String)
//  .agentIdentity(java.lang.String)
//  .bastionCertificate(java.lang.String)
//  .bastionHost(java.lang.String)
//  .bastionHostKey(java.lang.String)
//  .bastionPassword(java.lang.String)
//  .bastionPort(java.lang.Number)
//  .bastionPrivateKey(java.lang.String)
//  .bastionUser(java.lang.String)
//  .certificate(java.lang.String)
//  .hostKey(java.lang.String)
//  .password(java.lang.String)
//  .port(java.lang.Number)
//  .privateKey(java.lang.String)
//  .proxyHost(java.lang.String)
//  .proxyPort(java.lang.Number)
//  .proxyScheme(java.lang.String)
//  .proxyUserName(java.lang.String)
//  .proxyUserPassword(java.lang.String)
//  .scriptPath(java.lang.String)
//  .targetPlatform(java.lang.String)
//  .timeout(java.lang.String)
//  .user(java.lang.String)
    .build();

Properties

Name	Type	Description
`host`	`java.lang.String`	The address of the resource to connect to.
`type`	`java.lang.String`	The connection type.
`agent`	`java.lang.String`	Set to false to disable using ssh-agent to authenticate.
`agentIdentity`	`java.lang.String`	The preferred identity from the ssh agent for authentication.
`bastionCertificate`	`java.lang.String`	The contents of a signed CA Certificate.
`bastionHost`	`java.lang.String`	Setting this enables the bastion Host connection.
`bastionHostKey`	`java.lang.String`	The public key from the remote host or the signing CA, used to verify the host connection.
`bastionPassword`	`java.lang.String`	The password to use for the bastion host.
`bastionPort`	`java.lang.Number`	The port to use connect to the bastion host.
`bastionPrivateKey`	`java.lang.String`	The contents of an SSH key file to use for the bastion host.
`bastionUser`	`java.lang.String`	The user for the connection to the bastion host.
`certificate`	`java.lang.String`	The contents of a signed CA Certificate.
`hostKey`	`java.lang.String`	The public key from the remote host or the signing CA, used to verify the connection.
`password`	`java.lang.String`	The password to use for the connection.
`port`	`java.lang.Number`	The port to connect to.
`privateKey`	`java.lang.String`	The contents of an SSH key to use for the connection.
`proxyHost`	`java.lang.String`	Setting this enables the SSH over HTTP connection.
`proxyPort`	`java.lang.Number`	The port to use connect to the proxy host.
`proxyScheme`	`java.lang.String`	The ssh connection also supports the following fields to facilitate connections by SSH over HTTP proxy.
`proxyUserName`	`java.lang.String`	The username to use connect to the private proxy host.
`proxyUserPassword`	`java.lang.String`	The password to use connect to the private proxy host.
`scriptPath`	`java.lang.String`	The path used to copy scripts meant for remote execution.
`targetPlatform`	`java.lang.String`	The target platform to connect to.
`timeout`	`java.lang.String`	The timeout to wait for the connection to become available.
`user`	`java.lang.String`	The user to use for the connection.

`host`^Required

public java.lang.String getHost();

Type: java.lang.String

The address of the resource to connect to.

`type`^Required

public java.lang.String getType();

Type: java.lang.String

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.

`agent`^Optional

public java.lang.String getAgent();

Type: java.lang.String

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

`agentIdentity`^Optional

public java.lang.String getAgentIdentity();

Type: java.lang.String

The preferred identity from the ssh agent for authentication.

`bastionCertificate`^Optional

public java.lang.String getBastionCertificate();

Type: java.lang.String

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.

`bastionHost`^Optional

public java.lang.String getBastionHost();

Type: java.lang.String

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

`bastionHostKey`^Optional

public java.lang.String getBastionHostKey();

Type: java.lang.String

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

`bastionPassword`^Optional

public java.lang.String getBastionPassword();

Type: java.lang.String

The password to use for the bastion host.

`bastionPort`^Optional

public java.lang.Number getBastionPort();

Type: java.lang.Number

The port to use connect to the bastion host.

`bastionPrivateKey`^Optional

public java.lang.String getBastionPrivateKey();

Type: java.lang.String

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.

`bastionUser`^Optional

public java.lang.String getBastionUser();

Type: java.lang.String

The user for the connection to the bastion host.

`certificate`^Optional

public java.lang.String getCertificate();

Type: java.lang.String

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.

`hostKey`^Optional

public java.lang.String getHostKey();

Type: java.lang.String

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

`password`^Optional

public java.lang.String getPassword();

Type: java.lang.String

The password to use for the connection.

`port`^Optional

public java.lang.Number getPort();

Type: java.lang.Number
Default: 22

The port to connect to.

`privateKey`^Optional

public java.lang.String getPrivateKey();

Type: java.lang.String

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.

`proxyHost`^Optional

public java.lang.String getProxyHost();

Type: java.lang.String

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.

`proxyPort`^Optional

public java.lang.Number getProxyPort();

Type: java.lang.Number

The port to use connect to the proxy host.

`proxyScheme`^Optional

public java.lang.String getProxyScheme();

Type: java.lang.String

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

`proxyUserName`^Optional

public java.lang.String getProxyUserName();

Type: java.lang.String

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.

`proxyUserPassword`^Optional

public java.lang.String getProxyUserPassword();

Type: java.lang.String

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.

`scriptPath`^Optional

public java.lang.String getScriptPath();

Type: java.lang.String

The path used to copy scripts meant for remote execution. Refer to How Provisioners Execute Remote Scripts below for more details

`targetPlatform`^Optional

public java.lang.String getTargetPlatform();

Type: java.lang.String
Default: unix

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”

`timeout`^Optional

public java.lang.String getTimeout();

Type: java.lang.String
Default: 5m

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

`user`^Optional

public java.lang.String getUser();

Type: java.lang.String
Default: root

The user to use for the connection.

Overview

TypeScript

Python

Java

C#

Go

Initializer

Properties

`host`^Required

`type`^Required

`agent`^Optional

`agentIdentity`^Optional

`bastionCertificate`^Optional

`bastionHost`^Optional

`bastionHostKey`^Optional

`bastionPassword`^Optional

`bastionPort`^Optional

`bastionPrivateKey`^Optional

`bastionUser`^Optional

`certificate`^Optional

`hostKey`^Optional

`password`^Optional

`port`^Optional

`privateKey`^Optional

`proxyHost`^Optional

`proxyPort`^Optional

`proxyScheme`^Optional

`proxyUserName`^Optional

`proxyUserPassword`^Optional

`scriptPath`^Optional

`targetPlatform`^Optional

`timeout`^Optional

`user`^Optional

​Initializer

​Properties

​hostRequired

​typeRequired

​agentOptional

​agentIdentityOptional

​bastionCertificateOptional

​bastionHostOptional

​bastionHostKeyOptional

​bastionPasswordOptional

​bastionPortOptional

​bastionPrivateKeyOptional

​bastionUserOptional

​certificateOptional

​hostKeyOptional

​passwordOptional

​portOptional

​privateKeyOptional

​proxyHostOptional

​proxyPortOptional

​proxySchemeOptional

​proxyUserNameOptional

​proxyUserPasswordOptional

​scriptPathOptional

​targetPlatformOptional

​timeoutOptional

​userOptional

Initializer

Properties

`host`^Required

`type`^Required

`agent`^Optional

`agentIdentity`^Optional

`bastionCertificate`^Optional

`bastionHost`^Optional

`bastionHostKey`^Optional

`bastionPassword`^Optional

`bastionPort`^Optional

`bastionPrivateKey`^Optional

`bastionUser`^Optional

`certificate`^Optional

`hostKey`^Optional

`password`^Optional

`port`^Optional

`privateKey`^Optional

`proxyHost`^Optional

`proxyPort`^Optional

`proxyScheme`^Optional

`proxyUserName`^Optional

`proxyUserPassword`^Optional

`scriptPath`^Optional

`targetPlatform`^Optional

`timeout`^Optional

`user`^Optional