remote

package
v0.7.2 Latest Latest
Warning

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

 Go to latest Published: Mar 22, 2023 License: Apache-2.0 Imports: 7 Imported by: 28

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Command 

type Command struct {
	pulumi.CustomResourceState

	// The parameters with which to connect to the remote host.
	Connection ConnectionOutput `pulumi:"connection"`
	// The command to run on create.
	Create pulumi.StringPtrOutput `pulumi:"create"`
	// The command to run on delete. The environment variables PULUMI_COMMAND_STDOUT
	// and PULUMI_COMMAND_STDERR are set to the stdout and stderr properties of the
	// Command resource from previous create or update steps.
	Delete pulumi.StringPtrOutput `pulumi:"delete"`
	// Additional environment variables available to the command's process.
	Environment pulumi.StringMapOutput `pulumi:"environment"`
	// The standard error of the command's process
	Stderr pulumi.StringOutput `pulumi:"stderr"`
	// Pass a string to the command's process as standard in
	Stdin pulumi.StringPtrOutput `pulumi:"stdin"`
	// The standard output of the command's process
	Stdout pulumi.StringOutput `pulumi:"stdout"`
	// Trigger replacements on changes to this input.
	Triggers pulumi.ArrayOutput `pulumi:"triggers"`
	// The command to run on update, if empty, create will
	// run again. The environment variables PULUMI_COMMAND_STDOUT and PULUMI_COMMAND_STDERR
	// are set to the stdout and stderr properties of the Command resource from previous
	// create or update steps.
	Update pulumi.StringPtrOutput `pulumi:"update"`
}

A command to run on a remote host. The connection is established via ssh.

func GetCommand 

func GetCommand(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *CommandState, opts ...pulumi.ResourceOption) (*Command, error)

GetCommand gets an existing Command 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 NewCommand 

func NewCommand(ctx *pulumi.Context,
	name string, args *CommandArgs, opts ...pulumi.ResourceOption) (*Command, error)

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

func (*Command) ElementType 

func (*Command) ElementType() reflect.Type

func (*Command) ToCommandOutput 

func (i *Command) ToCommandOutput() CommandOutput

func (*Command) ToCommandOutputWithContext 

func (i *Command) ToCommandOutputWithContext(ctx context.Context) CommandOutput

type CommandArgs 

type CommandArgs struct {
	// The parameters with which to connect to the remote host.
	Connection ConnectionInput
	// The command to run on create.
	Create pulumi.StringPtrInput
	// The command to run on delete. The environment variables PULUMI_COMMAND_STDOUT
	// and PULUMI_COMMAND_STDERR are set to the stdout and stderr properties of the
	// Command resource from previous create or update steps.
	Delete pulumi.StringPtrInput
	// Additional environment variables available to the command's process.
	Environment pulumi.StringMapInput
	// Pass a string to the command's process as standard in
	Stdin pulumi.StringPtrInput
	// Trigger replacements on changes to this input.
	Triggers pulumi.ArrayInput
	// The command to run on update, if empty, create will
	// run again. The environment variables PULUMI_COMMAND_STDOUT and PULUMI_COMMAND_STDERR
	// are set to the stdout and stderr properties of the Command resource from previous
	// create or update steps.
	Update pulumi.StringPtrInput
}

The set of arguments for constructing a Command resource.

func (CommandArgs) ElementType 

func (CommandArgs) ElementType() reflect.Type

type CommandArray 

type CommandArray []CommandInput

func (CommandArray) ElementType 

func (CommandArray) ElementType() reflect.Type

func (CommandArray) ToCommandArrayOutput 

func (i CommandArray) ToCommandArrayOutput() CommandArrayOutput

func (CommandArray) ToCommandArrayOutputWithContext 

func (i CommandArray) ToCommandArrayOutputWithContext(ctx context.Context) CommandArrayOutput

type CommandArrayInput 

type CommandArrayInput interface {
	pulumi.Input

	ToCommandArrayOutput() CommandArrayOutput
	ToCommandArrayOutputWithContext(context.Context) CommandArrayOutput
}

CommandArrayInput is an input type that accepts CommandArray and CommandArrayOutput values. You can construct a concrete instance of `CommandArrayInput` via: 

CommandArray{ CommandArgs{...} }

type CommandArrayOutput 

type CommandArrayOutput struct{ *pulumi.OutputState }

func (CommandArrayOutput) ElementType 

func (CommandArrayOutput) ElementType() reflect.Type

func (CommandArrayOutput) Index 

func (o CommandArrayOutput) Index(i pulumi.IntInput) CommandOutput

func (CommandArrayOutput) ToCommandArrayOutput 

func (o CommandArrayOutput) ToCommandArrayOutput() CommandArrayOutput

func (CommandArrayOutput) ToCommandArrayOutputWithContext 

func (o CommandArrayOutput) ToCommandArrayOutputWithContext(ctx context.Context) CommandArrayOutput

type CommandInput 

type CommandInput interface {
	pulumi.Input

	ToCommandOutput() CommandOutput
	ToCommandOutputWithContext(ctx context.Context) CommandOutput
}

type CommandMap 

type CommandMap map[string]CommandInput

func (CommandMap) ElementType 

func (CommandMap) ElementType() reflect.Type

func (CommandMap) ToCommandMapOutput 

func (i CommandMap) ToCommandMapOutput() CommandMapOutput

func (CommandMap) ToCommandMapOutputWithContext 

func (i CommandMap) ToCommandMapOutputWithContext(ctx context.Context) CommandMapOutput

type CommandMapInput 

type CommandMapInput interface {
	pulumi.Input

	ToCommandMapOutput() CommandMapOutput
	ToCommandMapOutputWithContext(context.Context) CommandMapOutput
}

CommandMapInput is an input type that accepts CommandMap and CommandMapOutput values. You can construct a concrete instance of `CommandMapInput` via: 

CommandMap{ "key": CommandArgs{...} }

type CommandMapOutput 

type CommandMapOutput struct{ *pulumi.OutputState }

func (CommandMapOutput) ElementType 

func (CommandMapOutput) ElementType() reflect.Type

func (CommandMapOutput) MapIndex 

func (o CommandMapOutput) MapIndex(k pulumi.StringInput) CommandOutput

func (CommandMapOutput) ToCommandMapOutput 

func (o CommandMapOutput) ToCommandMapOutput() CommandMapOutput

func (CommandMapOutput) ToCommandMapOutputWithContext 

func (o CommandMapOutput) ToCommandMapOutputWithContext(ctx context.Context) CommandMapOutput

type CommandOutput 

type CommandOutput struct{ *pulumi.OutputState }

func (CommandOutput) Connection added in v0.2.0 

func (o CommandOutput) Connection() ConnectionOutput

The parameters with which to connect to the remote host.

func (CommandOutput) Create added in v0.2.0 

func (o CommandOutput) Create() pulumi.StringPtrOutput

The command to run on create.

func (CommandOutput) Delete added in v0.2.0 

func (o CommandOutput) Delete() pulumi.StringPtrOutput

The command to run on delete. The environment variables PULUMI_COMMAND_STDOUT and PULUMI_COMMAND_STDERR are set to the stdout and stderr properties of the Command resource from previous create or update steps.

func (CommandOutput) ElementType 

func (CommandOutput) ElementType() reflect.Type

func (CommandOutput) Environment added in v0.2.0 

func (o CommandOutput) Environment() pulumi.StringMapOutput

Additional environment variables available to the command's process.

func (CommandOutput) Stderr added in v0.2.0 

func (o CommandOutput) Stderr() pulumi.StringOutput

The standard error of the command's process

func (CommandOutput) Stdin added in v0.2.0 

func (o CommandOutput) Stdin() pulumi.StringPtrOutput

Pass a string to the command's process as standard in

func (CommandOutput) Stdout added in v0.2.0 

func (o CommandOutput) Stdout() pulumi.StringOutput

The standard output of the command's process

func (CommandOutput) ToCommandOutput 

func (o CommandOutput) ToCommandOutput() CommandOutput

func (CommandOutput) ToCommandOutputWithContext 

func (o CommandOutput) ToCommandOutputWithContext(ctx context.Context) CommandOutput

func (CommandOutput) Triggers added in v0.2.0 

func (o CommandOutput) Triggers() pulumi.ArrayOutput

Trigger replacements on changes to this input.

func (CommandOutput) Update added in v0.2.0 

func (o CommandOutput) Update() pulumi.StringPtrOutput

The command to run on update, if empty, create will run again. The environment variables PULUMI_COMMAND_STDOUT and PULUMI_COMMAND_STDERR are set to the stdout and stderr properties of the Command resource from previous create or update steps.

type CommandState 

type CommandState struct {
}

func (CommandState) ElementType 

func (CommandState) ElementType() reflect.Type

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"`
	// The port 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.
	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"`
	// The port 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.
	User pulumi.StringPtrInput `pulumi:"user"`
}

Instructions for how to connect to a remote endpoint.

func (*ConnectionArgs) Defaults added in v0.2.0 

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 added in v0.6.0 

func (o ConnectionOutput) AgentSocketPath() pulumi.StringPtrOutput

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

func (ConnectionOutput) DialErrorLimit added in v0.7.1 

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

func (o ConnectionOutput) Port() pulumi.Float64PtrOutput

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 added in v0.6.0 

func (o ConnectionOutput) PrivateKeyPassword() pulumi.StringPtrOutput

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

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 CopyFile 

type CopyFile struct {
	pulumi.CustomResourceState

	// The parameters with which to connect to the remote host.
	Connection ConnectionOutput `pulumi:"connection"`
	// The path of the file to be copied.
	LocalPath pulumi.StringOutput `pulumi:"localPath"`
	// The destination path in the remote host.
	RemotePath pulumi.StringOutput `pulumi:"remotePath"`
	// Trigger replacements on changes to this input.
	Triggers pulumi.ArrayOutput `pulumi:"triggers"`
}

Copy a local file to a remote host.

func GetCopyFile 

func GetCopyFile(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *CopyFileState, opts ...pulumi.ResourceOption) (*CopyFile, error)

GetCopyFile gets an existing CopyFile 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 NewCopyFile 

func NewCopyFile(ctx *pulumi.Context,
	name string, args *CopyFileArgs, opts ...pulumi.ResourceOption) (*CopyFile, error)

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

func (*CopyFile) ElementType 

func (*CopyFile) ElementType() reflect.Type

func (*CopyFile) ToCopyFileOutput 

func (i *CopyFile) ToCopyFileOutput() CopyFileOutput

func (*CopyFile) ToCopyFileOutputWithContext 

func (i *CopyFile) ToCopyFileOutputWithContext(ctx context.Context) CopyFileOutput

type CopyFileArgs 

type CopyFileArgs struct {
	// The parameters with which to connect to the remote host.
	Connection ConnectionInput
	// The path of the file to be copied.
	LocalPath pulumi.StringInput
	// The destination path in the remote host.
	RemotePath pulumi.StringInput
	// Trigger replacements on changes to this input.
	Triggers pulumi.ArrayInput
}

The set of arguments for constructing a CopyFile resource.

func (CopyFileArgs) ElementType 

func (CopyFileArgs) ElementType() reflect.Type

type CopyFileArray 

type CopyFileArray []CopyFileInput

func (CopyFileArray) ElementType 

func (CopyFileArray) ElementType() reflect.Type

func (CopyFileArray) ToCopyFileArrayOutput 

func (i CopyFileArray) ToCopyFileArrayOutput() CopyFileArrayOutput

func (CopyFileArray) ToCopyFileArrayOutputWithContext 

func (i CopyFileArray) ToCopyFileArrayOutputWithContext(ctx context.Context) CopyFileArrayOutput

type CopyFileArrayInput 

type CopyFileArrayInput interface {
	pulumi.Input

	ToCopyFileArrayOutput() CopyFileArrayOutput
	ToCopyFileArrayOutputWithContext(context.Context) CopyFileArrayOutput
}

CopyFileArrayInput is an input type that accepts CopyFileArray and CopyFileArrayOutput values. You can construct a concrete instance of `CopyFileArrayInput` via: 

CopyFileArray{ CopyFileArgs{...} }

type CopyFileArrayOutput 

type CopyFileArrayOutput struct{ *pulumi.OutputState }

func (CopyFileArrayOutput) ElementType 

func (CopyFileArrayOutput) ElementType() reflect.Type

func (CopyFileArrayOutput) Index 

func (o CopyFileArrayOutput) Index(i pulumi.IntInput) CopyFileOutput

func (CopyFileArrayOutput) ToCopyFileArrayOutput 

func (o CopyFileArrayOutput) ToCopyFileArrayOutput() CopyFileArrayOutput

func (CopyFileArrayOutput) ToCopyFileArrayOutputWithContext 

func (o CopyFileArrayOutput) ToCopyFileArrayOutputWithContext(ctx context.Context) CopyFileArrayOutput

type CopyFileInput 

type CopyFileInput interface {
	pulumi.Input

	ToCopyFileOutput() CopyFileOutput
	ToCopyFileOutputWithContext(ctx context.Context) CopyFileOutput
}

type CopyFileMap 

type CopyFileMap map[string]CopyFileInput

func (CopyFileMap) ElementType 

func (CopyFileMap) ElementType() reflect.Type

func (CopyFileMap) ToCopyFileMapOutput 

func (i CopyFileMap) ToCopyFileMapOutput() CopyFileMapOutput

func (CopyFileMap) ToCopyFileMapOutputWithContext 

func (i CopyFileMap) ToCopyFileMapOutputWithContext(ctx context.Context) CopyFileMapOutput

type CopyFileMapInput 

type CopyFileMapInput interface {
	pulumi.Input

	ToCopyFileMapOutput() CopyFileMapOutput
	ToCopyFileMapOutputWithContext(context.Context) CopyFileMapOutput
}

CopyFileMapInput is an input type that accepts CopyFileMap and CopyFileMapOutput values. You can construct a concrete instance of `CopyFileMapInput` via: 

CopyFileMap{ "key": CopyFileArgs{...} }

type CopyFileMapOutput 

type CopyFileMapOutput struct{ *pulumi.OutputState }

func (CopyFileMapOutput) ElementType 

func (CopyFileMapOutput) ElementType() reflect.Type

func (CopyFileMapOutput) MapIndex 

func (o CopyFileMapOutput) MapIndex(k pulumi.StringInput) CopyFileOutput

func (CopyFileMapOutput) ToCopyFileMapOutput 

func (o CopyFileMapOutput) ToCopyFileMapOutput() CopyFileMapOutput

func (CopyFileMapOutput) ToCopyFileMapOutputWithContext 

func (o CopyFileMapOutput) ToCopyFileMapOutputWithContext(ctx context.Context) CopyFileMapOutput

type CopyFileOutput 

type CopyFileOutput struct{ *pulumi.OutputState }

func (CopyFileOutput) Connection added in v0.2.0 

func (o CopyFileOutput) Connection() ConnectionOutput

The parameters with which to connect to the remote host.

func (CopyFileOutput) ElementType 

func (CopyFileOutput) ElementType() reflect.Type

func (CopyFileOutput) LocalPath added in v0.2.0 

func (o CopyFileOutput) LocalPath() pulumi.StringOutput

The path of the file to be copied.

func (CopyFileOutput) RemotePath added in v0.2.0 

func (o CopyFileOutput) RemotePath() pulumi.StringOutput

The destination path in the remote host.

func (CopyFileOutput) ToCopyFileOutput 

func (o CopyFileOutput) ToCopyFileOutput() CopyFileOutput

func (CopyFileOutput) ToCopyFileOutputWithContext 

func (o CopyFileOutput) ToCopyFileOutputWithContext(ctx context.Context) CopyFileOutput

func (CopyFileOutput) Triggers added in v0.2.0 

func (o CopyFileOutput) Triggers() pulumi.ArrayOutput

Trigger replacements on changes to this input.

type CopyFileState 

type CopyFileState struct {
}

func (CopyFileState) ElementType 

func (CopyFileState) ElementType() reflect.Type

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.