Typescript: SSHProvisionerConnection

CDKTN Core API Reference for SSHProvisionerConnection in Typescript.

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 { SSHProvisionerConnection } from 'cdktn'

const sSHProvisionerConnection: SSHProvisionerConnection = { ... }

Properties

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

---

host^Required

public readonly host: string;

• Type: string

The address of the resource to connect to.

---

type^Required

public readonly type: string;

• Type: 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 readonly agent: string;

• Type: string

Set to false to disable using ssh-agent to authenticate.

On Windows the only supported SSH authentication agent is Pageant.

---

agentIdentity^Optional

public readonly agentIdentity: string;

• Type: string

The preferred identity from the ssh agent for authentication.

---

bastionCertificate^Optional

public readonly bastionCertificate: string;

• Type: 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 readonly bastionHost: string;

• Type: 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 readonly bastionHostKey: string;

• Type: string

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

---

bastionPassword^Optional

public readonly bastionPassword: string;

• Type: string

The password to use for the bastion host.

---

bastionPort^Optional

public readonly bastionPort: number;

• Type: number

The port to use connect to the bastion host.

---

bastionPrivateKey^Optional

public readonly bastionPrivateKey: string;

• Type: 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 readonly bastionUser: string;

• Type: string

The user for the connection to the bastion host.

---

certificate^Optional

public readonly certificate: string;

• Type: 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 readonly hostKey: string;

• Type: string

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

---

password^Optional

public readonly password: string;

• Type: string

The password to use for the connection.

---

port^Optional

public readonly port: number;

• Type: number
• Default: 22

The port to connect to.

---

privateKey^Optional

public readonly privateKey: string;

• Type: 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 readonly proxyHost: string;

• Type: 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 readonly proxyPort: number;

• Type: number

The port to use connect to the proxy host.

---

proxyScheme^Optional

public readonly proxyScheme: string;

• Type: string

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

---

proxyUserName^Optional

public readonly proxyUserName: string;

• Type: 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 readonly proxyUserPassword: string;

• Type: 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 readonly scriptPath: string;

• Type: 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 readonly targetPlatform: string;

• Type: 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 readonly timeout: string;

• Type: 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 readonly user: string;

• Type: string
• Default: root

The user to use for the connection.

---