← All packages

Command (preview)

Pulumi Official

Package maintained by Pulumi

v0.1.0 published on Tuesday, Mar 8, 2022 by Pulumi

Source code

Command

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

Create a 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)
@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.

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.

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: Additional environment variables available to the command's process.
stdin String: Pass a string to the command's process as standard in
triggers List: Trigger replacements on changes to this input.

Command (preview)

Command

Create a Command Resource

Command Resource Properties

Inputs

Outputs

Supporting Types

Connection

Package Details

Contents