remote

package
v0.0.0-...-da5e493 Latest Latest
Warning

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

Go to latest
Published: Jan 24, 2024 License: Apache-2.0 Imports: 8 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.
	Port *int `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.
	Port pulumi.IntPtrInput `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

func (ConnectionArgs) ToOutput

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

The address of the resource to connect to.

func (ConnectionOutput) Password

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

The port to connect to.

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

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) ToOutput

func (ConnectionOutput) User

The user that we should use for the connection.

type File

type File struct {
	pulumi.CustomResourceState

	// The parameters with which to connect to the remote host.
	Connection ConnectionOutput `pulumi:"connection"`
	// The content of file
	Content pulumi.StringPtrOutput `pulumi:"content"`
	// The md5sum of the uploaded file
	Md5sum pulumi.StringOutput `pulumi:"md5sum"`
	// The path for file on remote server
	Path pulumi.StringOutput `pulumi:"path"`
	// Unix permissions for file
	Permissions pulumi.StringPtrOutput `pulumi:"permissions"`
	// sudo mode requires a external sftp server to be running on remote host
	SftpPath pulumi.StringPtrOutput `pulumi:"sftpPath"`
	// Trigger replacements on changes to this input.
	Triggers pulumi.ArrayOutput `pulumi:"triggers"`
	// if enabled then use sudo for copy command instead of direct copy
	UseSudo pulumi.BoolPtrOutput `pulumi:"useSudo"`
}

A file to be created on a remote host. The connection is established via ssh.

func GetFile

func GetFile(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *FileState, opts ...pulumi.ResourceOption) (*File, error)

GetFile gets an existing File resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewFile

func NewFile(ctx *pulumi.Context,
	name string, args *FileArgs, opts ...pulumi.ResourceOption) (*File, error)

NewFile registers a new resource with the given unique name, arguments, and options.

func (*File) ElementType

func (*File) ElementType() reflect.Type

func (*File) ToFileOutput

func (i *File) ToFileOutput() FileOutput

func (*File) ToFileOutputWithContext

func (i *File) ToFileOutputWithContext(ctx context.Context) FileOutput

func (*File) ToOutput

func (i *File) ToOutput(ctx context.Context) pulumix.Output[*File]

type FileArgs

type FileArgs struct {
	// The parameters with which to connect to the remote host.
	Connection ConnectionInput
	// The content of file
	Content pulumi.StringPtrInput
	// The path for file on remote server
	Path pulumi.StringInput
	// Unix permissions for file
	Permissions pulumi.StringPtrInput
	// sudo mode requires a external sftp server to be running on remote host
	SftpPath pulumi.StringPtrInput
	// Trigger replacements on changes to this input.
	Triggers pulumi.ArrayInput
	// if enabled then use sudo for copy command instead of direct copy
	UseSudo pulumi.BoolPtrInput
}

The set of arguments for constructing a File resource.

func (FileArgs) ElementType

func (FileArgs) ElementType() reflect.Type

type FileArray

type FileArray []FileInput

func (FileArray) ElementType

func (FileArray) ElementType() reflect.Type

func (FileArray) ToFileArrayOutput

func (i FileArray) ToFileArrayOutput() FileArrayOutput

func (FileArray) ToFileArrayOutputWithContext

func (i FileArray) ToFileArrayOutputWithContext(ctx context.Context) FileArrayOutput

func (FileArray) ToOutput

func (i FileArray) ToOutput(ctx context.Context) pulumix.Output[[]*File]

type FileArrayInput

type FileArrayInput interface {
	pulumi.Input

	ToFileArrayOutput() FileArrayOutput
	ToFileArrayOutputWithContext(context.Context) FileArrayOutput
}

FileArrayInput is an input type that accepts FileArray and FileArrayOutput values. You can construct a concrete instance of `FileArrayInput` via:

FileArray{ FileArgs{...} }

type FileArrayOutput

type FileArrayOutput struct{ *pulumi.OutputState }

func (FileArrayOutput) ElementType

func (FileArrayOutput) ElementType() reflect.Type

func (FileArrayOutput) Index

func (FileArrayOutput) ToFileArrayOutput

func (o FileArrayOutput) ToFileArrayOutput() FileArrayOutput

func (FileArrayOutput) ToFileArrayOutputWithContext

func (o FileArrayOutput) ToFileArrayOutputWithContext(ctx context.Context) FileArrayOutput

func (FileArrayOutput) ToOutput

func (o FileArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]*File]

type FileInput

type FileInput interface {
	pulumi.Input

	ToFileOutput() FileOutput
	ToFileOutputWithContext(ctx context.Context) FileOutput
}

type FileMap

type FileMap map[string]FileInput

func (FileMap) ElementType

func (FileMap) ElementType() reflect.Type

func (FileMap) ToFileMapOutput

func (i FileMap) ToFileMapOutput() FileMapOutput

func (FileMap) ToFileMapOutputWithContext

func (i FileMap) ToFileMapOutputWithContext(ctx context.Context) FileMapOutput

func (FileMap) ToOutput

func (i FileMap) ToOutput(ctx context.Context) pulumix.Output[map[string]*File]

type FileMapInput

type FileMapInput interface {
	pulumi.Input

	ToFileMapOutput() FileMapOutput
	ToFileMapOutputWithContext(context.Context) FileMapOutput
}

FileMapInput is an input type that accepts FileMap and FileMapOutput values. You can construct a concrete instance of `FileMapInput` via:

FileMap{ "key": FileArgs{...} }

type FileMapOutput

type FileMapOutput struct{ *pulumi.OutputState }

func (FileMapOutput) ElementType

func (FileMapOutput) ElementType() reflect.Type

func (FileMapOutput) MapIndex

func (FileMapOutput) ToFileMapOutput

func (o FileMapOutput) ToFileMapOutput() FileMapOutput

func (FileMapOutput) ToFileMapOutputWithContext

func (o FileMapOutput) ToFileMapOutputWithContext(ctx context.Context) FileMapOutput

func (FileMapOutput) ToOutput

func (o FileMapOutput) ToOutput(ctx context.Context) pulumix.Output[map[string]*File]

type FileOutput

type FileOutput struct{ *pulumi.OutputState }

func (FileOutput) Connection

func (o FileOutput) Connection() ConnectionOutput

The parameters with which to connect to the remote host.

func (FileOutput) Content

func (o FileOutput) Content() pulumi.StringPtrOutput

The content of file

func (FileOutput) ElementType

func (FileOutput) ElementType() reflect.Type

func (FileOutput) Md5sum

func (o FileOutput) Md5sum() pulumi.StringOutput

The md5sum of the uploaded file

func (FileOutput) Path

func (o FileOutput) Path() pulumi.StringOutput

The path for file on remote server

func (FileOutput) Permissions

func (o FileOutput) Permissions() pulumi.StringPtrOutput

Unix permissions for file

func (FileOutput) SftpPath

func (o FileOutput) SftpPath() pulumi.StringPtrOutput

sudo mode requires a external sftp server to be running on remote host

func (FileOutput) ToFileOutput

func (o FileOutput) ToFileOutput() FileOutput

func (FileOutput) ToFileOutputWithContext

func (o FileOutput) ToFileOutputWithContext(ctx context.Context) FileOutput

func (FileOutput) ToOutput

func (o FileOutput) ToOutput(ctx context.Context) pulumix.Output[*File]

func (FileOutput) Triggers

func (o FileOutput) Triggers() pulumi.ArrayOutput

Trigger replacements on changes to this input.

func (FileOutput) UseSudo

func (o FileOutput) UseSudo() pulumi.BoolPtrOutput

if enabled then use sudo for copy command instead of direct copy

type FileState

type FileState struct {
}

func (FileState) ElementType

func (FileState) ElementType() reflect.Type

type ProxyConnection

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 *int `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

func (val *ProxyConnection) Defaults() *ProxyConnection

Defaults sets the appropriate defaults for ProxyConnection

type ProxyConnectionArgs

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.IntPtrInput `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

func (val *ProxyConnectionArgs) Defaults() *ProxyConnectionArgs

Defaults sets the appropriate defaults for ProxyConnectionArgs

func (ProxyConnectionArgs) ElementType

func (ProxyConnectionArgs) ElementType() reflect.Type

func (ProxyConnectionArgs) ToOutput

func (ProxyConnectionArgs) ToProxyConnectionOutput

func (i ProxyConnectionArgs) ToProxyConnectionOutput() ProxyConnectionOutput

func (ProxyConnectionArgs) ToProxyConnectionOutputWithContext

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

func (ProxyConnectionArgs) ToProxyConnectionPtrOutput

func (i ProxyConnectionArgs) ToProxyConnectionPtrOutput() ProxyConnectionPtrOutput

func (ProxyConnectionArgs) ToProxyConnectionPtrOutputWithContext

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

type ProxyConnectionInput

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

type ProxyConnectionOutput struct{ *pulumi.OutputState }

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

func (ProxyConnectionOutput) AgentSocketPath

func (o ProxyConnectionOutput) AgentSocketPath() pulumi.StringPtrOutput

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

func (ProxyConnectionOutput) DialErrorLimit

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

func (ProxyConnectionOutput) ElementType() reflect.Type

func (ProxyConnectionOutput) Host

The address of the bastion host to connect to.

func (ProxyConnectionOutput) Password

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

func (ProxyConnectionOutput) PerDialTimeout

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

The port of the bastion host to connect to.

func (ProxyConnectionOutput) PrivateKey

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

func (ProxyConnectionOutput) PrivateKeyPassword

func (o ProxyConnectionOutput) PrivateKeyPassword() pulumi.StringPtrOutput

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

func (ProxyConnectionOutput) ToOutput

func (ProxyConnectionOutput) ToProxyConnectionOutput

func (o ProxyConnectionOutput) ToProxyConnectionOutput() ProxyConnectionOutput

func (ProxyConnectionOutput) ToProxyConnectionOutputWithContext

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

func (ProxyConnectionOutput) ToProxyConnectionPtrOutput

func (o ProxyConnectionOutput) ToProxyConnectionPtrOutput() ProxyConnectionPtrOutput

func (ProxyConnectionOutput) ToProxyConnectionPtrOutputWithContext

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

func (ProxyConnectionOutput) User

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

type ProxyConnectionPtrInput

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

type ProxyConnectionPtrOutput

type ProxyConnectionPtrOutput struct{ *pulumi.OutputState }

func (ProxyConnectionPtrOutput) AgentSocketPath

func (o ProxyConnectionPtrOutput) AgentSocketPath() pulumi.StringPtrOutput

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

func (ProxyConnectionPtrOutput) DialErrorLimit

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

func (ProxyConnectionPtrOutput) ElementType

func (ProxyConnectionPtrOutput) ElementType() reflect.Type

func (ProxyConnectionPtrOutput) Host

The address of the bastion host to connect to.

func (ProxyConnectionPtrOutput) Password

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

func (ProxyConnectionPtrOutput) PerDialTimeout

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

The port of the bastion host to connect to.

func (ProxyConnectionPtrOutput) PrivateKey

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

func (ProxyConnectionPtrOutput) PrivateKeyPassword

func (o ProxyConnectionPtrOutput) PrivateKeyPassword() pulumi.StringPtrOutput

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

func (ProxyConnectionPtrOutput) ToOutput

func (ProxyConnectionPtrOutput) ToProxyConnectionPtrOutput

func (o ProxyConnectionPtrOutput) ToProxyConnectionPtrOutput() ProxyConnectionPtrOutput

func (ProxyConnectionPtrOutput) ToProxyConnectionPtrOutputWithContext

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

func (ProxyConnectionPtrOutput) User

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL