ssh

package
v0.36.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 7, 2025 License: GPL-3.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Connection 

type Connection struct {
	// SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
	AgentSocketPath *string `pulumi:"agentSocketPath"`
	// Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.
	DialErrorLimit *int `pulumi:"dialErrorLimit"`
	// The address of the resource to connect to.
	Host string `pulumi:"host"`
	// The password we should use for the connection.
	Password *string `pulumi:"password"`
	// Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.
	PerDialTimeout *int `pulumi:"perDialTimeout"`
	// The port to connect to. Defaults to 22.
	Port *float64 `pulumi:"port"`
	// The contents of an SSH key to use for the connection. This takes preference over the password if provided.
	PrivateKey *string `pulumi:"privateKey"`
	// The password to use in case the private key is encrypted.
	PrivateKeyPassword *string `pulumi:"privateKeyPassword"`
	// The connection settings for the bastion/proxy host.
	Proxy *ProxyConnection `pulumi:"proxy"`
	// The user that we should use for the connection.
	User *string `pulumi:"user"`
}

Instructions for how to connect to a remote endpoint.

func (*Connection) Defaults 

func (val *Connection) Defaults() *Connection

Defaults sets the appropriate defaults for Connection

type ConnectionArgs 

type ConnectionArgs struct {
	// SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
	AgentSocketPath pulumi.StringPtrInput `pulumi:"agentSocketPath"`
	// Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.
	DialErrorLimit pulumi.IntPtrInput `pulumi:"dialErrorLimit"`
	// The address of the resource to connect to.
	Host pulumi.StringInput `pulumi:"host"`
	// The password we should use for the connection.
	Password pulumi.StringPtrInput `pulumi:"password"`
	// Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.
	PerDialTimeout pulumi.IntPtrInput `pulumi:"perDialTimeout"`
	// The port to connect to. Defaults to 22.
	Port pulumi.Float64PtrInput `pulumi:"port"`
	// The contents of an SSH key to use for the connection. This takes preference over the password if provided.
	PrivateKey pulumi.StringPtrInput `pulumi:"privateKey"`
	// The password to use in case the private key is encrypted.
	PrivateKeyPassword pulumi.StringPtrInput `pulumi:"privateKeyPassword"`
	// The connection settings for the bastion/proxy host.
	Proxy ProxyConnectionPtrInput `pulumi:"proxy"`
	// The user that we should use for the connection.
	User pulumi.StringPtrInput `pulumi:"user"`
}

Instructions for how to connect to a remote endpoint.

func (*ConnectionArgs) Defaults 

func (val *ConnectionArgs) Defaults() *ConnectionArgs

Defaults sets the appropriate defaults for ConnectionArgs

func (ConnectionArgs) ElementType 

func (ConnectionArgs) ElementType() reflect.Type

func (ConnectionArgs) ToConnectionOutput 

func (i ConnectionArgs) ToConnectionOutput() ConnectionOutput

func (ConnectionArgs) ToConnectionOutputWithContext 

func (i ConnectionArgs) ToConnectionOutputWithContext(ctx context.Context) ConnectionOutput

type ConnectionInput 

type ConnectionInput interface {
	pulumi.Input

	ToConnectionOutput() ConnectionOutput
	ToConnectionOutputWithContext(context.Context) ConnectionOutput
}

ConnectionInput is an input type that accepts ConnectionArgs and ConnectionOutput values. You can construct a concrete instance of `ConnectionInput` via: 

ConnectionArgs{...}

type ConnectionOutput 

type ConnectionOutput struct{ *pulumi.OutputState }

Instructions for how to connect to a remote endpoint.

func (ConnectionOutput) AgentSocketPath 

func (o ConnectionOutput) AgentSocketPath() pulumi.StringPtrOutput

SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.

func (ConnectionOutput) DialErrorLimit 

func (o ConnectionOutput) DialErrorLimit() pulumi.IntPtrOutput

Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.

func (ConnectionOutput) ElementType 

func (ConnectionOutput) ElementType() reflect.Type

func (ConnectionOutput) Host 

func (o ConnectionOutput) Host() pulumi.StringOutput

The address of the resource to connect to.

func (ConnectionOutput) Password 

func (o ConnectionOutput) Password() pulumi.StringPtrOutput

The password we should use for the connection.

func (ConnectionOutput) PerDialTimeout 

func (o ConnectionOutput) PerDialTimeout() pulumi.IntPtrOutput

Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.

func (ConnectionOutput) Port 

func (o ConnectionOutput) Port() pulumi.Float64PtrOutput

The port to connect to. Defaults to 22.

func (ConnectionOutput) PrivateKey 

func (o ConnectionOutput) PrivateKey() pulumi.StringPtrOutput

The contents of an SSH key to use for the connection. This takes preference over the password if provided.

func (ConnectionOutput) PrivateKeyPassword 

func (o ConnectionOutput) PrivateKeyPassword() pulumi.StringPtrOutput

The password to use in case the private key is encrypted.

func (ConnectionOutput) Proxy added in v0.10.0 

func (o ConnectionOutput) Proxy() ProxyConnectionPtrOutput

The connection settings for the bastion/proxy host.

func (ConnectionOutput) ToConnectionOutput 

func (o ConnectionOutput) ToConnectionOutput() ConnectionOutput

func (ConnectionOutput) ToConnectionOutputWithContext 

func (o ConnectionOutput) ToConnectionOutputWithContext(ctx context.Context) ConnectionOutput

func (ConnectionOutput) User 

func (o ConnectionOutput) User() pulumi.StringPtrOutput

The user that we should use for the connection.

type ProxyConnection added in v0.10.0 

type ProxyConnection struct {
	// SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
	AgentSocketPath *string `pulumi:"agentSocketPath"`
	// Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.
	DialErrorLimit *int `pulumi:"dialErrorLimit"`
	// The address of the bastion host to connect to.
	Host string `pulumi:"host"`
	// The password we should use for the connection to the bastion host.
	Password *string `pulumi:"password"`
	// Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.
	PerDialTimeout *int `pulumi:"perDialTimeout"`
	// The port of the bastion host to connect to.
	Port *float64 `pulumi:"port"`
	// The contents of an SSH key to use for the connection. This takes preference over the password if provided.
	PrivateKey *string `pulumi:"privateKey"`
	// The password to use in case the private key is encrypted.
	PrivateKeyPassword *string `pulumi:"privateKeyPassword"`
	// The user that we should use for the connection to the bastion host.
	User *string `pulumi:"user"`
}

Instructions for how to connect to a remote endpoint via a bastion host.

func (*ProxyConnection) Defaults added in v0.10.0 

func (val *ProxyConnection) Defaults() *ProxyConnection

Defaults sets the appropriate defaults for ProxyConnection

type ProxyConnectionArgs added in v0.10.0 

type ProxyConnectionArgs struct {
	// SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
	AgentSocketPath pulumi.StringPtrInput `pulumi:"agentSocketPath"`
	// Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.
	DialErrorLimit pulumi.IntPtrInput `pulumi:"dialErrorLimit"`
	// The address of the bastion host to connect to.
	Host pulumi.StringInput `pulumi:"host"`
	// The password we should use for the connection to the bastion host.
	Password pulumi.StringPtrInput `pulumi:"password"`
	// Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.
	PerDialTimeout pulumi.IntPtrInput `pulumi:"perDialTimeout"`
	// The port of the bastion host to connect to.
	Port pulumi.Float64PtrInput `pulumi:"port"`
	// The contents of an SSH key to use for the connection. This takes preference over the password if provided.
	PrivateKey pulumi.StringPtrInput `pulumi:"privateKey"`
	// The password to use in case the private key is encrypted.
	PrivateKeyPassword pulumi.StringPtrInput `pulumi:"privateKeyPassword"`
	// The user that we should use for the connection to the bastion host.
	User pulumi.StringPtrInput `pulumi:"user"`
}

Instructions for how to connect to a remote endpoint via a bastion host.

func (*ProxyConnectionArgs) Defaults added in v0.10.0 

func (val *ProxyConnectionArgs) Defaults() *ProxyConnectionArgs

Defaults sets the appropriate defaults for ProxyConnectionArgs

func (ProxyConnectionArgs) ElementType added in v0.10.0 

func (ProxyConnectionArgs) ElementType() reflect.Type

func (ProxyConnectionArgs) ToProxyConnectionOutput added in v0.10.0 

func (i ProxyConnectionArgs) ToProxyConnectionOutput() ProxyConnectionOutput

func (ProxyConnectionArgs) ToProxyConnectionOutputWithContext added in v0.10.0 

func (i ProxyConnectionArgs) ToProxyConnectionOutputWithContext(ctx context.Context) ProxyConnectionOutput

func (ProxyConnectionArgs) ToProxyConnectionPtrOutput added in v0.10.0 

func (i ProxyConnectionArgs) ToProxyConnectionPtrOutput() ProxyConnectionPtrOutput

func (ProxyConnectionArgs) ToProxyConnectionPtrOutputWithContext added in v0.10.0 

func (i ProxyConnectionArgs) ToProxyConnectionPtrOutputWithContext(ctx context.Context) ProxyConnectionPtrOutput

type ProxyConnectionInput added in v0.10.0 

type ProxyConnectionInput interface {
	pulumi.Input

	ToProxyConnectionOutput() ProxyConnectionOutput
	ToProxyConnectionOutputWithContext(context.Context) ProxyConnectionOutput
}

ProxyConnectionInput is an input type that accepts ProxyConnectionArgs and ProxyConnectionOutput values. You can construct a concrete instance of `ProxyConnectionInput` via: 

ProxyConnectionArgs{...}

type ProxyConnectionOutput added in v0.10.0 

type ProxyConnectionOutput struct{ *pulumi.OutputState }

Instructions for how to connect to a remote endpoint via a bastion host.

func (ProxyConnectionOutput) AgentSocketPath added in v0.10.0 

func (o ProxyConnectionOutput) AgentSocketPath() pulumi.StringPtrOutput

SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.

func (ProxyConnectionOutput) DialErrorLimit added in v0.10.0 

func (o ProxyConnectionOutput) DialErrorLimit() pulumi.IntPtrOutput

Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.

func (ProxyConnectionOutput) ElementType added in v0.10.0 

func (ProxyConnectionOutput) ElementType() reflect.Type

func (ProxyConnectionOutput) Host added in v0.10.0 

func (o ProxyConnectionOutput) Host() pulumi.StringOutput

The address of the bastion host to connect to.

func (ProxyConnectionOutput) Password added in v0.10.0 

func (o ProxyConnectionOutput) Password() pulumi.StringPtrOutput

The password we should use for the connection to the bastion host.

func (ProxyConnectionOutput) PerDialTimeout added in v0.10.0 

func (o ProxyConnectionOutput) PerDialTimeout() pulumi.IntPtrOutput

Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.

func (ProxyConnectionOutput) Port added in v0.10.0 

func (o ProxyConnectionOutput) Port() pulumi.Float64PtrOutput

The port of the bastion host to connect to.

func (ProxyConnectionOutput) PrivateKey added in v0.10.0 

func (o ProxyConnectionOutput) PrivateKey() pulumi.StringPtrOutput

The contents of an SSH key to use for the connection. This takes preference over the password if provided.

func (ProxyConnectionOutput) PrivateKeyPassword added in v0.10.0 

func (o ProxyConnectionOutput) PrivateKeyPassword() pulumi.StringPtrOutput

The password to use in case the private key is encrypted.

func (ProxyConnectionOutput) ToProxyConnectionOutput added in v0.10.0 

func (o ProxyConnectionOutput) ToProxyConnectionOutput() ProxyConnectionOutput

func (ProxyConnectionOutput) ToProxyConnectionOutputWithContext added in v0.10.0 

func (o ProxyConnectionOutput) ToProxyConnectionOutputWithContext(ctx context.Context) ProxyConnectionOutput

func (ProxyConnectionOutput) ToProxyConnectionPtrOutput added in v0.10.0 

func (o ProxyConnectionOutput) ToProxyConnectionPtrOutput() ProxyConnectionPtrOutput

func (ProxyConnectionOutput) ToProxyConnectionPtrOutputWithContext added in v0.10.0 

func (o ProxyConnectionOutput) ToProxyConnectionPtrOutputWithContext(ctx context.Context) ProxyConnectionPtrOutput

func (ProxyConnectionOutput) User added in v0.10.0 

func (o ProxyConnectionOutput) User() pulumi.StringPtrOutput

The user that we should use for the connection to the bastion host.

type ProxyConnectionPtrInput added in v0.10.0 

type ProxyConnectionPtrInput interface {
	pulumi.Input

	ToProxyConnectionPtrOutput() ProxyConnectionPtrOutput
	ToProxyConnectionPtrOutputWithContext(context.Context) ProxyConnectionPtrOutput
}

ProxyConnectionPtrInput is an input type that accepts ProxyConnectionArgs, ProxyConnectionPtr and ProxyConnectionPtrOutput values. You can construct a concrete instance of `ProxyConnectionPtrInput` via: 

        ProxyConnectionArgs{...}

or:

        nil

func ProxyConnectionPtr added in v0.10.0 

func ProxyConnectionPtr(v *ProxyConnectionArgs) ProxyConnectionPtrInput

type ProxyConnectionPtrOutput added in v0.10.0 

type ProxyConnectionPtrOutput struct{ *pulumi.OutputState }

func (ProxyConnectionPtrOutput) AgentSocketPath added in v0.10.0 

func (o ProxyConnectionPtrOutput) AgentSocketPath() pulumi.StringPtrOutput

SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.

func (ProxyConnectionPtrOutput) DialErrorLimit added in v0.10.0 

func (o ProxyConnectionPtrOutput) DialErrorLimit() pulumi.IntPtrOutput

Max allowed errors on trying to dial the remote host. -1 set count to unlimited. Default value is 10.

func (ProxyConnectionPtrOutput) Elem added in v0.10.0 

func (o ProxyConnectionPtrOutput) Elem() ProxyConnectionOutput

func (ProxyConnectionPtrOutput) ElementType added in v0.10.0 

func (ProxyConnectionPtrOutput) ElementType() reflect.Type

func (ProxyConnectionPtrOutput) Host added in v0.10.0 

func (o ProxyConnectionPtrOutput) Host() pulumi.StringPtrOutput

The address of the bastion host to connect to.

func (ProxyConnectionPtrOutput) Password added in v0.10.0 

func (o ProxyConnectionPtrOutput) Password() pulumi.StringPtrOutput

The password we should use for the connection to the bastion host.

func (ProxyConnectionPtrOutput) PerDialTimeout added in v0.10.0 

func (o ProxyConnectionPtrOutput) PerDialTimeout() pulumi.IntPtrOutput

Max number of seconds for each dial attempt. 0 implies no maximum. Default value is 15 seconds.

func (ProxyConnectionPtrOutput) Port added in v0.10.0 

func (o ProxyConnectionPtrOutput) Port() pulumi.Float64PtrOutput

The port of the bastion host to connect to.

func (ProxyConnectionPtrOutput) PrivateKey added in v0.10.0 

func (o ProxyConnectionPtrOutput) PrivateKey() pulumi.StringPtrOutput

The contents of an SSH key to use for the connection. This takes preference over the password if provided.

func (ProxyConnectionPtrOutput) PrivateKeyPassword added in v0.10.0 

func (o ProxyConnectionPtrOutput) PrivateKeyPassword() pulumi.StringPtrOutput

The password to use in case the private key is encrypted.

func (ProxyConnectionPtrOutput) ToProxyConnectionPtrOutput added in v0.10.0 

func (o ProxyConnectionPtrOutput) ToProxyConnectionPtrOutput() ProxyConnectionPtrOutput

func (ProxyConnectionPtrOutput) ToProxyConnectionPtrOutputWithContext added in v0.10.0 

func (o ProxyConnectionPtrOutput) ToProxyConnectionPtrOutputWithContext(ctx context.Context) ProxyConnectionPtrOutput

func (ProxyConnectionPtrOutput) User added in v0.10.0 

func (o ProxyConnectionPtrOutput) User() pulumi.StringPtrOutput

The user that we should use for the connection to the bastion host.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.