Documentation ¶
Index ¶
- Constants
- type Command
- type CommandArgs
- type CommandArray
- type CommandArrayInput
- type CommandArrayOutput
- type CommandInput
- type CommandMap
- type CommandMapInput
- type CommandMapOutput
- type CommandOutput
- func (o CommandOutput) Connection() ConnectionOutput
- func (o CommandOutput) Create() pulumi.StringPtrOutput
- func (o CommandOutput) Delete() pulumi.StringPtrOutput
- func (CommandOutput) ElementType() reflect.Type
- func (o CommandOutput) Environment() pulumi.StringMapOutput
- func (o CommandOutput) Logging() LoggingPtrOutput
- func (o CommandOutput) Stderr() pulumi.StringOutput
- func (o CommandOutput) Stdin() pulumi.StringPtrOutput
- func (o CommandOutput) Stdout() pulumi.StringOutput
- func (o CommandOutput) ToCommandOutput() CommandOutput
- func (o CommandOutput) ToCommandOutputWithContext(ctx context.Context) CommandOutput
- func (o CommandOutput) Triggers() pulumi.ArrayOutput
- func (o CommandOutput) Update() pulumi.StringPtrOutput
- type CommandState
- type Connection
- type ConnectionArgs
- type ConnectionInput
- type ConnectionOutput
- func (o ConnectionOutput) AgentSocketPath() pulumi.StringPtrOutput
- func (o ConnectionOutput) DialErrorLimit() pulumi.IntPtrOutput
- func (ConnectionOutput) ElementType() reflect.Type
- func (o ConnectionOutput) Host() pulumi.StringOutput
- func (o ConnectionOutput) Password() pulumi.StringPtrOutput
- func (o ConnectionOutput) PerDialTimeout() pulumi.IntPtrOutput
- func (o ConnectionOutput) Port() pulumi.Float64PtrOutput
- func (o ConnectionOutput) PrivateKey() pulumi.StringPtrOutput
- func (o ConnectionOutput) PrivateKeyPassword() pulumi.StringPtrOutput
- func (o ConnectionOutput) Proxy() ProxyConnectionPtrOutput
- func (o ConnectionOutput) ToConnectionOutput() ConnectionOutput
- func (o ConnectionOutput) ToConnectionOutputWithContext(ctx context.Context) ConnectionOutput
- func (o ConnectionOutput) User() pulumi.StringPtrOutput
- type CopyFile
- type CopyFileArgs
- type CopyFileArray
- type CopyFileArrayInput
- type CopyFileArrayOutput
- type CopyFileInput
- type CopyFileMap
- type CopyFileMapInput
- type CopyFileMapOutput
- type CopyFileOutput
- func (o CopyFileOutput) Connection() ConnectionOutput
- func (CopyFileOutput) ElementType() reflect.Type
- func (o CopyFileOutput) LocalPath() pulumi.StringOutput
- func (o CopyFileOutput) RemotePath() pulumi.StringOutput
- func (o CopyFileOutput) ToCopyFileOutput() CopyFileOutput
- func (o CopyFileOutput) ToCopyFileOutputWithContext(ctx context.Context) CopyFileOutput
- func (o CopyFileOutput) Triggers() pulumi.ArrayOutput
- type CopyFileState
- type Logging
- func (Logging) ElementType() reflect.Type
- func (e Logging) ToLoggingOutput() LoggingOutput
- func (e Logging) ToLoggingOutputWithContext(ctx context.Context) LoggingOutput
- func (e Logging) ToLoggingPtrOutput() LoggingPtrOutput
- func (e Logging) ToLoggingPtrOutputWithContext(ctx context.Context) LoggingPtrOutput
- func (e Logging) ToStringOutput() pulumi.StringOutput
- func (e Logging) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput
- func (e Logging) ToStringPtrOutput() pulumi.StringPtrOutput
- func (e Logging) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput
- type LoggingInput
- type LoggingOutput
- func (LoggingOutput) ElementType() reflect.Type
- func (o LoggingOutput) ToLoggingOutput() LoggingOutput
- func (o LoggingOutput) ToLoggingOutputWithContext(ctx context.Context) LoggingOutput
- func (o LoggingOutput) ToLoggingPtrOutput() LoggingPtrOutput
- func (o LoggingOutput) ToLoggingPtrOutputWithContext(ctx context.Context) LoggingPtrOutput
- func (o LoggingOutput) ToStringOutput() pulumi.StringOutput
- func (o LoggingOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput
- func (o LoggingOutput) ToStringPtrOutput() pulumi.StringPtrOutput
- func (o LoggingOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput
- type LoggingPtrInput
- type LoggingPtrOutput
- func (o LoggingPtrOutput) Elem() LoggingOutput
- func (LoggingPtrOutput) ElementType() reflect.Type
- func (o LoggingPtrOutput) ToLoggingPtrOutput() LoggingPtrOutput
- func (o LoggingPtrOutput) ToLoggingPtrOutputWithContext(ctx context.Context) LoggingPtrOutput
- func (o LoggingPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput
- func (o LoggingPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput
- type ProxyConnection
- type ProxyConnectionArgs
- func (val *ProxyConnectionArgs) Defaults() *ProxyConnectionArgs
- func (ProxyConnectionArgs) ElementType() reflect.Type
- func (i ProxyConnectionArgs) ToProxyConnectionOutput() ProxyConnectionOutput
- func (i ProxyConnectionArgs) ToProxyConnectionOutputWithContext(ctx context.Context) ProxyConnectionOutput
- func (i ProxyConnectionArgs) ToProxyConnectionPtrOutput() ProxyConnectionPtrOutput
- func (i ProxyConnectionArgs) ToProxyConnectionPtrOutputWithContext(ctx context.Context) ProxyConnectionPtrOutput
- type ProxyConnectionInput
- type ProxyConnectionOutput
- func (o ProxyConnectionOutput) AgentSocketPath() pulumi.StringPtrOutput
- func (o ProxyConnectionOutput) DialErrorLimit() pulumi.IntPtrOutput
- func (ProxyConnectionOutput) ElementType() reflect.Type
- func (o ProxyConnectionOutput) Host() pulumi.StringOutput
- func (o ProxyConnectionOutput) Password() pulumi.StringPtrOutput
- func (o ProxyConnectionOutput) PerDialTimeout() pulumi.IntPtrOutput
- func (o ProxyConnectionOutput) Port() pulumi.Float64PtrOutput
- func (o ProxyConnectionOutput) PrivateKey() pulumi.StringPtrOutput
- func (o ProxyConnectionOutput) PrivateKeyPassword() pulumi.StringPtrOutput
- func (o ProxyConnectionOutput) ToProxyConnectionOutput() ProxyConnectionOutput
- func (o ProxyConnectionOutput) ToProxyConnectionOutputWithContext(ctx context.Context) ProxyConnectionOutput
- func (o ProxyConnectionOutput) ToProxyConnectionPtrOutput() ProxyConnectionPtrOutput
- func (o ProxyConnectionOutput) ToProxyConnectionPtrOutputWithContext(ctx context.Context) ProxyConnectionPtrOutput
- func (o ProxyConnectionOutput) User() pulumi.StringPtrOutput
- type ProxyConnectionPtrInput
- type ProxyConnectionPtrOutput
- func (o ProxyConnectionPtrOutput) AgentSocketPath() pulumi.StringPtrOutput
- func (o ProxyConnectionPtrOutput) DialErrorLimit() pulumi.IntPtrOutput
- func (o ProxyConnectionPtrOutput) Elem() ProxyConnectionOutput
- func (ProxyConnectionPtrOutput) ElementType() reflect.Type
- func (o ProxyConnectionPtrOutput) Host() pulumi.StringPtrOutput
- func (o ProxyConnectionPtrOutput) Password() pulumi.StringPtrOutput
- func (o ProxyConnectionPtrOutput) PerDialTimeout() pulumi.IntPtrOutput
- func (o ProxyConnectionPtrOutput) Port() pulumi.Float64PtrOutput
- func (o ProxyConnectionPtrOutput) PrivateKey() pulumi.StringPtrOutput
- func (o ProxyConnectionPtrOutput) PrivateKeyPassword() pulumi.StringPtrOutput
- func (o ProxyConnectionPtrOutput) ToProxyConnectionPtrOutput() ProxyConnectionPtrOutput
- func (o ProxyConnectionPtrOutput) ToProxyConnectionPtrOutputWithContext(ctx context.Context) ProxyConnectionPtrOutput
- func (o ProxyConnectionPtrOutput) User() pulumi.StringPtrOutput
Constants ¶
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 // 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. // 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"` // 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) 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. // 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 // 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. 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
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"` // 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. 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 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. 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) 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.
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 ¶
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) 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 Logging ¶ added in v0.11.1
type Logging string
func (Logging) ElementType ¶ added in v0.11.1
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 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 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) 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) 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.