remote

package
v1.1.0 Latest Latest
Warning

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

 Go to latest Published: May 27, 2025 License: Apache-2.0 Imports: 7 Imported by: 24

Documentation

Index

Constants

View Source 
const (
	// Capture stdout in logs but not stderr
	LoggingStdout = Logging("stdout")
	// Capture stderr in logs but not stdout
	LoggingStderr = Logging("stderr")
	// Capture stdout and stderr in logs
	LoggingStdoutAndStderr = Logging("stdoutAndStderr")
	// Capture no logs
	LoggingNone = Logging("none")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Command 

type Command struct {
	pulumi.CustomResourceState

	// If the previous command's stdout and stderr (as generated by the prior create/update) is
	// injected into the environment of the next run as PULUMI_COMMAND_STDOUT and PULUMI_COMMAND_STDERR.
	// Defaults to true.
	AddPreviousOutputInEnv pulumi.BoolPtrOutput `pulumi:"addPreviousOutputInEnv"`
	// The parameters with which to connect to the remote host.
	Connection ConnectionOutput `pulumi:"connection"`
	// The command to run once on resource creation.
	//
	// If an `update` command isn't provided, then `create` will also be run when the resource's inputs are modified.
	//
	// Note that this command will not be executed if the resource has already been created and its inputs are unchanged.
	//
	// Use `local.runOutput` if you need to run a command on every execution of your program.
	Create pulumi.StringPtrOutput `pulumi:"create"`
	// The command to run on resource delettion.
	//
	// 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.
	// Note that this only works if the SSH server is configured to accept these variables via AcceptEnv.
	// Alternatively, if a Bash-like shell runs the command on the remote host, you could prefix the command itself
	// with the variables in the form 'VAR=value command'.
	Environment pulumi.StringMapOutput `pulumi:"environment"`
	// If the command's stdout and stderr should be logged. This doesn't affect the capturing of
	// stdout and stderr as outputs. If there might be secrets in the output, you can disable logging here and mark the
	// outputs as secret via 'additionalSecretOutputs'. Defaults to logging both stdout and stderr.
	Logging LoggingPtrOutput `pulumi:"logging"`
	// 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"`
	// The resource will be updated (or replaced) if any of these values change.
	//
	// The trigger values can be of any type.
	//
	// If the `update` command was provided the resource will be updated, otherwise it will be replaced using the `create` command.
	//
	// Please see the resource documentation for examples.
	Triggers pulumi.ArrayOutput `pulumi:"triggers"`
	// The command to run when the resource is updated.
	//
	// If empty, the create command will be executed instead.
	//
	// Note that this command will not run if the resource's inputs are unchanged.
	//
	// Use `local.runOutput` if you need to run a command on every execution of your program.
	//
	// 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.

## Example Usage

### A Basic Example This program connects to a server and runs the `hostname` command. The output is then available via the `stdout` property.

```go package main

import ( 

"github.com/pulumi/pulumi-command/sdk/go/command/remote"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		server := cfg.Require("server")
		userName := cfg.Require("userName")
		privateKey := cfg.Require("privateKey")
		hostnameCmd, err := remote.NewCommand(ctx, "hostnameCmd", &remote.CommandArgs{
			Create: pulumi.String("hostname"),
			Connection: &remote.ConnectionArgs{
				Host:       pulumi.String(server),
				User:       pulumi.String(userName),
				PrivateKey: pulumi.String(privateKey),
			},
		})
		if err != nil {
			return err
		}
		ctx.Export("hostname", hostnameCmd.Stdout)
		return nil
	})
}

```

### Triggers This example defines several trigger values of various kinds. Changes to any of them will cause `cmd` to be re-run.

```go package main

import ( 

"github.com/pulumi/pulumi-command/sdk/go/command/local"
"github.com/pulumi/pulumi-command/sdk/go/command/remote"
"github.com/pulumi/pulumi-random/sdk/v4/go/random"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		str := pulumi.String("foo")

		fileAsset := pulumi.NewFileAsset("Pulumi.yaml")

		rand, err := random.NewRandomString(ctx, "rand", &random.RandomStringArgs{
			Length: pulumi.Int(5),
		})
		if err != nil {
			return err
		}

		localFile, err := local.NewCommand(ctx, "localFile", &local.CommandArgs{
			Create: pulumi.String("touch foo.txt"),
			ArchivePaths: pulumi.StringArray{
				pulumi.String("*.txt"),
			},
		})
		if err != nil {
			return err
		}

		_, err = remote.NewCommand(ctx, "cmd", &remote.CommandArgs{
			Connection: &remote.ConnectionArgs{
				Host: pulumi.String("insert host here"),
			},
			Create: pulumi.String("echo create > op.txt"),
			Delete: pulumi.String("echo delete >> op.txt"),
			Triggers: pulumi.Array{
				str,
				rand.Result,
				fileAsset,
				localFile.Archive,
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

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 {
	// If the previous command's stdout and stderr (as generated by the prior create/update) is
	// injected into the environment of the next run as PULUMI_COMMAND_STDOUT and PULUMI_COMMAND_STDERR.
	// Defaults to true.
	AddPreviousOutputInEnv pulumi.BoolPtrInput
	// The parameters with which to connect to the remote host.
	Connection ConnectionInput
	// The command to run once on resource creation.
	//
	// If an `update` command isn't provided, then `create` will also be run when the resource's inputs are modified.
	//
	// Note that this command will not be executed if the resource has already been created and its inputs are unchanged.
	//
	// Use `local.runOutput` if you need to run a command on every execution of your program.
	Create pulumi.StringPtrInput
	// The command to run on resource delettion.
	//
	// 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.
	// Note that this only works if the SSH server is configured to accept these variables via AcceptEnv.
	// Alternatively, if a Bash-like shell runs the command on the remote host, you could prefix the command itself
	// with the variables in the form 'VAR=value command'.
	Environment pulumi.StringMapInput
	// If the command's stdout and stderr should be logged. This doesn't affect the capturing of
	// stdout and stderr as outputs. If there might be secrets in the output, you can disable logging here and mark the
	// outputs as secret via 'additionalSecretOutputs'. Defaults to logging both stdout and stderr.
	Logging LoggingPtrInput
	// Pass a string to the command's process as standard in
	Stdin pulumi.StringPtrInput
	// The resource will be updated (or replaced) if any of these values change.
	//
	// The trigger values can be of any type.
	//
	// If the `update` command was provided the resource will be updated, otherwise it will be replaced using the `create` command.
	//
	// Please see the resource documentation for examples.
	Triggers pulumi.ArrayInput
	// The command to run when the resource is updated.
	//
	// If empty, the create command will be executed instead.
	//
	// Note that this command will not run if the resource's inputs are unchanged.
	//
	// Use `local.runOutput` if you need to run a command on every execution of your program.
	//
	// 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) AddPreviousOutputInEnv added in v1.0.0 

func (o CommandOutput) AddPreviousOutputInEnv() pulumi.BoolPtrOutput

If the previous command's stdout and stderr (as generated by the prior create/update) is injected into the environment of the next run as PULUMI_COMMAND_STDOUT and PULUMI_COMMAND_STDERR. Defaults to true.

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 once on resource creation.

If an `update` command isn't provided, then `create` will also be run when the resource's inputs are modified.

Note that this command will not be executed if the resource has already been created and its inputs are unchanged.

Use `local.runOutput` if you need to run a command on every execution of your program.

func (CommandOutput) Delete added in v0.2.0 

func (o CommandOutput) Delete() pulumi.StringPtrOutput

The command to run on resource delettion.

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. Note that this only works if the SSH server is configured to accept these variables via AcceptEnv. Alternatively, if a Bash-like shell runs the command on the remote host, you could prefix the command itself with the variables in the form 'VAR=value command'.

func (CommandOutput) Logging added in v0.11.0 

func (o CommandOutput) Logging() LoggingPtrOutput

If the command's stdout and stderr should be logged. This doesn't affect the capturing of stdout and stderr as outputs. If there might be secrets in the output, you can disable logging here and mark the outputs as secret via 'additionalSecretOutputs'. Defaults to logging both stdout and stderr.

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

The resource will be updated (or replaced) if any of these values change.

The trigger values can be of any type.

If the `update` command was provided the resource will be updated, otherwise it will be replaced using the `create` command.

Please see the resource documentation for examples.

func (CommandOutput) Update added in v0.2.0 

func (o CommandOutput) Update() pulumi.StringPtrOutput

The command to run when the resource is updated.

If empty, the create command will be executed instead.

Note that this command will not run if the resource's inputs are unchanged.

Use `local.runOutput` if you need to run a command on every execution of your program.

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 expected host key to verify the server's identity. If not provided, the host key will be ignored.
	HostKey *string `pulumi:"hostKey"`
	// 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. Defaults to 22.
	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 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 expected host key to verify the server's identity. If not provided, the host key will be ignored.
	HostKey pulumi.StringPtrInput `pulumi:"hostKey"`
	// 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. Defaults to 22.
	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 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 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) HostKey added in v1.1.0 

func (o ConnectionOutput) HostKey() pulumi.StringPtrOutput

The expected host key to verify the server's identity. If not provided, the host key will be ignored.

func (ConnectionOutput) Password 

func (o ConnectionOutput) Password() pulumi.StringPtrOutput

The password we should use for the connection.

func (ConnectionOutput) PerDialTimeout added in v0.9.0 

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 

func (o ConnectionOutput) Port() pulumi.Float64PtrOutput

The port to connect to. Defaults to 22.

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) Proxy added in v0.9.0 

func (o ConnectionOutput) Proxy() ProxyConnectionPtrOutput

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

func (o ConnectionOutput) User() pulumi.StringPtrOutput

The user that we should use for the connection.

type CopyFile deprecated 

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.

Deprecated: This resource is deprecated and will be removed in a future release. Please use the `CopyToRemote` resource instead.

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

type CopyToRemote added in v1.0.0 

type CopyToRemote struct {
	pulumi.CustomResourceState

	// The parameters with which to connect to the remote host.
	Connection ConnectionOutput `pulumi:"connection"`
	// The destination path on the remote host. The last element of the path will be created if it doesn't exist but it's an error when additional elements don't exist. When the remote path is an existing directory, the source file or directory will be copied into that directory. When the source is a file and the remote path is an existing file, that file will be overwritten. When the source is a directory and the remote path an existing file, the copy will fail.
	RemotePath pulumi.StringOutput `pulumi:"remotePath"`
	// An [asset or an archive](https://www.pulumi.com/docs/concepts/assets-archives/) to upload as the source of the copy. It must be path-based, i.e., be a `FileAsset` or a `FileArchive`. The item will be copied as-is; archives like .tgz will not be unpacked. Directories are copied recursively, overwriting existing files.
	Source pulumi.AssetOrArchiveOutput `pulumi:"source"`
	// Trigger replacements on changes to this input.
	Triggers pulumi.ArrayOutput `pulumi:"triggers"`
}

Copy an Asset or Archive to a remote host.

## Example usage

This example copies a local directory to a remote host via SSH. For brevity, the remote server is assumed to exist, but it could also be provisioned in the same Pulumi program.

```go package main

import ( 

"fmt"

"github.com/pulumi/pulumi-command/sdk/go/command/remote"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		serverPublicIp := cfg.Require("serverPublicIp")
		userName := cfg.Require("userName")
		privateKey := cfg.Require("privateKey")
		payload := cfg.Require("payload")
		destDir := cfg.Require("destDir")

		archive := pulumi.NewFileArchive(payload)

		conn := remote.ConnectionArgs{
			Host:       pulumi.String(serverPublicIp),
			User:       pulumi.String(userName),
			PrivateKey: pulumi.String(privateKey),
		}

		copy, err := remote.NewCopyToRemote(ctx, "copy", &remote.CopyToRemoteArgs{
			Connection: conn,
			Source:     archive,
		})
		if err != nil {
			return err
		}

		find, err := remote.NewCommand(ctx, "find", &remote.CommandArgs{
			Connection: conn,
			Create:     pulumi.String(fmt.Sprintf("find %v/%v | sort", destDir, payload)),
			Triggers: pulumi.Array{
				archive,
			},
		}, pulumi.DependsOn([]pulumi.Resource{
			copy,
		}))
		if err != nil {
			return err
		}

		ctx.Export("remoteContents", find.Stdout)
		return nil
	})
}

```

func GetCopyToRemote added in v1.0.0 

func GetCopyToRemote(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *CopyToRemoteState, opts ...pulumi.ResourceOption) (*CopyToRemote, error)

GetCopyToRemote gets an existing CopyToRemote 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 NewCopyToRemote added in v1.0.0 

func NewCopyToRemote(ctx *pulumi.Context,
	name string, args *CopyToRemoteArgs, opts ...pulumi.ResourceOption) (*CopyToRemote, error)

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

func (*CopyToRemote) ElementType added in v1.0.0 

func (*CopyToRemote) ElementType() reflect.Type

func (*CopyToRemote) ToCopyToRemoteOutput added in v1.0.0 

func (i *CopyToRemote) ToCopyToRemoteOutput() CopyToRemoteOutput

func (*CopyToRemote) ToCopyToRemoteOutputWithContext added in v1.0.0 

func (i *CopyToRemote) ToCopyToRemoteOutputWithContext(ctx context.Context) CopyToRemoteOutput

type CopyToRemoteArgs added in v1.0.0 

type CopyToRemoteArgs struct {
	// The parameters with which to connect to the remote host.
	Connection ConnectionInput
	// The destination path on the remote host. The last element of the path will be created if it doesn't exist but it's an error when additional elements don't exist. When the remote path is an existing directory, the source file or directory will be copied into that directory. When the source is a file and the remote path is an existing file, that file will be overwritten. When the source is a directory and the remote path an existing file, the copy will fail.
	RemotePath pulumi.StringInput
	// An [asset or an archive](https://www.pulumi.com/docs/concepts/assets-archives/) to upload as the source of the copy. It must be path-based, i.e., be a `FileAsset` or a `FileArchive`. The item will be copied as-is; archives like .tgz will not be unpacked. Directories are copied recursively, overwriting existing files.
	Source pulumi.AssetOrArchiveInput
	// Trigger replacements on changes to this input.
	Triggers pulumi.ArrayInput
}

The set of arguments for constructing a CopyToRemote resource.

func (CopyToRemoteArgs) ElementType added in v1.0.0 

func (CopyToRemoteArgs) ElementType() reflect.Type

type CopyToRemoteArray added in v1.0.0 

type CopyToRemoteArray []CopyToRemoteInput

func (CopyToRemoteArray) ElementType added in v1.0.0 

func (CopyToRemoteArray) ElementType() reflect.Type

func (CopyToRemoteArray) ToCopyToRemoteArrayOutput added in v1.0.0 

func (i CopyToRemoteArray) ToCopyToRemoteArrayOutput() CopyToRemoteArrayOutput

func (CopyToRemoteArray) ToCopyToRemoteArrayOutputWithContext added in v1.0.0 

func (i CopyToRemoteArray) ToCopyToRemoteArrayOutputWithContext(ctx context.Context) CopyToRemoteArrayOutput

type CopyToRemoteArrayInput added in v1.0.0 

type CopyToRemoteArrayInput interface {
	pulumi.Input

	ToCopyToRemoteArrayOutput() CopyToRemoteArrayOutput
	ToCopyToRemoteArrayOutputWithContext(context.Context) CopyToRemoteArrayOutput
}

CopyToRemoteArrayInput is an input type that accepts CopyToRemoteArray and CopyToRemoteArrayOutput values. You can construct a concrete instance of `CopyToRemoteArrayInput` via: 

CopyToRemoteArray{ CopyToRemoteArgs{...} }

type CopyToRemoteArrayOutput added in v1.0.0 

type CopyToRemoteArrayOutput struct{ *pulumi.OutputState }

func (CopyToRemoteArrayOutput) ElementType added in v1.0.0 

func (CopyToRemoteArrayOutput) ElementType() reflect.Type

func (CopyToRemoteArrayOutput) Index added in v1.0.0 

func (o CopyToRemoteArrayOutput) Index(i pulumi.IntInput) CopyToRemoteOutput

func (CopyToRemoteArrayOutput) ToCopyToRemoteArrayOutput added in v1.0.0 

func (o CopyToRemoteArrayOutput) ToCopyToRemoteArrayOutput() CopyToRemoteArrayOutput

func (CopyToRemoteArrayOutput) ToCopyToRemoteArrayOutputWithContext added in v1.0.0 

func (o CopyToRemoteArrayOutput) ToCopyToRemoteArrayOutputWithContext(ctx context.Context) CopyToRemoteArrayOutput

type CopyToRemoteInput added in v1.0.0 

type CopyToRemoteInput interface {
	pulumi.Input

	ToCopyToRemoteOutput() CopyToRemoteOutput
	ToCopyToRemoteOutputWithContext(ctx context.Context) CopyToRemoteOutput
}

type CopyToRemoteMap added in v1.0.0 

type CopyToRemoteMap map[string]CopyToRemoteInput

func (CopyToRemoteMap) ElementType added in v1.0.0 

func (CopyToRemoteMap) ElementType() reflect.Type

func (CopyToRemoteMap) ToCopyToRemoteMapOutput added in v1.0.0 

func (i CopyToRemoteMap) ToCopyToRemoteMapOutput() CopyToRemoteMapOutput

func (CopyToRemoteMap) ToCopyToRemoteMapOutputWithContext added in v1.0.0 

func (i CopyToRemoteMap) ToCopyToRemoteMapOutputWithContext(ctx context.Context) CopyToRemoteMapOutput

type CopyToRemoteMapInput added in v1.0.0 

type CopyToRemoteMapInput interface {
	pulumi.Input

	ToCopyToRemoteMapOutput() CopyToRemoteMapOutput
	ToCopyToRemoteMapOutputWithContext(context.Context) CopyToRemoteMapOutput
}

CopyToRemoteMapInput is an input type that accepts CopyToRemoteMap and CopyToRemoteMapOutput values. You can construct a concrete instance of `CopyToRemoteMapInput` via: 

CopyToRemoteMap{ "key": CopyToRemoteArgs{...} }

type CopyToRemoteMapOutput added in v1.0.0 

type CopyToRemoteMapOutput struct{ *pulumi.OutputState }

func (CopyToRemoteMapOutput) ElementType added in v1.0.0 

func (CopyToRemoteMapOutput) ElementType() reflect.Type

func (CopyToRemoteMapOutput) MapIndex added in v1.0.0 

func (o CopyToRemoteMapOutput) MapIndex(k pulumi.StringInput) CopyToRemoteOutput

func (CopyToRemoteMapOutput) ToCopyToRemoteMapOutput added in v1.0.0 

func (o CopyToRemoteMapOutput) ToCopyToRemoteMapOutput() CopyToRemoteMapOutput

func (CopyToRemoteMapOutput) ToCopyToRemoteMapOutputWithContext added in v1.0.0 

func (o CopyToRemoteMapOutput) ToCopyToRemoteMapOutputWithContext(ctx context.Context) CopyToRemoteMapOutput

type CopyToRemoteOutput added in v1.0.0 

type CopyToRemoteOutput struct{ *pulumi.OutputState }

func (CopyToRemoteOutput) Connection added in v1.0.0 

func (o CopyToRemoteOutput) Connection() ConnectionOutput

The parameters with which to connect to the remote host.

func (CopyToRemoteOutput) ElementType added in v1.0.0 

func (CopyToRemoteOutput) ElementType() reflect.Type

func (CopyToRemoteOutput) RemotePath added in v1.0.0 

func (o CopyToRemoteOutput) RemotePath() pulumi.StringOutput

The destination path on the remote host. The last element of the path will be created if it doesn't exist but it's an error when additional elements don't exist. When the remote path is an existing directory, the source file or directory will be copied into that directory. When the source is a file and the remote path is an existing file, that file will be overwritten. When the source is a directory and the remote path an existing file, the copy will fail.

func (CopyToRemoteOutput) Source added in v1.0.0 

func (o CopyToRemoteOutput) Source() pulumi.AssetOrArchiveOutput

An [asset or an archive](https://www.pulumi.com/docs/concepts/assets-archives/) to upload as the source of the copy. It must be path-based, i.e., be a `FileAsset` or a `FileArchive`. The item will be copied as-is; archives like .tgz will not be unpacked. Directories are copied recursively, overwriting existing files.

func (CopyToRemoteOutput) ToCopyToRemoteOutput added in v1.0.0 

func (o CopyToRemoteOutput) ToCopyToRemoteOutput() CopyToRemoteOutput

func (CopyToRemoteOutput) ToCopyToRemoteOutputWithContext added in v1.0.0 

func (o CopyToRemoteOutput) ToCopyToRemoteOutputWithContext(ctx context.Context) CopyToRemoteOutput

func (CopyToRemoteOutput) Triggers added in v1.0.0 

func (o CopyToRemoteOutput) Triggers() pulumi.ArrayOutput

Trigger replacements on changes to this input.

type CopyToRemoteState added in v1.0.0 

type CopyToRemoteState struct {
}

func (CopyToRemoteState) ElementType added in v1.0.0 

func (CopyToRemoteState) ElementType() reflect.Type

type Logging added in v0.11.1 

type Logging string

func (Logging) ElementType added in v0.11.1 

func (Logging) ElementType() reflect.Type

func (Logging) ToLoggingOutput added in v0.11.1 

func (e Logging) ToLoggingOutput() LoggingOutput

func (Logging) ToLoggingOutputWithContext added in v0.11.1 

func (e Logging) ToLoggingOutputWithContext(ctx context.Context) LoggingOutput

func (Logging) ToLoggingPtrOutput added in v0.11.1 

func (e Logging) ToLoggingPtrOutput() LoggingPtrOutput

func (Logging) ToLoggingPtrOutputWithContext added in v0.11.1 

func (e Logging) ToLoggingPtrOutputWithContext(ctx context.Context) LoggingPtrOutput

func (Logging) ToStringOutput added in v0.11.1 

func (e Logging) ToStringOutput() pulumi.StringOutput

func (Logging) ToStringOutputWithContext added in v0.11.1 

func (e Logging) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (Logging) ToStringPtrOutput added in v0.11.1 

func (e Logging) ToStringPtrOutput() pulumi.StringPtrOutput

func (Logging) ToStringPtrOutputWithContext added in v0.11.1 

func (e Logging) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type LoggingInput added in v0.11.1 

type LoggingInput interface {
	pulumi.Input

	ToLoggingOutput() LoggingOutput
	ToLoggingOutputWithContext(context.Context) LoggingOutput
}

LoggingInput is an input type that accepts values of the Logging enum A concrete instance of `LoggingInput` can be one of the following: 

LoggingStdout
LoggingStderr
LoggingStdoutAndStderr
LoggingNone

type LoggingOutput added in v0.11.1 

type LoggingOutput struct{ *pulumi.OutputState }

func (LoggingOutput) ElementType added in v0.11.1 

func (LoggingOutput) ElementType() reflect.Type

func (LoggingOutput) ToLoggingOutput added in v0.11.1 

func (o LoggingOutput) ToLoggingOutput() LoggingOutput

func (LoggingOutput) ToLoggingOutputWithContext added in v0.11.1 

func (o LoggingOutput) ToLoggingOutputWithContext(ctx context.Context) LoggingOutput

func (LoggingOutput) ToLoggingPtrOutput added in v0.11.1 

func (o LoggingOutput) ToLoggingPtrOutput() LoggingPtrOutput

func (LoggingOutput) ToLoggingPtrOutputWithContext added in v0.11.1 

func (o LoggingOutput) ToLoggingPtrOutputWithContext(ctx context.Context) LoggingPtrOutput

func (LoggingOutput) ToStringOutput added in v0.11.1 

func (o LoggingOutput) ToStringOutput() pulumi.StringOutput

func (LoggingOutput) ToStringOutputWithContext added in v0.11.1 

func (o LoggingOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (LoggingOutput) ToStringPtrOutput added in v0.11.1 

func (o LoggingOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (LoggingOutput) ToStringPtrOutputWithContext added in v0.11.1 

func (o LoggingOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type LoggingPtrInput added in v0.11.1 

type LoggingPtrInput interface {
	pulumi.Input

	ToLoggingPtrOutput() LoggingPtrOutput
	ToLoggingPtrOutputWithContext(context.Context) LoggingPtrOutput
}

func LoggingPtr added in v0.11.1 

func LoggingPtr(v string) LoggingPtrInput

type LoggingPtrOutput added in v0.11.1 

type LoggingPtrOutput struct{ *pulumi.OutputState }

func (LoggingPtrOutput) Elem added in v0.11.1 

func (o LoggingPtrOutput) Elem() LoggingOutput

func (LoggingPtrOutput) ElementType added in v0.11.1 

func (LoggingPtrOutput) ElementType() reflect.Type

func (LoggingPtrOutput) ToLoggingPtrOutput added in v0.11.1 

func (o LoggingPtrOutput) ToLoggingPtrOutput() LoggingPtrOutput

func (LoggingPtrOutput) ToLoggingPtrOutputWithContext added in v0.11.1 

func (o LoggingPtrOutput) ToLoggingPtrOutputWithContext(ctx context.Context) LoggingPtrOutput

func (LoggingPtrOutput) ToStringPtrOutput added in v0.11.1 

func (o LoggingPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (LoggingPtrOutput) ToStringPtrOutputWithContext added in v0.11.1 

func (o LoggingPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type ProxyConnection added in v0.9.0 

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 expected host key to verify the server's identity. If not provided, the host key will be ignored.
	HostKey *string `pulumi:"hostKey"`
	// 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 *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 to the bastion host.
	User *string `pulumi:"user"`
}

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

func (*ProxyConnection) Defaults added in v0.9.0 

func (val *ProxyConnection) Defaults() *ProxyConnection

Defaults sets the appropriate defaults for ProxyConnection

type ProxyConnectionArgs added in v0.9.0 

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 expected host key to verify the server's identity. If not provided, the host key will be ignored.
	HostKey pulumi.StringPtrInput `pulumi:"hostKey"`
	// 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.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 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 added in v0.9.0 

func (val *ProxyConnectionArgs) Defaults() *ProxyConnectionArgs

Defaults sets the appropriate defaults for ProxyConnectionArgs

func (ProxyConnectionArgs) ElementType added in v0.9.0 

func (ProxyConnectionArgs) ElementType() reflect.Type

func (ProxyConnectionArgs) ToProxyConnectionOutput added in v0.9.0 

func (i ProxyConnectionArgs) ToProxyConnectionOutput() ProxyConnectionOutput

func (ProxyConnectionArgs) ToProxyConnectionOutputWithContext added in v0.9.0 

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

func (ProxyConnectionArgs) ToProxyConnectionPtrOutput added in v0.9.0 

func (i ProxyConnectionArgs) ToProxyConnectionPtrOutput() ProxyConnectionPtrOutput

func (ProxyConnectionArgs) ToProxyConnectionPtrOutputWithContext added in v0.9.0 

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

type ProxyConnectionInput added in v0.9.0 

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

type ProxyConnectionOutput struct{ *pulumi.OutputState }

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

func (ProxyConnectionOutput) AgentSocketPath added in v0.9.0 

func (o ProxyConnectionOutput) AgentSocketPath() pulumi.StringPtrOutput

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

func (ProxyConnectionOutput) DialErrorLimit added in v0.9.0 

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

func (ProxyConnectionOutput) ElementType() reflect.Type

func (ProxyConnectionOutput) Host added in v0.9.0 

func (o ProxyConnectionOutput) Host() pulumi.StringOutput

The address of the bastion host to connect to.

func (ProxyConnectionOutput) HostKey added in v1.1.0 

func (o ProxyConnectionOutput) HostKey() pulumi.StringPtrOutput

The expected host key to verify the server's identity. If not provided, the host key will be ignored.

func (ProxyConnectionOutput) Password added in v0.9.0 

func (o ProxyConnectionOutput) Password() pulumi.StringPtrOutput

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

func (ProxyConnectionOutput) PerDialTimeout added in v0.9.0 

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

func (o ProxyConnectionOutput) Port() pulumi.Float64PtrOutput

The port of the bastion host to connect to.

func (ProxyConnectionOutput) PrivateKey added in v0.9.0 

func (o ProxyConnectionOutput) PrivateKey() pulumi.StringPtrOutput

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

func (ProxyConnectionOutput) PrivateKeyPassword added in v0.9.0 

func (o ProxyConnectionOutput) PrivateKeyPassword() pulumi.StringPtrOutput

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

func (ProxyConnectionOutput) ToProxyConnectionOutput added in v0.9.0 

func (o ProxyConnectionOutput) ToProxyConnectionOutput() ProxyConnectionOutput

func (ProxyConnectionOutput) ToProxyConnectionOutputWithContext added in v0.9.0 

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

func (ProxyConnectionOutput) ToProxyConnectionPtrOutput added in v0.9.0 

func (o ProxyConnectionOutput) ToProxyConnectionPtrOutput() ProxyConnectionPtrOutput

func (ProxyConnectionOutput) ToProxyConnectionPtrOutputWithContext added in v0.9.0 

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

func (ProxyConnectionOutput) User added in v0.9.0 

func (o ProxyConnectionOutput) User() pulumi.StringPtrOutput

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

type ProxyConnectionPtrInput added in v0.9.0 

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

func ProxyConnectionPtr added in v0.9.0 

func ProxyConnectionPtr(v *ProxyConnectionArgs) ProxyConnectionPtrInput

type ProxyConnectionPtrOutput added in v0.9.0 

type ProxyConnectionPtrOutput struct{ *pulumi.OutputState }

func (ProxyConnectionPtrOutput) AgentSocketPath added in v0.9.0 

func (o ProxyConnectionPtrOutput) AgentSocketPath() pulumi.StringPtrOutput

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

func (ProxyConnectionPtrOutput) DialErrorLimit added in v0.9.0 

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

func (o ProxyConnectionPtrOutput) Elem() ProxyConnectionOutput

func (ProxyConnectionPtrOutput) ElementType added in v0.9.0 

func (ProxyConnectionPtrOutput) ElementType() reflect.Type

func (ProxyConnectionPtrOutput) Host added in v0.9.0 

func (o ProxyConnectionPtrOutput) Host() pulumi.StringPtrOutput

The address of the bastion host to connect to.

func (ProxyConnectionPtrOutput) HostKey added in v1.1.0 

func (o ProxyConnectionPtrOutput) HostKey() pulumi.StringPtrOutput

The expected host key to verify the server's identity. If not provided, the host key will be ignored.

func (ProxyConnectionPtrOutput) Password added in v0.9.0 

func (o ProxyConnectionPtrOutput) Password() pulumi.StringPtrOutput

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

func (ProxyConnectionPtrOutput) PerDialTimeout added in v0.9.0 

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

func (o ProxyConnectionPtrOutput) Port() pulumi.Float64PtrOutput

The port of the bastion host to connect to.

func (ProxyConnectionPtrOutput) PrivateKey added in v0.9.0 

func (o ProxyConnectionPtrOutput) PrivateKey() pulumi.StringPtrOutput

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

func (ProxyConnectionPtrOutput) PrivateKeyPassword added in v0.9.0 

func (o ProxyConnectionPtrOutput) PrivateKeyPassword() pulumi.StringPtrOutput

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

func (ProxyConnectionPtrOutput) ToProxyConnectionPtrOutput added in v0.9.0 

func (o ProxyConnectionPtrOutput) ToProxyConnectionPtrOutput() ProxyConnectionPtrOutput

func (ProxyConnectionPtrOutput) ToProxyConnectionPtrOutputWithContext added in v0.9.0 

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

func (ProxyConnectionPtrOutput) User added in v0.9.0 

func (o ProxyConnectionPtrOutput) User() pulumi.StringPtrOutput

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

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.