class RubyTerraform::Commands::WorkspaceDelete
Wraps the +terraform workspace delete+ command which deletes a workspace.
For options accepted on construction, see {#initialize}.
When executing an instance of {WorkspaceDelete} via {#execute}, the following options are supported:
-
:name
: the name of the workspace to delete; required. -
:directory
: the path to a directory containing terraform configuration (deprecated in terraform 0.14, removed in terraform 0.15, use:chdir
instead). -
:chdir
: the path of a working directory to switch to before executing the given subcommand. -
:force
: whether or not to remove a non-empty workspace; defaults tofalse
. -
:lock
: whentrue
, locks the state file when locking is supported; whenfalse
, does not lock the state file; defaults totrue
. -
:lock_timeout
: the duration to retry a state lock; defaults to +ā0sā+.
@example Basic Invocation
RubyTerraform::Commands::WorkspaceDelete.new.execute( name: 'example')
Public Instance Methods
@!visibility private
# File lib/ruby_terraform/commands/workspace_delete.rb, line 49 def arguments(parameters) [parameters[:name], parameters[:directory]] end
@!visibility private
RubyTerraform::Options::Global#options
# File lib/ruby_terraform/commands/workspace_delete.rb, line 40 def options %w[ -force -lock -lock-timeout ] + super end
@!visibility private
# File lib/ruby_terraform/commands/workspace_delete.rb, line 35 def subcommands %w[workspace delete] end