Sha256: 9517ec2666df45976504ad89fe10aa7538e52a9d89742e66106360605731ef99
Contents?: true
Size: 1.42 KB
Versions: 39
Compression:
Stored size: 1.42 KB
Contents
# frozen_string_literal: true
require_relative 'base'
require_relative '../options/global'
module RubyTerraform
module Commands
# Wraps the +terraform state pull+ command which pulls the state from its
# location, upgrades the local copy, and outputs it to stdout.
#
# This command "pulls" the current state and outputs it to stdout. As part
# of this process, Terraform will upgrade the state format of the local copy
# to the current version.
#
# The primary use of this is for state stored remotely. This command will
# still work with local state but is less useful for this.
#
# For options accepted on construction, see {#initialize}.
#
# When executing an instance of {StatePull} via {#execute}, the following
# options are supported:
#
# * +:chdir+: the path of a working directory to switch to before executing
# the given subcommand.
#
# The {#execute} method accepts an optional second parameter which is a map
# of invocation options. Currently, the only supported option is
# +:environment+ which is a map of environment variables to expose during
# invocation of the command.
#
# @example Basic Invocation
# RubyTerraform::Commands::StatePull.new.execute
#
class StatePull < Base
include RubyTerraform::Options::Global
# @!visibility private
def subcommands
%w[state pull]
end
end
end
end
Version data entries
39 entries across 39 versions & 1 rubygems