Command v0.7.0, Nov 22 22

command.remote.Command

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

Create Command Resource

new Command(name: string, args: CommandArgs, opts?: CustomResourceOptions);

@overload
def Command(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            connection: Optional[ConnectionArgs] = None,
            create: Optional[str] = None,
            delete: Optional[str] = None,
            environment: Optional[Mapping[str, str]] = None,
            stdin: Optional[str] = None,
            triggers: Optional[Sequence[Any]] = None,
            update: Optional[str] = None)
@overload
def Command(resource_name: str,
            args: CommandArgs,
            opts: Optional[ResourceOptions] = None)

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

public Command(string name, CommandArgs args, CustomResourceOptions? opts = null)

public Command(String name, CommandArgs args)
public Command(String name, CommandArgs args, CustomResourceOptions options)

type: command:remote:Command
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CommandArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args CommandArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args CommandArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args CommandArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args CommandArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Command Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Command resource accepts the following input properties:

Connection ConnectionArgs: The parameters with which to connect to the remote host.
Create string: The command to run on create.
Delete string: The command to run on delete.
Environment Dictionary<string, string>: Additional environment variables available to the command's process.
Stdin string: Pass a string to the command's process as standard in
Triggers List<object>: Trigger replacements on changes to this input.
Update string: The command to run on update, if empty, create will run again.

Connection ConnectionArgs: The parameters with which to connect to the remote host.
Create string: The command to run on create.
Delete string: The command to run on delete.
Environment map[string]string: Additional environment variables available to the command's process.
Stdin string: Pass a string to the command's process as standard in
Triggers []interface{}: Trigger replacements on changes to this input.
Update string: The command to run on update, if empty, create will run again.

connection ConnectionArgs: The parameters with which to connect to the remote host.
create String: The command to run on create.
delete String: The command to run on delete.
environment Map<String,String>: Additional environment variables available to the command's process.
stdin String: Pass a string to the command's process as standard in
triggers List<Object>: Trigger replacements on changes to this input.
update String: The command to run on update, if empty, create will run again.

connection ConnectionArgs: The parameters with which to connect to the remote host.
create string: The command to run on create.
delete string: The command to run on delete.
environment {[key: string]: string}: Additional environment variables available to the command's process.
stdin string: Pass a string to the command's process as standard in
triggers any[]: Trigger replacements on changes to this input.
update string: The command to run on update, if empty, create will run again.

connection ConnectionArgs: The parameters with which to connect to the remote host.
create str: The command to run on create.
delete str: The command to run on delete.
environment Mapping[str, str]: Additional environment variables available to the command's process.
stdin str: Pass a string to the command's process as standard in
triggers Sequence[Any]: Trigger replacements on changes to this input.
update str: The command to run on update, if empty, create will run again.

connection Property Map: The parameters with which to connect to the remote host.
create String: The command to run on create.
delete String: The command to run on delete.
environment Map<String>: Additional environment variables available to the command's process.
stdin String: Pass a string to the command's process as standard in
triggers List<Any>: Trigger replacements on changes to this input.
update String: The command to run on update, if empty, create will run again.

Outputs

All input properties are implicitly available as output properties. Additionally, the Command resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.
Stderr string: The standard error of the command's process
Stdout string: The standard output of the command's process

Id string: The provider-assigned unique ID for this managed resource.
Stderr string: The standard error of the command's process
Stdout string: The standard output of the command's process

id String: The provider-assigned unique ID for this managed resource.
stderr String: The standard error of the command's process
stdout String: The standard output of the command's process

id string: The provider-assigned unique ID for this managed resource.
stderr string: The standard error of the command's process
stdout string: The standard output of the command's process

id str: The provider-assigned unique ID for this managed resource.
stderr str: The standard error of the command's process
stdout str: The standard output of the command's process

id String: The provider-assigned unique ID for this managed resource.
stderr String: The standard error of the command's process
stdout String: The standard output of the command's process

Supporting Types

Connection

Host string: The address of the resource to connect to.
AgentSocketPath string: SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
Password string: The password we should use for the connection.
Port double: The port to connect to.
PrivateKey string: The contents of an SSH key to use for the connection. This takes preference over the password if provided.
PrivateKeyPassword string: The password to use in case the private key is encrypted.
User string: The user that we should use for the connection.

Host string: The address of the resource to connect to.
AgentSocketPath string: SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
Password string: The password we should use for the connection.
Port float64: The port to connect to.
PrivateKey string: The contents of an SSH key to use for the connection. This takes preference over the password if provided.
PrivateKeyPassword string: The password to use in case the private key is encrypted.
User string: The user that we should use for the connection.

host String: The address of the resource to connect to.
agentSocketPath String: SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
password String: The password we should use for the connection.
port Double: The port to connect to.
privateKey String: The contents of an SSH key to use for the connection. This takes preference over the password if provided.
privateKeyPassword String: The password to use in case the private key is encrypted.
user String: The user that we should use for the connection.

host string: The address of the resource to connect to.
agentSocketPath string: SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
password string: The password we should use for the connection.
port number: The port to connect to.
privateKey string: The contents of an SSH key to use for the connection. This takes preference over the password if provided.
privateKeyPassword string: The password to use in case the private key is encrypted.
user string: The user that we should use for the connection.

host str: The address of the resource to connect to.
agent_socket_path str: SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
password str: The password we should use for the connection.
port float: The port to connect to.
private_key str: The contents of an SSH key to use for the connection. This takes preference over the password if provided.
private_key_password str: The password to use in case the private key is encrypted.
user str: The user that we should use for the connection.

host String: The address of the resource to connect to.
agentSocketPath String: SSH Agent socket path. Default to environment variable SSH_AUTH_SOCK if present.
password String: The password we should use for the connection.
port Number: The port to connect to.
privateKey String: The contents of an SSH key to use for the connection. This takes preference over the password if provided.
privateKeyPassword String: The password to use in case the private key is encrypted.
user String: The user that we should use for the connection.

Package Details

Repository: command pulumi/pulumi-command
License: Apache-2.0