CommandArgs class
The set of arguments for Command. The set of arguments for Command.
Constructors
-
CommandArgs({Input<
bool> ? addPreviousOutputInEnv, required Input<Connection> connection, Input<String> ? create, Input<String> ? delete, Input<Map< ? environment, Input<String, String> >Logging> ? logging, Input<String> ? stdin, Input<List> ? triggers, Input<String> ? update}) -
Creates a new CommandArgs.
addPreviousOutputInEnvIf the previous command's stdout and stderr (as generated by the prior create/update) isconnectionThe parameters with which to connect to the remote host.createThe command to run once on resource creation.deleteThe command to run on resource delettion.environmentAdditional environment variables available to the command's process.loggingIf the command's stdout and stderr should be logged. This doesn't affect the capturing ofstdinPass a string to the command's process as standard intriggersThe resource will be updated (or replaced) if any of these values change.updateThe command to run when the resource is updated.const -
CommandArgs.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
addPreviousOutputInEnv
→ Input<
bool> ? -
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.
final
-
connection
→ Input<
Connection> -
The parameters with which to connect to the remote host.
final
-
create
→ Input<
String> ? -
The command to run once on resource creation.
final
-
delete
→ Input<
String> ? -
The command to run on resource delettion.
final
-
environment
→ Input<
Map< ?String, String> > -
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'.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
logging
→ Input<
Logging> ? -
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.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
stdin
→ Input<
String> ? -
Pass a string to the command's process as standard in
final
-
triggers
→ Input<
List> ? -
The resource will be updated (or replaced) if any of these values change.
final
-
update
→ Input<
String> ? -
The command to run when the resource is updated.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited