> ## Documentation Index > Fetch the complete documentation index at: https://cdktn.io/docs/llms.txt > Use this file to discover all available pages before exploring further. # Python: SSHProvisionerConnection > CDKTN Core API Reference for SSHProvisionerConnection in Python. 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](https://developer.hashicorp.com/terraform/language/resources/provisioners/connection) ## Initializer ```python theme={null} import cdktn cdktn.SSHProvisionerConnection( host: str, type: str, agent: str = None, agent_identity: str = None, bastion_certificate: str = None, bastion_host: str = None, bastion_host_key: str = None, bastion_password: str = None, bastion_port: typing.Union[int, float] = None, bastion_private_key: str = None, bastion_user: str = None, certificate: str = None, host_key: str = None, password: str = None, port: typing.Union[int, float] = None, private_key: str = None, proxy_host: str = None, proxy_port: typing.Union[int, float] = None, proxy_scheme: str = None, proxy_user_name: str = None, proxy_user_password: str = None, script_path: str = None, target_platform: str = None, timeout: str = None, user: str = None ) ``` ## Properties | **Name** | **Type** | **Description** | | ----------------------------------------------------------------------------------------------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------- | | host | str | The address of the resource to connect to. | | type | str | The connection type. | | agent | str | Set to false to disable using ssh-agent to authenticate. | | agent\_identity | str | The preferred identity from the ssh agent for authentication. | | bastion\_certificate | str | The contents of a signed CA Certificate. | | bastion\_host | str | Setting this enables the bastion Host connection. | | bastion\_host\_key | str | The public key from the remote host or the signing CA, used to verify the host connection. | | bastion\_password | str | The password to use for the bastion host. | | bastion\_port | typing.Union\[int, float] | The port to use connect to the bastion host. | | bastion\_private\_key | str | The contents of an SSH key file to use for the bastion host. | | bastion\_user | str | The user for the connection to the bastion host. | | certificate | str | The contents of a signed CA Certificate. | | host\_key | str | The public key from the remote host or the signing CA, used to verify the connection. | | password | str | The password to use for the connection. | | port | typing.Union\[int, float] | The port to connect to. | | private\_key | str | The contents of an SSH key to use for the connection. | | proxy\_host | str | Setting this enables the SSH over HTTP connection. | | proxy\_port | typing.Union\[int, float] | The port to use connect to the proxy host. | | proxy\_scheme | str | The ssh connection also supports the following fields to facilitate connections by SSH over HTTP proxy. | | proxy\_user\_name | str | The username to use connect to the private proxy host. | | proxy\_user\_password | str | The password to use connect to the private proxy host. | | script\_path | str | The path used to copy scripts meant for remote execution. | | target\_platform | str | The target platform to connect to. | | timeout | str | The timeout to wait for the connection to become available. | | user | str | The user to use for the connection. | *** ### `host`^Required ```python theme={null} host: str ``` * *Type:* str The address of the resource to connect to. *** ### `type`^Required ```python theme={null} type: str ``` * *Type:* str 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 ```python theme={null} agent: str ``` * *Type:* str Set to false to disable using ssh-agent to authenticate. On Windows the only supported SSH authentication agent is Pageant. *** ### `agent_identity`^Optional ```python theme={null} agent_identity: str ``` * *Type:* str The preferred identity from the ssh agent for authentication. *** ### `bastion_certificate`^Optional ```python theme={null} bastion_certificate: str ``` * *Type:* str 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. *** ### `bastion_host`^Optional ```python theme={null} bastion_host: str ``` * *Type:* str Setting this enables the bastion Host connection. The provisioner will connect to bastion\_host first, and then connect from there to host. *** ### `bastion_host_key`^Optional ```python theme={null} bastion_host_key: str ``` * *Type:* str The public key from the remote host or the signing CA, used to verify the host connection. *** ### `bastion_password`^Optional ```python theme={null} bastion_password: str ``` * *Type:* str The password to use for the bastion host. *** ### `bastion_port`^Optional ```python theme={null} bastion_port: typing.Union[int, float] ``` * *Type:* typing.Union\[int, float] The port to use connect to the bastion host. *** ### `bastion_private_key`^Optional ```python theme={null} bastion_private_key: str ``` * *Type:* str 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. *** ### `bastion_user`^Optional ```python theme={null} bastion_user: str ``` * *Type:* str The user for the connection to the bastion host. *** ### `certificate`^Optional ```python theme={null} certificate: str ``` * *Type:* str 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. *** ### `host_key`^Optional ```python theme={null} host_key: str ``` * *Type:* str The public key from the remote host or the signing CA, used to verify the connection. *** ### `password`^Optional ```python theme={null} password: str ``` * *Type:* str The password to use for the connection. *** ### `port`^Optional ```python theme={null} port: typing.Union[int, float] ``` * *Type:* typing.Union\[int, float] * *Default:* 22 The port to connect to. *** ### `private_key`^Optional ```python theme={null} private_key: str ``` * *Type:* str 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. *** ### `proxy_host`^Optional ```python theme={null} proxy_host: str ``` * *Type:* str 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. *** ### `proxy_port`^Optional ```python theme={null} proxy_port: typing.Union[int, float] ``` * *Type:* typing.Union\[int, float] The port to use connect to the proxy host. *** ### `proxy_scheme`^Optional ```python theme={null} proxy_scheme: str ``` * *Type:* str The ssh connection also supports the following fields to facilitate connections by SSH over HTTP proxy. *** ### `proxy_user_name`^Optional ```python theme={null} proxy_user_name: str ``` * *Type:* str 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. *** ### `proxy_user_password`^Optional ```python theme={null} proxy_user_password: str ``` * *Type:* str 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. *** ### `script_path`^Optional ```python theme={null} script_path: str ``` * *Type:* str The path used to copy scripts meant for remote execution. Refer to [How Provisioners Execute Remote Scripts below for more details](https://developer.hashicorp.com/terraform/language/resources/provisioners/connection#how-provisioners-execute-remote-scripts) *** ### `target_platform`^Optional ```python theme={null} target_platform: str ``` * *Type:* str * *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 ```python theme={null} timeout: str ``` * *Type:* str * *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 ```python theme={null} user: str ``` * *Type:* str * *Default:* root The user to use for the connection. ***