remote

Documentation

Index

• func NewSFTPClient(client *ssh.Client, sudo bool, sftpServerPath string) (*sftp.Client, error)
• func NewSFTPServer(conn *ssh.Client, cmd string, opts ...sftp.ClientOption) (*sftp.Client, error)
• type BaseOutputs
  • func (c *BaseOutputs) Annotate(a infer.Annotator)
• type Connection
  • func (c *Connection) Annotate(a infer.Annotator)
  • func (c *Connection) Dial(ctx p.Context) (*ssh.Client, error)
  • func (con *Connection) SSHConfig() (*ssh.ClientConfig, error)
• type File
  • func (f *File) Annotate(a infer.Annotator)
  • func (*File) Create(ctx p.Context, name string, input FileInputs, preview bool) (string, FileOutputs, error)
  • func (*File) Delete(ctx p.Context, _ string, props FileOutputs) error
  • func (*File) Read(ctx p.Context, id string, input FileInputs, output FileOutputs) (string, FileInputs, FileOutputs, error)
  • func (*File) Update(ctx p.Context, _ string, olds FileOutputs, news FileInputs, preview bool) (FileOutputs, error)
• type FileInputs
  • func (f *FileInputs) Annotate(a infer.Annotator)
• type FileOutputs
• type ProxyConnection
  • func (c *ProxyConnection) Annotate(a infer.Annotator)
  • func (con *ProxyConnection) SSHConfig() (*ssh.ClientConfig, error)

Functions

func NewSFTPClient

func NewSFTPClient(client *ssh.Client, sudo bool, sftpServerPath string) (*sftp.Client, error)

func NewSFTPServer

func NewSFTPServer(conn *ssh.Client, cmd string, opts ...sftp.ClientOption) (*sftp.Client, error)

Types

type BaseOutputs

type BaseOutputs struct {
	MD5Sum string `pulumi:"md5sum"`
}

func (*BaseOutputs) Annotate

func (c *BaseOutputs) Annotate(a infer.Annotator)

Implementing Annotate lets you provide descriptions and default values for fields and they will be visible in the provider's schema and the generated SDKs.

type Connection

type Connection struct {
	Proxy *ProxyConnection `pulumi:"proxy,optional"`
	// contains filtered or unexported fields
}

func (*Connection) Annotate

func (c *Connection) Annotate(a infer.Annotator)

func (*Connection) Dial

func (c *Connection) Dial(ctx p.Context) (*ssh.Client, error)

Dial a ssh client connection from a ssh client configuration, retrying as necessary.

func (*Connection) SSHConfig

func (con *Connection) SSHConfig() (*ssh.ClientConfig, error)

type File

type File struct{}

func (*File) Annotate

func (f *File) Annotate(a infer.Annotator)

Implementing Annotate lets you provide descriptions for resources and they will be visible in the provider's schema and the generated SDKs.

func (*File) Create

func (*File) Create(ctx p.Context, name string, input FileInputs, preview bool) (string, FileOutputs, error)

This is the Create method. This will be run on every resource creation.

func (*File) Delete

func (*File) Delete(ctx p.Context, _ string, props FileOutputs) error

The Delete method will run when the resource is deleted.

func (*File) Read

func (*File) Read(ctx p.Context, id string, input FileInputs, output FileOutputs) (string, FileInputs, FileOutputs, error)

func (*File) Update

func (*File) Update(ctx p.Context, _ string, olds FileOutputs, news FileInputs, preview bool) (FileOutputs, error)

The Update method will be run on every update.

type FileInputs

type FileInputs struct {
	// the pulumi-go-provider library uses field tags to dictate behavior.
	// pulumi:"connection" specifies the name of the field in the schema
	// pulumi:"optional" specifies that a field is optional. This must be a pointer.
	// provider:"secret" specifies that a field should be marked secret.
	Connection  *Connection `pulumi:"connection" provider:"secret"`
	Triggers    *[]any      `pulumi:"triggers,optional"`
	Path        *string     `pulumi:"path"`
	Content     *string     `pulumi:"content,optional"`
	UseSudo     *bool       `pulumi:"useSudo,optional" provider:"replace_on_change"`
	SFTPPath    *string     `pulumi:"sftpPath,optional"`
	Permissions *string     `pulumi:"permissions,optional"`
}

The arguments for a remote Command resource.

func (*FileInputs) Annotate

func (f *FileInputs) Annotate(a infer.Annotator)

Implementing Annotate lets you provide descriptions and default values for arguments and they will be visible in the provider's schema and the generated SDKs.

type FileOutputs

type FileOutputs struct {
	FileInputs
	BaseOutputs
}

The properties for a remote Command resource.

type ProxyConnection

type ProxyConnection struct {
	// contains filtered or unexported fields
}

func (*ProxyConnection) Annotate

func (c *ProxyConnection) Annotate(a infer.Annotator)

func (*ProxyConnection) SSHConfig

func (con *ProxyConnection) SSHConfig() (*ssh.ClientConfig, error)