CSharp: 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

using Io.Cdktn;

new SSHProvisionerConnection {
    string Host,
    string Type,
    string Agent = null,
    string AgentIdentity = null,
    string BastionCertificate = null,
    string BastionHost = null,
    string BastionHostKey = null,
    string BastionPassword = null,
    double BastionPort = null,
    string BastionPrivateKey = null,
    string BastionUser = null,
    string Certificate = null,
    string HostKey = null,
    string Password = null,
    double Port = null,
    string PrivateKey = null,
    string ProxyHost = null,
    double ProxyPort = null,
    string ProxyScheme = null,
    string ProxyUserName = null,
    string ProxyUserPassword = null,
    string ScriptPath = null,
    string TargetPlatform = null,
    string Timeout = null,
    string User = null
};

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`	`double`	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`	`double`	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`	`double`	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 string Host { get; set; }

Type: string

The address of the resource to connect to.

`Type`^Required

public string Type { get; set; }

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 string Agent { get; set; }

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 string AgentIdentity { get; set; }

Type: string

The preferred identity from the ssh agent for authentication.

`BastionCertificate`^Optional

public string BastionCertificate { get; set; }

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 string BastionHost { get; set; }

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 string BastionHostKey { get; set; }

Type: string

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

`BastionPassword`^Optional

public string BastionPassword { get; set; }

Type: string

The password to use for the bastion host.

`BastionPort`^Optional

public double BastionPort { get; set; }

Type: double

The port to use connect to the bastion host.

`BastionPrivateKey`^Optional

public string BastionPrivateKey { get; set; }

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 string BastionUser { get; set; }

Type: string

The user for the connection to the bastion host.

`Certificate`^Optional

public string Certificate { get; set; }

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 string HostKey { get; set; }

Type: string

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

`Password`^Optional

public string Password { get; set; }

Type: string

The password to use for the connection.

`Port`^Optional

public double Port { get; set; }

Type: double
Default: 22

The port to connect to.

`PrivateKey`^Optional

public string PrivateKey { get; set; }

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 string ProxyHost { get; set; }

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 double ProxyPort { get; set; }

Type: double

The port to use connect to the proxy host.

`ProxyScheme`^Optional

public string ProxyScheme { get; set; }

Type: string

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

`ProxyUserName`^Optional

public string ProxyUserName { get; set; }

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 string ProxyUserPassword { get; set; }

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 string ScriptPath { get; set; }

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 string TargetPlatform { get; set; }

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 string Timeout { get; set; }

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 string User { get; set; }

Type: 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