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

​
Initializer 

import "github.com/open-constructs/cdk-terrain-go/cdktn"

&cdktn.WinrmProvisionerConnection {
	Host: *string,
	Type: *string,
	Cacert: *string,
	Https: *bool,
	Insecure: *bool,
	Password: *string,
	Port: *f64,
	ScriptPath: *string,
	Timeout: *string,
	UseNtlm: *bool,
	User: *string,
}

​
Properties

NameTypeDescription
Host*stringThe address of the resource to connect to.
Type*stringThe connection type.
Cacert*stringThe CA certificate to validate against.
Https*boolSet to true to connect using HTTPS instead of HTTP.
Insecure*boolSet to true to skip validating the HTTPS certificate chain.
Password*stringThe password to use for the connection.
Port*f64The port to connect to.
ScriptPath*stringThe path used to copy scripts meant for remote execution.
Timeout*stringThe timeout to wait for the connection to become available.
UseNtlm*boolSet to true to use NTLM authentication rather than default (basic authentication), removing the requirement for basic authentication to be enabled within the target guest.
User*stringThe user to use for the connection.

​
HostRequired 

Host *string
  • Type: *string
The address of the resource to connect to.

​
TypeRequired 

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.

​
CacertOptional 

Cacert *string
  • Type: *string
The CA certificate to validate against.

​
HttpsOptional 

Https *bool
  • Type: *bool
Set to true to connect using HTTPS instead of HTTP.

​
InsecureOptional 

Insecure *bool
  • Type: *bool
Set to true to skip validating the HTTPS certificate chain.

​
PasswordOptional 

Password *string
  • Type: *string
The password to use for the connection.

​
PortOptional 

Port *f64
  • Type: *f64
  • Default: 22
The port to connect to.

​
ScriptPathOptional 

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

​
TimeoutOptional 

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”.)

​
UseNtlmOptional 

UseNtlm *bool
  • Type: *bool
Set to true to use NTLM authentication rather than default (basic authentication), removing the requirement for basic authentication to be enabled within the target guest. Refer to Authentication for Remote Connections in the Windows App Development documentation for more details.

​
UserOptional 

User *string
  • Type: *string
  • Default: root
The user to use for the connection.