remote

Documentation

Index

• type BaseOutputs
  • func (c *BaseOutputs) Annotate(a infer.Annotator)
• type Command
  • func (c *Command) Annotate(a infer.Annotator)
  • func (*Command) Create(ctx p.Context, name string, input CommandInputs, preview bool) (string, CommandOutputs, error)
  • func (*Command) Delete(ctx p.Context, id string, props CommandOutputs) error
  • func (*Command) Update(ctx p.Context, id string, olds CommandOutputs, news CommandInputs, ...) (CommandOutputs, error)
• type CommandInputs
  • func (c *CommandInputs) Annotate(a infer.Annotator)
• type CommandOutputs
• type Connection
  • func (c *Connection) Annotate(a infer.Annotator)
  • func (con *Connection) Dial(ctx p.Context) (*ssh.Client, error)
  • func (con *Connection) SShConfig() (*ssh.ClientConfig, error)
• type CopyFile
  • func (c *CopyFile) Annotate(a infer.Annotator)
  • func (*CopyFile) Create(ctx p.Context, name string, input CopyFileInputs, preview bool) (string, CopyFileOutputs, error)
• type CopyFileInputs
  • func (c *CopyFileInputs) Annotate(a infer.Annotator)
• type CopyFileOutputs
• type ProxyConnection
  • func (c *ProxyConnection) Annotate(a infer.Annotator)
  • func (con *ProxyConnection) SShConfig() (*ssh.ClientConfig, error)

Types

type BaseOutputs

type BaseOutputs struct {
	Stdout string `pulumi:"stdout"`
	Stderr string `pulumi:"stderr"`
}

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 Command

type Command struct{}

func (*Command) Annotate

func (c *Command) 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 (*Command) Create

func (*Command) Create(ctx p.Context, name string, input CommandInputs, preview bool) (string, CommandOutputs, error)

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

func (*Command) Delete

func (*Command) Delete(ctx p.Context, id string, props CommandOutputs) error

The Delete method will run when the resource is deleted.

func (*Command) Update

func (*Command) Update(ctx p.Context, id string, olds CommandOutputs, news CommandInputs, preview bool) (CommandOutputs, error)

The Update method will be run on every update.

type CommandInputs

type CommandInputs struct {
	common.ResourceInputs
	common.CommonInputs
	// 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:"replaceOnChanges" specifies that the resource will be replaced if the field changes.
	// provider:"secret" specifies that a field should be marked secret.
	Connection  *Connection       `pulumi:"connection" provider:"secret"`
	Environment map[string]string `pulumi:"environment,optional"`
}

The arguments for a remote Command resource.

func (*CommandInputs) Annotate

func (c *CommandInputs) 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 CommandOutputs

type CommandOutputs struct {
	CommandInputs
	BaseOutputs
}

The properties for a remote Command resource.

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 (con *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 CopyFile

type CopyFile struct{}

func (*CopyFile) Annotate

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

CopyFile implements Annotate which allows you to attach descriptions to the CopyFile resource.

func (*CopyFile) Create

func (*CopyFile) Create(ctx p.Context, name string, input CopyFileInputs, preview bool) (string, CopyFileOutputs, error)

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

type CopyFileInputs

type CopyFileInputs struct {
	Connection *Connection    `pulumi:"connection" provider:"secret"`
	Triggers   *[]interface{} `pulumi:"triggers,optional" providers:"replaceOnDelete"`
	LocalPath  string         `pulumi:"localPath"`
	RemotePath string         `pulumi:"remotePath"`
}

func (*CopyFileInputs) Annotate

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

CopyFile implements Annotate which allows you to attach descriptions to the CopyFile resource's fields.

type CopyFileOutputs

type CopyFileOutputs struct {
	CopyFileInputs
}

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)