remote

Documentation

Index

• type Command
  • func (c *Command) Annotate(a r.Annotator)
  • func (c *Command) Create(ctx r.Context, name string, preview bool) (r.ID, error)
  • func (c *Command) Delete(ctx r.Context, _ r.ID) error
  • func (c *Command) Update(ctx r.Context, id r.ID, newC any, _ []string, preview bool) error
• type Connection
  • func (con *Connection) Annotate(a r.Annotator)
  • func (con Connection) Dial(ctx context.Context, config *ssh.ClientConfig) (*ssh.Client, error)
  • func (con Connection) SShConfig() (*ssh.ClientConfig, error)
• type CopyFile
  • func (c *CopyFile) Annotate(a r.Annotator)
  • func (c *CopyFile) Create(ctx r.Context, name string, preview bool) (r.ID, error)
  • func (c *CopyFile) Delete(ctx r.Context, _ r.ID) error

Types

type Command

type Command struct {
	// Input
	Connection  Connection         `pulumi:"connection"`
	Interpreter *[]string          `pulumi:"interpreter,optional"`
	Dir         *string            `pulumi:"dir,optional"`
	Environment *map[string]string `pulumi:"environment,optional"`
	Triggers    *[]interface{}     `pulumi:"triggers,optional"`
	Create_     string             `pulumi:"create"`
	Delete_     *string            `pulumi:"delete,optional"`
	Update_     *string            `pulumi:"update,optional"`
	Stdin       *string            `pulumi:"stdin,optional"`

	// Output
	Stdout string `pulumi:"stdout" provider:"output"`
	Stderr string `pulumi:"stderr" provider:"output"`
}

func (*Command) Annotate

func (c *Command) Annotate(a r.Annotator)

func (*Command) Create

func (c *Command) Create(ctx r.Context, name string, preview bool) (r.ID, error)

Create executes the create command, sets Stdout and Stderr, and returns a unique ID for the command execution

func (*Command) Delete

func (c *Command) Delete(ctx r.Context, _ r.ID) error

RunDelete executes the delete command

func (*Command) Update

func (c *Command) Update(ctx r.Context, id r.ID, newC any, _ []string, preview bool) error

type Connection

type Connection struct {
	User       string  `pulumi:"user,optional"`
	Password   *string `pulumi:"password,optional"`
	Host       string  `pulumi:"host"`
	Port       int     `pulumi:"port,optional"`
	PrivateKey *string `pulumi:"privateKey,optional"`
}

func (*Connection) Annotate

func (con *Connection) Annotate(a r.Annotator)

func (Connection) Dial

func (con Connection) Dial(ctx context.Context, config *ssh.ClientConfig) (*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)

Generate an ssh config from a connection specification.

type CopyFile

type CopyFile struct {
	// Input
	Connection Connection     `pulumi:"connection"`
	Triggers   *[]interface{} `pulumi:"triggers,optional"`
	LocalPath  string         `pulumi:"localPath"`
	RemotePath string         `pulumi:"remotePath"`
}

func (*CopyFile) Annotate

func (c *CopyFile) Annotate(a r.Annotator)

func (*CopyFile) Create

func (c *CopyFile) Create(ctx r.Context, name string, preview bool) (r.ID, error)

func (*CopyFile) Delete

func (c *CopyFile) Delete(ctx r.Context, _ r.ID) error